org.opensaml.common.binding

Class BasicSAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

java.lang.Object

org.opensaml.ws.message.BaseMessageContext

org.opensaml.common.binding.BasicSAMLMessageContext<InboundMessageType,OutboundMessageType,NameIdentifierType>

Type Parameters:

InboundMessageType - type of inbound SAML message

OutboundMessageType - type of outbound SAML message

NameIdentifierType - type of name identifier used for subjects

All Implemented Interfaces:

SAMLMessageContext<InboundMessageType,OutboundMessageType,NameIdentifierType>, MessageContext

public class BasicSAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
extends BaseMessageContext
implements SAMLMessageContext<InboundMessageType,OutboundMessageType,NameIdentifierType>

Base implemention of SAMLMessageContext.

Constructor Summary

Constructors

Constructor and Description
BasicSAMLMessageContext()

Method Summary

Methods

Modifier and Type	Method and Description
InboundMessageType	getInboundSAMLMessage() Gets the inbound SAML message.
String	getInboundSAMLMessageId() Gets the ID of the inbound SAML message.
org.joda.time.DateTime	getInboundSAMLMessageIssueInstant() Gets the issue instant of the incomming SAML message.
String	getInboundSAMLProtocol() Gets the protocol used by the peer entity to communicate with the local entity.
String	getLocalEntityId() Gets the local entity's ID.
EntityDescriptor	getLocalEntityMetadata() Gets the local entity metadata.
QName	getLocalEntityRole() Gets the role of the local entity.
RoleDescriptor	getLocalEntityRoleMetadata() Gets the role metadata of the local entity.
MetadataProvider	getMetadataProvider() Gets the metadata provider used to lookup information entity information.
Credential	getOuboundSAMLMessageSigningCredential() Gets the credential used to sign the outbound SAML message.
byte[]	getOutboundMessageArtifactType() Gets the artifact type to use for the outbound message.
OutboundMessageType	getOutboundSAMLMessage() Gets the outbound SAML message.
String	getOutboundSAMLMessageId() Gets the ID of the outbound SAML message.
org.joda.time.DateTime	getOutboundSAMLMessageIssueInstant() Gets the issue instant of the outbound SAML message.
String	getOutboundSAMLProtocol() Gets the protocol used by the local entity to communicate with the peer entity.
Endpoint	getPeerEntityEndpoint() Gets the endpoint of for the peer entity.
String	getPeerEntityId() Gets the peer's entity ID.
EntityDescriptor	getPeerEntityMetadata() Gets the peer entity metadata.
QName	getPeerEntityRole() Gets the role of the peer entity.
RoleDescriptor	getPeerEntityRoleMetadata() Gets the role of the peer entity.
String	getRelayState() Gets the relay state associated with the message.
NameIdentifierType	getSubjectNameIdentifier() Gets the subject's SAML name identifier.
boolean	isInboundSAMLMessageAuthenticated() Gets whether the inbound SAML message has been authenticated.
boolean	isIssuerAuthenticated() Gets whether the issuer of the inbound message represented by this context has been authenticated.
void	setInboundSAMLMessage(InboundMessageType message) Sets the inbound SAML message.
void	setInboundSAMLMessageAuthenticated(boolean isAuthenticated) Sets whether the inbound SAML message has been authenticated.
void	setInboundSAMLMessageId(String id) Sets the ID of the inbound SAML message.
void	setInboundSAMLMessageIssueInstant(org.joda.time.DateTime instant) Sets the issue instant of the incomming SAML message.
void	setInboundSAMLProtocol(String protocol) Sets the protocol used by the peer entity to communicate with the local entity.
void	setLocalEntityId(String id) Sets the local entity's ID.
void	setLocalEntityMetadata(EntityDescriptor metadata) Sets the local entity metadata.
void	setLocalEntityRole(QName role) Sets the role of the local entity.
void	setLocalEntityRoleMetadata(RoleDescriptor role) Sets the role metadata for the local entity.
void	setMetadataProvider(MetadataProvider provider) Sets the metadata provider used to lookup information entity information.
void	setOutboundMessageArtifactType(byte[] type) Sets the artifact type to use for the outbound message.
void	setOutboundSAMLMessage(OutboundMessageType message) Sets the outbound SAML message.
void	setOutboundSAMLMessageId(String id) Sets the ID of the outbound SAML message.
void	setOutboundSAMLMessageIssueInstant(org.joda.time.DateTime instant) Sets the issue instant of the outbound SAML message.
void	setOutboundSAMLMessageSigningCredential(Credential credential) Sets the credential used to sign the outbound SAML message.
void	setOutboundSAMLProtocol(String protocol) Sets the protocol used by the local entity to communicate with the peer entity.
void	setPeerEntityEndpoint(Endpoint endpoint) Sets the endpoint of for the peer entity.
void	setPeerEntityId(String id) Sets the peer's entity ID.
void	setPeerEntityMetadata(EntityDescriptor metadata) Sets the peer entity metadata.
void	setPeerEntityRole(QName role) Sets the role of the peer entity.
void	setPeerEntityRoleMetadata(RoleDescriptor role) Sets the role metadata for the peer entity.
void	setRelayState(String state) Sets the relay state associated with the message.
void	setSubjectNameIdentifier(NameIdentifierType identifier) Sets the subject's SAML name identifier.

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.ws.message.MessageContext

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

Constructor Detail

BasicSAMLMessageContext

public BasicSAMLMessageContext()

Method Detail

getInboundSAMLMessage

public InboundMessageType getInboundSAMLMessage()

Gets the inbound SAML message. This may not be the same as the message returned from MessageContext.getInboundMessage() if the SAML message was carried in another protocol (e.g. SOAP).

Specified by:

getInboundSAMLMessage in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Returns:

inbound SAML message

getInboundSAMLMessageId

public String getInboundSAMLMessageId()

Gets the ID of the inbound SAML message.

Specified by:

getInboundSAMLMessageId in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Returns:

ID of the inbound SAML message

getInboundSAMLMessageIssueInstant

public org.joda.time.DateTime getInboundSAMLMessageIssueInstant()

Gets the issue instant of the incomming SAML message.

Specified by:

getInboundSAMLMessageIssueInstant in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Returns:

issue instant of the incomming SAML message

getInboundSAMLProtocol

public String getInboundSAMLProtocol()

Gets the protocol used by the peer entity to communicate with the local entity.

Specified by:

getInboundSAMLProtocol in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Returns:

protocol used by the peer entity to communicate with the local entity

getLocalEntityId

public String getLocalEntityId()

Gets the local entity's ID.

Specified by:

getLocalEntityId in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Returns:

local entity's ID

getLocalEntityMetadata

public EntityDescriptor getLocalEntityMetadata()

Gets the local entity metadata.

Specified by:

getLocalEntityMetadata in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Returns:

local entity metadata

getLocalEntityRole

public QName getLocalEntityRole()

Gets the role of the local entity.

Specified by:

getLocalEntityRole in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Returns:

role of the local entity

getLocalEntityRoleMetadata

public RoleDescriptor getLocalEntityRoleMetadata()

Gets the role metadata of the local entity.

Specified by:

getLocalEntityRoleMetadata in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Returns:

role metadata of the local entity

getMetadataProvider

public MetadataProvider getMetadataProvider()

Gets the metadata provider used to lookup information entity information.

Specified by:

getMetadataProvider in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Returns:

metadata provider used to lookup information entity information

getOuboundSAMLMessageSigningCredential

public Credential getOuboundSAMLMessageSigningCredential()

Gets the credential used to sign the outbound SAML message.

Specified by:

getOuboundSAMLMessageSigningCredential in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Returns:

credential used to sign the outbound SAML message

getOutboundSAMLMessage

public OutboundMessageType getOutboundSAMLMessage()

Gets the outbound SAML message. This may not be the same as the message returned from MessageContext.getOutboundMessage() if the SAML message was carried in another protocol (e.g. SOAP).

Specified by:

getOutboundSAMLMessage in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Returns:

outbound SAML message

getOutboundSAMLMessageId

public String getOutboundSAMLMessageId()

Gets the ID of the outbound SAML message.

Specified by:

getOutboundSAMLMessageId in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Returns:

ID of the outbound SAML message

getOutboundSAMLMessageIssueInstant

public org.joda.time.DateTime getOutboundSAMLMessageIssueInstant()

Gets the issue instant of the outbound SAML message.

Specified by:

getOutboundSAMLMessageIssueInstant in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Returns:

issue instant of the outbound SAML message

getOutboundSAMLProtocol

public String getOutboundSAMLProtocol()

Gets the protocol used by the local entity to communicate with the peer entity.

Specified by:

getOutboundSAMLProtocol in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Returns:

protocol used by the local entity to communicate with the peer entity

getPeerEntityEndpoint

public Endpoint getPeerEntityEndpoint()

Gets the endpoint of for the peer entity.

Specified by:

getPeerEntityEndpoint in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Returns:

endpoint of for the peer entity

getPeerEntityId

public String getPeerEntityId()

Gets the peer's entity ID.

Specified by:

getPeerEntityId in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Returns:

peer's entity ID

getPeerEntityMetadata

public EntityDescriptor getPeerEntityMetadata()

Gets the peer entity metadata.

Specified by:

getPeerEntityMetadata in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Returns:

peer entity metadata

getPeerEntityRole

public QName getPeerEntityRole()

Gets the role of the peer entity.

Specified by:

getPeerEntityRole in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Returns:

role of the peer entity

getPeerEntityRoleMetadata

public RoleDescriptor getPeerEntityRoleMetadata()

Gets the role of the peer entity.

Specified by:

getPeerEntityRoleMetadata in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Returns:

role of the peer entity

getRelayState

public String getRelayState()

Gets the relay state associated with the message.

Specified by:

getRelayState in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Returns:

relay state associated with the message

getSubjectNameIdentifier

public NameIdentifierType getSubjectNameIdentifier()

Gets the subject's SAML name identifier.

Specified by:

getSubjectNameIdentifier in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Returns:

subject's SAML name identifier

isInboundSAMLMessageAuthenticated

public boolean isInboundSAMLMessageAuthenticated()

Gets whether the inbound SAML message has been authenticated.

Specified by:

isInboundSAMLMessageAuthenticated in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Returns:

whether the inbound SAML message has been authenticated

setInboundSAMLMessage

public void setInboundSAMLMessage(InboundMessageType message)

Sets the inbound SAML message.

Specified by:

setInboundSAMLMessage in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Parameters:

message - inbound SAML message

setInboundSAMLMessageAuthenticated

public void setInboundSAMLMessageAuthenticated(boolean isAuthenticated)

Sets whether the inbound SAML message has been authenticated.

Specified by:

setInboundSAMLMessageAuthenticated in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Parameters:

isAuthenticated - whether the inbound SAML message has been authenticated

setInboundSAMLMessageId

public void setInboundSAMLMessageId(String id)

Sets the ID of the inbound SAML message.

Specified by:

setInboundSAMLMessageId in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Parameters:

id - ID of the inbound SAML message

setInboundSAMLMessageIssueInstant

public void setInboundSAMLMessageIssueInstant(org.joda.time.DateTime instant)

Sets the issue instant of the incomming SAML message.

Specified by:

setInboundSAMLMessageIssueInstant in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Parameters:

instant - issue instant of the incomming SAML message

setInboundSAMLProtocol

public void setInboundSAMLProtocol(String protocol)

Sets the protocol used by the peer entity to communicate with the local entity.

Specified by:

setInboundSAMLProtocol in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Parameters:

protocol - protocol used by the peer entity to communicate with the local entity

setLocalEntityId

public void setLocalEntityId(String id)

Sets the local entity's ID.

Specified by:

setLocalEntityId in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Parameters:

id - local entity's ID

setLocalEntityMetadata

public void setLocalEntityMetadata(EntityDescriptor metadata)

Sets the local entity metadata.

Specified by:

setLocalEntityMetadata in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Parameters:

metadata - local entity metadata

setLocalEntityRole

public void setLocalEntityRole(QName role)

Sets the role of the local entity.

Specified by:

setLocalEntityRole in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Parameters:

role - role of the local entity

setLocalEntityRoleMetadata

public void setLocalEntityRoleMetadata(RoleDescriptor role)

Sets the role metadata for the local entity.

Specified by:

setLocalEntityRoleMetadata in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Parameters:

role - role metadata for the local entity

setMetadataProvider

public void setMetadataProvider(MetadataProvider provider)

Sets the metadata provider used to lookup information entity information.

Specified by:

setMetadataProvider in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Parameters:

provider - metadata provider used to lookup information entity information

setOutboundSAMLMessage

public void setOutboundSAMLMessage(OutboundMessageType message)

Sets the outbound SAML message.

Specified by:

setOutboundSAMLMessage in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Parameters:

message - outbound SAML message

setOutboundSAMLMessageId

public void setOutboundSAMLMessageId(String id)

Sets the ID of the outbound SAML message.

Specified by:

setOutboundSAMLMessageId in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Parameters:

id - ID of the outbound SAML message

setOutboundSAMLMessageIssueInstant

public void setOutboundSAMLMessageIssueInstant(org.joda.time.DateTime instant)

Sets the issue instant of the outbound SAML message.

Specified by:

setOutboundSAMLMessageIssueInstant in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Parameters:

instant - issue instant of the outbound SAML message

setOutboundSAMLMessageSigningCredential

public void setOutboundSAMLMessageSigningCredential(Credential credential)

Sets the credential used to sign the outbound SAML message.

Specified by:

setOutboundSAMLMessageSigningCredential in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Parameters:

credential - credential used to sign the outbound SAML message

setOutboundSAMLProtocol

public void setOutboundSAMLProtocol(String protocol)

Sets the protocol used by the local entity to communicate with the peer entity.

Specified by:

setOutboundSAMLProtocol in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Parameters:

protocol - protocol used by the local entity to communicate with the peer entity

setPeerEntityEndpoint

public void setPeerEntityEndpoint(Endpoint endpoint)

Sets the endpoint of for the peer entity.

Specified by:

setPeerEntityEndpoint in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Parameters:

endpoint - endpoint of for the peer entity

setPeerEntityId

public void setPeerEntityId(String id)

Sets the peer's entity ID.

Specified by:

setPeerEntityId in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Parameters:

id - peer's entity ID

setPeerEntityMetadata

public void setPeerEntityMetadata(EntityDescriptor metadata)

Sets the peer entity metadata.

Specified by:

setPeerEntityMetadata in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Parameters:

metadata - peer entity metadata

setPeerEntityRole

public void setPeerEntityRole(QName role)

Sets the role of the peer entity.

Specified by:

setPeerEntityRole in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Parameters:

role - role of the peer entity

setPeerEntityRoleMetadata

public void setPeerEntityRoleMetadata(RoleDescriptor role)

Sets the role metadata for the peer entity.

Specified by:

setPeerEntityRoleMetadata in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Parameters:

role - role metadata for the peer entity

setRelayState

public void setRelayState(String state)

Sets the relay state associated with the message.

Specified by:

setRelayState in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Parameters:

state - relay state associated with the message

setSubjectNameIdentifier

public void setSubjectNameIdentifier(NameIdentifierType identifier)

Sets the subject's SAML name identifier.

Specified by:

setSubjectNameIdentifier in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Parameters:

identifier - subject's SAML name identifier

getOutboundMessageArtifactType

public byte[] getOutboundMessageArtifactType()

Gets the artifact type to use for the outbound message.

Specified by:

getOutboundMessageArtifactType in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Returns:

artifact type to use for the outbound message

setOutboundMessageArtifactType

public void setOutboundMessageArtifactType(byte[] type)

Sets the artifact type to use for the outbound message.

Specified by:

setOutboundMessageArtifactType in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Parameters:

type - artifact type to use for the outbound message

isIssuerAuthenticated

public boolean isIssuerAuthenticated()

Gets whether the issuer of the inbound message represented by this context has been authenticated. What it means for the message issuer to be authenticate will vary by use and employed authentication mechanisms.

Specified by:

isIssuerAuthenticated in interface MessageContext

Overrides:

isIssuerAuthenticated in class BaseMessageContext

Returns:

whether the issuer of the inbound message represented by this context has been authenticated