|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opensaml.ws.message.BaseMessageContext
org.opensaml.common.binding.BasicSAMLMessageContext<InboundMessageType,OutboundMessageType,NameIdentifierType>
InboundMessageType
- type of inbound SAML messageOutboundMessageType
- type of outbound SAML messageNameIdentifierType
- type of name identifier used for subjectspublic class BasicSAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
Base implemention of SAMLMessageContext
.
Constructor Summary | |
---|---|
BasicSAMLMessageContext()
|
Method Summary | |
---|---|
InboundMessageType |
getInboundSAMLMessage()
Gets the inbound SAML message. |
java.lang.String |
getInboundSAMLMessageId()
Gets the ID of the inbound SAML message. |
org.joda.time.DateTime |
getInboundSAMLMessageIssueInstant()
Gets the issue instant of the incomming SAML message. |
java.lang.String |
getInboundSAMLProtocol()
Gets the protocol used by the peer entity to communicate with the local entity. |
java.lang.String |
getLocalEntityId()
Gets the local entity's ID. |
EntityDescriptor |
getLocalEntityMetadata()
Gets the local entity metadata. |
javax.xml.namespace.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. |
java.lang.String |
getOutboundSAMLMessageId()
Gets the ID of the outbound SAML message. |
org.joda.time.DateTime |
getOutboundSAMLMessageIssueInstant()
Gets the issue instant of the outbound SAML message. |
java.lang.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. |
java.lang.String |
getPeerEntityId()
Gets the peer's entity ID. |
EntityDescriptor |
getPeerEntityMetadata()
Gets the peer entity metadata. |
javax.xml.namespace.QName |
getPeerEntityRole()
Gets the role of the peer entity. |
RoleDescriptor |
getPeerEntityRoleMetadata()
Gets the role of the peer entity. |
java.lang.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()
|
void |
setInboundSAMLMessage(InboundMessageType message)
Sets the inbound SAML message. |
void |
setInboundSAMLMessageAuthenticated(boolean isAuthenticated)
Sets whether the inbound SAML message has been authenticated. |
void |
setInboundSAMLMessageId(java.lang.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(java.lang.String protocol)
Sets the protocol used by the peer entity to communicate with the local entity. |
void |
setLocalEntityId(java.lang.String id)
Sets the local entity's ID. |
void |
setLocalEntityMetadata(EntityDescriptor metadata)
Sets the local entity metadata. |
void |
setLocalEntityRole(javax.xml.namespace.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(java.lang.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(java.lang.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(java.lang.String id)
Sets the peer's entity ID. |
void |
setPeerEntityMetadata(EntityDescriptor metadata)
Sets the peer entity metadata. |
void |
setPeerEntityRole(javax.xml.namespace.QName role)
Sets the role of the peer entity. |
void |
setPeerEntityRoleMetadata(RoleDescriptor role)
Sets the role metadata for the peer entity. |
void |
setRelayState(java.lang.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 |
---|
public BasicSAMLMessageContext()
Method Detail |
---|
public InboundMessageType getInboundSAMLMessage()
MessageContext.getInboundMessage()
if the SAML message was carried in another protocol (e.g. SOAP).
getInboundSAMLMessage
in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
public java.lang.String getInboundSAMLMessageId()
getInboundSAMLMessageId
in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
public org.joda.time.DateTime getInboundSAMLMessageIssueInstant()
getInboundSAMLMessageIssueInstant
in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
public java.lang.String getInboundSAMLProtocol()
getInboundSAMLProtocol
in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
public java.lang.String getLocalEntityId()
getLocalEntityId
in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
public EntityDescriptor getLocalEntityMetadata()
getLocalEntityMetadata
in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
public javax.xml.namespace.QName getLocalEntityRole()
getLocalEntityRole
in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
public RoleDescriptor getLocalEntityRoleMetadata()
getLocalEntityRoleMetadata
in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
public MetadataProvider getMetadataProvider()
getMetadataProvider
in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
public org.opensaml.xml.security.credential.Credential getOuboundSAMLMessageSigningCredential()
getOuboundSAMLMessageSigningCredential
in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
public OutboundMessageType getOutboundSAMLMessage()
MessageContext.getOutboundMessage()
if the SAML message was carried in another protocol (e.g. SOAP).
getOutboundSAMLMessage
in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
public java.lang.String getOutboundSAMLMessageId()
getOutboundSAMLMessageId
in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
public org.joda.time.DateTime getOutboundSAMLMessageIssueInstant()
getOutboundSAMLMessageIssueInstant
in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
public java.lang.String getOutboundSAMLProtocol()
getOutboundSAMLProtocol
in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
public Endpoint getPeerEntityEndpoint()
getPeerEntityEndpoint
in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
public java.lang.String getPeerEntityId()
getPeerEntityId
in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
public EntityDescriptor getPeerEntityMetadata()
getPeerEntityMetadata
in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
public javax.xml.namespace.QName getPeerEntityRole()
getPeerEntityRole
in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
public RoleDescriptor getPeerEntityRoleMetadata()
getPeerEntityRoleMetadata
in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
public java.lang.String getRelayState()
getRelayState
in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
public NameIdentifierType getSubjectNameIdentifier()
getSubjectNameIdentifier
in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
public boolean isInboundSAMLMessageAuthenticated()
isInboundSAMLMessageAuthenticated
in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
public void setInboundSAMLMessage(InboundMessageType message)
setInboundSAMLMessage
in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
message
- inbound SAML messagepublic void setInboundSAMLMessageAuthenticated(boolean isAuthenticated)
setInboundSAMLMessageAuthenticated
in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
isAuthenticated
- whether the inbound SAML message has been authenticatedpublic void setInboundSAMLMessageId(java.lang.String id)
setInboundSAMLMessageId
in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
id
- ID of the inbound SAML messagepublic void setInboundSAMLMessageIssueInstant(org.joda.time.DateTime instant)
setInboundSAMLMessageIssueInstant
in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
instant
- issue instant of the incomming SAML messagepublic void setInboundSAMLProtocol(java.lang.String protocol)
setInboundSAMLProtocol
in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
protocol
- protocol used by the peer entity to communicate with the local entitypublic void setLocalEntityId(java.lang.String id)
setLocalEntityId
in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
id
- local entity's IDpublic void setLocalEntityMetadata(EntityDescriptor metadata)
setLocalEntityMetadata
in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
metadata
- local entity metadatapublic void setLocalEntityRole(javax.xml.namespace.QName role)
setLocalEntityRole
in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
role
- role of the local entitypublic void setLocalEntityRoleMetadata(RoleDescriptor role)
setLocalEntityRoleMetadata
in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
role
- role metadata for the local entitypublic void setMetadataProvider(MetadataProvider provider)
setMetadataProvider
in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
provider
- metadata provider used to lookup information entity informationpublic void setOutboundSAMLMessage(OutboundMessageType message)
setOutboundSAMLMessage
in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
message
- outbound SAML messagepublic void setOutboundSAMLMessageId(java.lang.String id)
setOutboundSAMLMessageId
in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
id
- ID of the outbound SAML messagepublic void setOutboundSAMLMessageIssueInstant(org.joda.time.DateTime instant)
setOutboundSAMLMessageIssueInstant
in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
instant
- issue instant of the outbound SAML messagepublic void setOutboundSAMLMessageSigningCredential(org.opensaml.xml.security.credential.Credential credential)
setOutboundSAMLMessageSigningCredential
in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
credential
- credential used to sign the outbound SAML messagepublic void setOutboundSAMLProtocol(java.lang.String protocol)
setOutboundSAMLProtocol
in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
protocol
- protocol used by the local entity to communicate with the peer entitypublic void setPeerEntityEndpoint(Endpoint endpoint)
setPeerEntityEndpoint
in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
endpoint
- endpoint of for the peer entitypublic void setPeerEntityId(java.lang.String id)
setPeerEntityId
in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
id
- peer's entity IDpublic void setPeerEntityMetadata(EntityDescriptor metadata)
setPeerEntityMetadata
in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
metadata
- peer entity metadatapublic void setPeerEntityRole(javax.xml.namespace.QName role)
setPeerEntityRole
in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
role
- role of the peer entitypublic void setPeerEntityRoleMetadata(RoleDescriptor role)
setPeerEntityRoleMetadata
in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
role
- role metadata for the peer entitypublic void setRelayState(java.lang.String state)
setRelayState
in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
state
- relay state associated with the messagepublic void setSubjectNameIdentifier(NameIdentifierType identifier)
setSubjectNameIdentifier
in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
identifier
- subject's SAML name identifierpublic byte[] getOutboundMessageArtifactType()
getOutboundMessageArtifactType
in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
public void setOutboundMessageArtifactType(byte[] type)
setOutboundMessageArtifactType
in interface SAMLMessageContext<InboundMessageType extends SAMLObject,OutboundMessageType extends SAMLObject,NameIdentifierType extends SAMLObject>
type
- artifact type to use for the outbound messagepublic boolean isIssuerAuthenticated()
isIssuerAuthenticated
in interface org.opensaml.ws.message.MessageContext
isIssuerAuthenticated
in class org.opensaml.ws.message.BaseMessageContext
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |