OpenSAML-J 2.4.1-redhat-3

org.opensaml.common.binding
Interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>

Type Parameters:
InboundMessageType - type of inbound SAML message
OutboundMessageType - type of outbound SAML message
NameIdentifierType - type of name identifier used for subjects
All Superinterfaces:
org.opensaml.ws.message.MessageContext
All Known Subinterfaces:
SAML1ArtifactMessageContext<InboundMessageType,OutboundMessageType,NameIdentifierType>, SAML2ArtifactMessageContext<InboundMessageType,OutboundMessageType,NameIdentifierType>
All Known Implementing Classes:
BasicSAMLMessageContext

public interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
extends org.opensaml.ws.message.MessageContext

SAML specific extension to the more basic MessageContext.


Method Summary
 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.
 org.opensaml.xml.security.credential.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.
 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(org.opensaml.xml.security.credential.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 relayState)
          Sets the relay state associated with the message.
 void setSubjectNameIdentifier(NameIdentifierType identifier)
          Sets the subject's SAML name identifier.
 
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
 

Method Detail

getInboundSAMLMessage

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).

Returns:
inbound SAML message

getInboundSAMLMessageId

String getInboundSAMLMessageId()
Gets the ID of the inbound SAML message.

Returns:
ID of the inbound SAML message

getInboundSAMLMessageIssueInstant

org.joda.time.DateTime getInboundSAMLMessageIssueInstant()
Gets the issue instant of the incomming SAML message.

Returns:
issue instant of the incomming SAML message

getInboundSAMLProtocol

String getInboundSAMLProtocol()
Gets the protocol used by the peer entity to communicate with the local entity.

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

getLocalEntityId

String getLocalEntityId()
Gets the local entity's ID.

Returns:
local entity's ID

getLocalEntityMetadata

EntityDescriptor getLocalEntityMetadata()
Gets the local entity metadata.

Returns:
local entity metadata

getLocalEntityRole

QName getLocalEntityRole()
Gets the role of the local entity.

Returns:
role of the local entity

getLocalEntityRoleMetadata

RoleDescriptor getLocalEntityRoleMetadata()
Gets the role metadata of the local entity.

Returns:
role metadata of the local entity

getMetadataProvider

MetadataProvider getMetadataProvider()
Gets the metadata provider used to lookup information entity information.

Returns:
metadata provider used to lookup information entity information

getOuboundSAMLMessageSigningCredential

org.opensaml.xml.security.credential.Credential getOuboundSAMLMessageSigningCredential()
Gets the credential used to sign the outbound SAML message.

Returns:
credential used to sign the outbound SAML message

getOutboundMessageArtifactType

byte[] getOutboundMessageArtifactType()
Gets the artifact type to use for the outbound message.

Returns:
artifact type to use for the outbound message

getOutboundSAMLMessage

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).

Returns:
outbound SAML message

getOutboundSAMLMessageId

String getOutboundSAMLMessageId()
Gets the ID of the outbound SAML message.

Returns:
ID of the outbound SAML message

getOutboundSAMLMessageIssueInstant

org.joda.time.DateTime getOutboundSAMLMessageIssueInstant()
Gets the issue instant of the outbound SAML message.

Returns:
issue instant of the outbound SAML message

getOutboundSAMLProtocol

String getOutboundSAMLProtocol()
Gets the protocol used by the local entity to communicate with the peer entity.

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

getPeerEntityEndpoint

Endpoint getPeerEntityEndpoint()
Gets the endpoint of for the peer entity.

Returns:
endpoint of for the peer entity

getPeerEntityId

String getPeerEntityId()
Gets the peer's entity ID.

Returns:
peer's entity ID

getPeerEntityMetadata

EntityDescriptor getPeerEntityMetadata()
Gets the peer entity metadata.

Returns:
peer entity metadata

getPeerEntityRole

QName getPeerEntityRole()
Gets the role of the peer entity.

Returns:
role of the peer entity

getPeerEntityRoleMetadata

RoleDescriptor getPeerEntityRoleMetadata()
Gets the role of the peer entity.

Returns:
role of the peer entity

getRelayState

String getRelayState()
Gets the relay state associated with the message.

Returns:
relay state associated with the message

getSubjectNameIdentifier

NameIdentifierType getSubjectNameIdentifier()
Gets the subject's SAML name identifier.

Returns:
subject's SAML name identifier

isInboundSAMLMessageAuthenticated

boolean isInboundSAMLMessageAuthenticated()
Gets whether the inbound SAML message has been authenticated.

Returns:
whether the inbound SAML message has been authenticated

setInboundSAMLMessage

void setInboundSAMLMessage(InboundMessageType message)
Sets the inbound SAML message.

Parameters:
message - inbound SAML message

setInboundSAMLMessageAuthenticated

void setInboundSAMLMessageAuthenticated(boolean isAuthenticated)
Sets whether the inbound SAML message has been authenticated.

Parameters:
isAuthenticated - whether the inbound SAML message has been authenticated

setInboundSAMLMessageId

void setInboundSAMLMessageId(String id)
Sets the ID of the inbound SAML message.

Parameters:
id - ID of the inbound SAML message

setInboundSAMLMessageIssueInstant

void setInboundSAMLMessageIssueInstant(org.joda.time.DateTime instant)
Sets the issue instant of the incomming SAML message.

Parameters:
instant - issue instant of the incomming SAML message

setInboundSAMLProtocol

void setInboundSAMLProtocol(String protocol)
Sets the protocol used by the peer entity to communicate with the local entity.

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

setLocalEntityId

void setLocalEntityId(String id)
Sets the local entity's ID.

Parameters:
id - local entity's ID

setLocalEntityMetadata

void setLocalEntityMetadata(EntityDescriptor metadata)
Sets the local entity metadata.

Parameters:
metadata - local entity metadata

setLocalEntityRole

void setLocalEntityRole(QName role)
Sets the role of the local entity.

Parameters:
role - role of the local entity

setLocalEntityRoleMetadata

void setLocalEntityRoleMetadata(RoleDescriptor role)
Sets the role metadata for the local entity.

Parameters:
role - role metadata for the local entity

setMetadataProvider

void setMetadataProvider(MetadataProvider provider)
Sets the metadata provider used to lookup information entity information.

Parameters:
provider - metadata provider used to lookup information entity information

setOutboundMessageArtifactType

void setOutboundMessageArtifactType(byte[] type)
Sets the artifact type to use for the outbound message.

Parameters:
type - artifact type to use for the outbound message

setOutboundSAMLMessage

void setOutboundSAMLMessage(OutboundMessageType message)
Sets the outbound SAML message.

Parameters:
message - outbound SAML message

setOutboundSAMLMessageId

void setOutboundSAMLMessageId(String id)
Sets the ID of the outbound SAML message.

Parameters:
id - ID of the outbound SAML message

setOutboundSAMLMessageIssueInstant

void setOutboundSAMLMessageIssueInstant(org.joda.time.DateTime instant)
Sets the issue instant of the outbound SAML message.

Parameters:
instant - issue instant of the outbound SAML message

setOutboundSAMLMessageSigningCredential

void setOutboundSAMLMessageSigningCredential(org.opensaml.xml.security.credential.Credential credential)
Sets the credential used to sign the outbound SAML message.

Parameters:
credential - credential used to sign the outbound SAML message

setOutboundSAMLProtocol

void setOutboundSAMLProtocol(String protocol)
Sets the protocol used by the local entity to communicate with the peer entity.

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

setPeerEntityEndpoint

void setPeerEntityEndpoint(Endpoint endpoint)
Sets the endpoint of for the peer entity.

Parameters:
endpoint - endpoint of for the peer entity

setPeerEntityId

void setPeerEntityId(String id)
Sets the peer's entity ID.

Parameters:
id - peer's entity ID

setPeerEntityMetadata

void setPeerEntityMetadata(EntityDescriptor metadata)
Sets the peer entity metadata.

Parameters:
metadata - peer entity metadata

setPeerEntityRole

void setPeerEntityRole(QName role)
Sets the role of the peer entity.

Parameters:
role - role of the peer entity

setPeerEntityRoleMetadata

void setPeerEntityRoleMetadata(RoleDescriptor role)
Sets the role metadata for the peer entity.

Parameters:
role - role metadata for the peer entity

setRelayState

void setRelayState(String relayState)
Sets the relay state associated with the message.

Parameters:
relayState - relay state associated with the message

setSubjectNameIdentifier

void setSubjectNameIdentifier(NameIdentifierType identifier)
Sets the subject's SAML name identifier.

Parameters:
identifier - subject's SAML name identifier

OpenSAML-J 2.4.1-redhat-3

Copyright © 2006-2012 Internet2. All Rights Reserved.