edu.internet2.middleware.shibboleth.common.profile.provider

Class BaseSAMLProfileRequestContext<InboundMessage extends org.opensaml.common.SAMLObject,OutboundMessage extends org.opensaml.common.SAMLObject,NameIdentifierType extends org.opensaml.common.SAMLObject,ProfileConfigurationType extends ProfileConfiguration>

java.lang.Object

org.opensaml.ws.message.BaseMessageContext

org.opensaml.common.binding.BasicSAMLMessageContext<InboundMessage,OutboundMessage,NameIdentifierType>

edu.internet2.middleware.shibboleth.common.profile.provider.BaseSAMLProfileRequestContext<InboundMessage,OutboundMessage,NameIdentifierType,ProfileConfigurationType>

Type Parameters:

InboundMessage - type of inbound SAML message

OutboundMessage - type of outbound SAML message

NameIdentifierType - type of name identifier used for subjects

ProfileConfigurationType - profile configuration type for current request

All Implemented Interfaces:

AttributeRequestContext, ProfileRequestContext<ProfileConfigurationType>, SAMLProfileRequestContext<InboundMessage,OutboundMessage,NameIdentifierType,ProfileConfigurationType>, org.opensaml.common.binding.SAMLMessageContext<InboundMessage,OutboundMessage,NameIdentifierType>, org.opensaml.ws.message.MessageContext

public class BaseSAMLProfileRequestContext<InboundMessage extends org.opensaml.common.SAMLObject,OutboundMessage extends org.opensaml.common.SAMLObject,NameIdentifierType extends org.opensaml.common.SAMLObject,ProfileConfigurationType extends ProfileConfiguration>
extends org.opensaml.common.binding.BasicSAMLMessageContext<InboundMessage,OutboundMessage,NameIdentifierType>
implements SAMLProfileRequestContext<InboundMessage,OutboundMessage,NameIdentifierType,ProfileConfigurationType>

Contextual object used to accumlate information as profile requests are being processed.

Constructor Summary

Constructors

Constructor and Description
BaseSAMLProfileRequestContext()

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,BaseAttribute>	getAttributes() Gets the retrieved attributes.
org.opensaml.common.binding.decoding.SAMLMessageDecoder	getMessageDecoder() Gets the message decoder used to decode the message from the inbound transport.
org.opensaml.common.binding.encoding.SAMLMessageEncoder	getMessageEncoder() Gets the message encoder used to encoder the message onto the outbound transport.
BaseAttribute	getNameIdentifierAttribute() Gets the attribute encoded as the SAML name identifier.
String	getPrincipalAuthenticationMethod() Gets the method used to authenticate the principal.
String	getPrincipalName() Gets the principal name of the subject of the request.
ProfileConfigurationType	getProfileConfiguration() Gets the configuration for the profile for the relying party.
Collection<String>	getReleasedAttributes() Gets the attributes, by ID, released to the peer.
RelyingPartyConfiguration	getRelyingPartyConfiguration() Gets the configuration for the relying party for this request.
Collection<String>	getRequestedAttributesIds() Gets the collection of IDs for the attributes being requested by the relying party.
Session	getUserSession() Gets the current user session, if there is one.
void	setAttributes(Map<String,BaseAttribute> attributes) Sets the retrieved attributes.
void	setMessageDecoder(org.opensaml.common.binding.decoding.SAMLMessageDecoder decoder) Sets the message decoder used to decode the message from the inbound transport.
void	setMessageEncoder(org.opensaml.common.binding.encoding.SAMLMessageEncoder encoder) Sets the message encoder used to encoder the message onto the outbound transport.
void	setNameIdentifierAttribute(BaseAttribute attribute) Sets the attribute encoded as the SAML name identifier.
void	setPrincipalAuthenticationMethod(String method) Sets the method used to authenticate the principal.
void	setPrincipalName(String name) Sets the principal name of the subject of the request.
void	setProfileConfiguration(ProfileConfigurationType configuration) Sets the configuration for the profile for the relying party.
void	setReleasedAttributes(Collection<String> attributeIds) Sets the attributes, by ID, released to the peer.
void	setRelyingPartyConfiguration(RelyingPartyConfiguration configuration) Sets the configuration for the relying party for this request.
void	setRequestedAttributes(Collection<String> ids) Sets the collection of IDs for the attributes being requested by the relying party.
void	setUserSession(Session session) Sets the current user session.

Methods inherited from class org.opensaml.common.binding.BasicSAMLMessageContext

getInboundSAMLMessage, getInboundSAMLMessageId, getInboundSAMLMessageIssueInstant, getInboundSAMLProtocol, getLocalEntityId, getLocalEntityMetadata, getLocalEntityRole, getLocalEntityRoleMetadata, getMetadataProvider, getOuboundSAMLMessageSigningCredential, getOutboundMessageArtifactType, getOutboundSAMLMessage, getOutboundSAMLMessageId, getOutboundSAMLMessageIssueInstant, getOutboundSAMLProtocol, getPeerEntityEndpoint, getPeerEntityId, getPeerEntityMetadata, getPeerEntityRole, getPeerEntityRoleMetadata, getRelayState, getSubjectNameIdentifier, isInboundSAMLMessageAuthenticated, isIssuerAuthenticated, setInboundSAMLMessage, setInboundSAMLMessageAuthenticated, setInboundSAMLMessageId, setInboundSAMLMessageIssueInstant, setInboundSAMLProtocol, setLocalEntityId, setLocalEntityMetadata, setLocalEntityRole, setLocalEntityRoleMetadata, setMetadataProvider, setOutboundMessageArtifactType, setOutboundSAMLMessage, setOutboundSAMLMessageId, setOutboundSAMLMessageIssueInstant, setOutboundSAMLMessageSigningCredential, setOutboundSAMLProtocol, setPeerEntityEndpoint, setPeerEntityId, setPeerEntityMetadata, setPeerEntityRole, setPeerEntityRoleMetadata, setRelayState, setSubjectNameIdentifier

Methods inherited from class org.opensaml.ws.message.BaseMessageContext

getCommunicationProfileId, getInboundMessage, getInboundMessageIssuer, getInboundMessageTransport, getOutboundHandlerChainResolver, getOutboundMessage, getOutboundMessageIssuer, getOutboundMessageTransport, getPostSecurityInboundHandlerChainResolver, getPreSecurityInboundHandlerChainResolver, getSecurityPolicyResolver, setCommunicationProfileId, setInboundMessage, setInboundMessageIssuer, setInboundMessageTransport, setOutboundHandlerChainResolver, setOutboundMessage, setOutboundMessageIssuer, setOutboundMessageTransport, setPostSecurityInboundHandlerChainResolver, setPreSecurityInboundHandlerChainResolver, setSecurityPolicyResolver

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensaml.common.binding.SAMLMessageContext

getInboundSAMLMessage, getInboundSAMLMessageId, getInboundSAMLMessageIssueInstant, getInboundSAMLProtocol, getLocalEntityId, getLocalEntityMetadata, getLocalEntityRole, getLocalEntityRoleMetadata, getMetadataProvider, getOuboundSAMLMessageSigningCredential, getOutboundMessageArtifactType, getOutboundSAMLMessage, getOutboundSAMLMessageId, getOutboundSAMLMessageIssueInstant, getOutboundSAMLProtocol, getPeerEntityEndpoint, getPeerEntityId, getPeerEntityMetadata, getPeerEntityRole, getPeerEntityRoleMetadata, getRelayState, getSubjectNameIdentifier, isInboundSAMLMessageAuthenticated, setInboundSAMLMessage, setInboundSAMLMessageAuthenticated, setInboundSAMLMessageId, setInboundSAMLMessageIssueInstant, setInboundSAMLProtocol, setLocalEntityId, setLocalEntityMetadata, setLocalEntityRole, setLocalEntityRoleMetadata, setMetadataProvider, setOutboundMessageArtifactType, setOutboundSAMLMessage, setOutboundSAMLMessageId, setOutboundSAMLMessageIssueInstant, setOutboundSAMLMessageSigningCredential, setOutboundSAMLProtocol, setPeerEntityEndpoint, setPeerEntityId, setPeerEntityMetadata, setPeerEntityRole, setPeerEntityRoleMetadata, setRelayState, setSubjectNameIdentifier

Methods inherited from interface org.opensaml.ws.message.MessageContext

getCommunicationProfileId, getInboundMessage, getInboundMessageIssuer, getInboundMessageTransport, getOutboundHandlerChainResolver, getOutboundMessage, getOutboundMessageIssuer, getOutboundMessageTransport, getPostSecurityInboundHandlerChainResolver, getPreSecurityInboundHandlerChainResolver, getSecurityPolicyResolver, isIssuerAuthenticated, setCommunicationProfileId, setInboundMessage, setInboundMessageIssuer, setInboundMessageTransport, setOutboundHandlerChainResolver, setOutboundMessage, setOutboundMessageIssuer, setOutboundMessageTransport, setPostSecurityInboundHandlerChainResolver, setPreSecurityInboundHandlerChainResolver, setSecurityPolicyResolver

Constructor Detail

BaseSAMLProfileRequestContext

public BaseSAMLProfileRequestContext()

Method Detail

getAttributes

public Map<String,BaseAttribute> getAttributes()

Gets the retrieved attributes.

Specified by:

getAttributes in interface AttributeRequestContext

Returns:

retrieved attributes

getMessageDecoder

public org.opensaml.common.binding.decoding.SAMLMessageDecoder getMessageDecoder()

Gets the message decoder used to decode the message from the inbound transport.

Returns:

message decoder used to decode the message from the inbound transport

getMessageEncoder

public org.opensaml.common.binding.encoding.SAMLMessageEncoder getMessageEncoder()

Gets the message encoder used to encoder the message onto the outbound transport.

Returns:

message encoder used to encoder the message onto the outbound transport

getNameIdentifierAttribute

public BaseAttribute getNameIdentifierAttribute()

Gets the attribute encoded as the SAML name identifier.

Returns:

attribute encoded as the SAML name identifier

getPrincipalAuthenticationMethod

public String getPrincipalAuthenticationMethod()

Gets the method used to authenticate the principal.

Specified by:

getPrincipalAuthenticationMethod in interface AttributeRequestContext

Returns:

method used to authenticate the principal

getPrincipalName

public String getPrincipalName()

Gets the principal name of the subject of the request.

Specified by:

getPrincipalName in interface AttributeRequestContext

Returns:

principal name of the subject of the request

getProfileConfiguration

public ProfileConfigurationType getProfileConfiguration()

Gets the configuration for the profile for the relying party.

Specified by:

getProfileConfiguration in interface ProfileRequestContext<ProfileConfigurationType extends ProfileConfiguration>

Returns:

configuration for the profile for the relying party

getReleasedAttributes

public Collection<String> getReleasedAttributes()

Gets the attributes, by ID, released to the peer.

Specified by:

getReleasedAttributes in interface ProfileRequestContext<ProfileConfigurationType extends ProfileConfiguration>

Returns:

attributes released to the peer

getRelyingPartyConfiguration

public RelyingPartyConfiguration getRelyingPartyConfiguration()

Gets the configuration for the relying party for this request.

Specified by:

getRelyingPartyConfiguration in interface ProfileRequestContext<ProfileConfigurationType extends ProfileConfiguration>

Returns:

configuration for the relying party for this request

getRequestedAttributesIds

public Collection<String> getRequestedAttributesIds()

Gets the collection of IDs for the attributes being requested by the relying party.

Specified by:

getRequestedAttributesIds in interface AttributeRequestContext

Returns:

collection of IDs for the attributes being requested by the relying party

getUserSession

public Session getUserSession()

Gets the current user session, if there is one.

Specified by:

getUserSession in interface ProfileRequestContext<ProfileConfigurationType extends ProfileConfiguration>

Returns:

current user session

setAttributes

public void setAttributes(Map<String,BaseAttribute> attributes)

Sets the retrieved attributes.

Specified by:

setAttributes in interface AttributeRequestContext

Parameters:

attributes - retrieved attributes

setMessageDecoder

public void setMessageDecoder(org.opensaml.common.binding.decoding.SAMLMessageDecoder decoder)

Sets the message decoder used to decode the message from the inbound transport.

Parameters:

decoder - message decoder used to decode the message from the inbound transport

setMessageEncoder

public void setMessageEncoder(org.opensaml.common.binding.encoding.SAMLMessageEncoder encoder)

Sets the message encoder used to encoder the message onto the outbound transport.

Parameters:

encoder - message encoder used to encoder the message onto the outbound transport

setNameIdentifierAttribute

public void setNameIdentifierAttribute(BaseAttribute attribute)

Sets the attribute encoded as the SAML name identifier.

Parameters:

attribute - attribute encoded as the SAML name identifier

setPrincipalAuthenticationMethod

public void setPrincipalAuthenticationMethod(String method)

Sets the method used to authenticate the principal.

Specified by:

setPrincipalAuthenticationMethod in interface AttributeRequestContext

Parameters:

method - method used to authenticate the principal

setPrincipalName

public void setPrincipalName(String name)

Sets the principal name of the subject of the request.

Specified by:

setPrincipalName in interface AttributeRequestContext

Parameters:

name - principal name of the subject of the request

setProfileConfiguration

public void setProfileConfiguration(ProfileConfigurationType configuration)

Sets the configuration for the profile for the relying party.

Specified by:

setProfileConfiguration in interface ProfileRequestContext<ProfileConfigurationType extends ProfileConfiguration>

Parameters:

configuration - configuration for the profile for the relying party

setReleasedAttributes

public void setReleasedAttributes(Collection<String> attributeIds)

Sets the attributes, by ID, released to the peer.

Specified by:

setReleasedAttributes in interface ProfileRequestContext<ProfileConfigurationType extends ProfileConfiguration>

Parameters:

attributeIds - ids of the attributes released to the peer

setRelyingPartyConfiguration

public void setRelyingPartyConfiguration(RelyingPartyConfiguration configuration)

Sets the configuration for the relying party for this request.

Specified by:

setRelyingPartyConfiguration in interface ProfileRequestContext<ProfileConfigurationType extends ProfileConfiguration>

Parameters:

configuration - configuration for the relying party for this request

setRequestedAttributes

public void setRequestedAttributes(Collection<String> ids)

Sets the collection of IDs for the attributes being requested by the relying party.

Specified by:

setRequestedAttributes in interface AttributeRequestContext

Parameters:

ids - collection of IDs for the attributes being requested by the relying party

setUserSession

public void setUserSession(Session session)

Sets the current user session.

Specified by:

setUserSession in interface ProfileRequestContext<ProfileConfigurationType extends ProfileConfiguration>

Parameters:

session - current user session