|
||||||||||
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<InboundMessage,OutboundMessage,NameIdentifierType>
edu.internet2.middleware.shibboleth.common.profile.provider.BaseSAMLProfileRequestContext<InboundMessage,OutboundMessage,NameIdentifierType,ProfileConfigurationType>
InboundMessage
- type of inbound SAML messageOutboundMessage
- type of outbound SAML messageNameIdentifierType
- type of name identifier used for subjectsProfileConfigurationType
- profile configuration type for current requestpublic class BaseSAMLProfileRequestContext<InboundMessage extends org.opensaml.common.SAMLObject,OutboundMessage extends org.opensaml.common.SAMLObject,NameIdentifierType extends org.opensaml.common.SAMLObject,ProfileConfigurationType extends ProfileConfiguration>
Contextual object used to accumlate information as profile requests are being processed.
Field Summary | |
---|---|
private org.opensaml.common.binding.decoding.SAMLMessageDecoder |
messageDecoder
Decoder used to decode inbound message. |
private org.opensaml.common.binding.encoding.SAMLMessageEncoder |
messageEncoder
Encoder used to encode outbound message. |
private BaseAttribute |
nameIdentifierAttribute
Attribute encoded as the SAML name identifier. |
private Map<String,BaseAttribute> |
principalAttributes
Attributes retrieved for the principal. |
private String |
principalAuthenticationMethod
Authentication method used to authenticate the principal. |
private String |
principalName
Principal name of the subject of the request. |
private ProfileConfigurationType |
profileConfiguration
Configuration for the profile. |
private Collection<String> |
releasedAttributeIds
IDs of attribute released to relying party. |
private RelyingPartyConfiguration |
relyingPartyConfiguration
Configuration for the relying party. |
private Collection<String> |
requestedAttributeIds
IDs of attribute requested by relaying party. |
private Session |
userSession
Current user's session. |
Constructor Summary | |
---|---|
BaseSAMLProfileRequestContext()
|
Method Summary | |
---|---|
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 |
Field Detail |
---|
private org.opensaml.common.binding.decoding.SAMLMessageDecoder messageDecoder
private org.opensaml.common.binding.encoding.SAMLMessageEncoder messageEncoder
private Map<String,BaseAttribute> principalAttributes
private String principalAuthenticationMethod
private String principalName
private BaseAttribute nameIdentifierAttribute
private ProfileConfigurationType extends ProfileConfiguration profileConfiguration
private Collection<String> releasedAttributeIds
private RelyingPartyConfiguration relyingPartyConfiguration
private Collection<String> requestedAttributeIds
private Session userSession
Constructor Detail |
---|
public BaseSAMLProfileRequestContext()
Method Detail |
---|
public Map<String,BaseAttribute> getAttributes()
getAttributes
in interface AttributeRequestContext
public org.opensaml.common.binding.decoding.SAMLMessageDecoder getMessageDecoder()
public org.opensaml.common.binding.encoding.SAMLMessageEncoder getMessageEncoder()
public BaseAttribute getNameIdentifierAttribute()
public String getPrincipalAuthenticationMethod()
getPrincipalAuthenticationMethod
in interface AttributeRequestContext
public String getPrincipalName()
getPrincipalName
in interface AttributeRequestContext
public ProfileConfigurationType getProfileConfiguration()
getProfileConfiguration
in interface ProfileRequestContext<ProfileConfigurationType extends ProfileConfiguration>
public Collection<String> getReleasedAttributes()
getReleasedAttributes
in interface ProfileRequestContext<ProfileConfigurationType extends ProfileConfiguration>
public RelyingPartyConfiguration getRelyingPartyConfiguration()
getRelyingPartyConfiguration
in interface ProfileRequestContext<ProfileConfigurationType extends ProfileConfiguration>
public Collection<String> getRequestedAttributesIds()
getRequestedAttributesIds
in interface AttributeRequestContext
public Session getUserSession()
getUserSession
in interface ProfileRequestContext<ProfileConfigurationType extends ProfileConfiguration>
public void setAttributes(Map<String,BaseAttribute> attributes)
setAttributes
in interface AttributeRequestContext
attributes
- retrieved attributespublic void setMessageDecoder(org.opensaml.common.binding.decoding.SAMLMessageDecoder decoder)
decoder
- message decoder used to decode the message from the inbound transportpublic void setMessageEncoder(org.opensaml.common.binding.encoding.SAMLMessageEncoder encoder)
encoder
- message encoder used to encoder the message onto the outbound transportpublic void setNameIdentifierAttribute(BaseAttribute attribute)
attribute
- attribute encoded as the SAML name identifierpublic void setPrincipalAuthenticationMethod(String method)
setPrincipalAuthenticationMethod
in interface AttributeRequestContext
method
- method used to authenticate the principalpublic void setPrincipalName(String name)
setPrincipalName
in interface AttributeRequestContext
name
- principal name of the subject of the requestpublic void setProfileConfiguration(ProfileConfigurationType configuration)
setProfileConfiguration
in interface ProfileRequestContext<ProfileConfigurationType extends ProfileConfiguration>
configuration
- configuration for the profile for the relying partypublic void setReleasedAttributes(Collection<String> attributeIds)
setReleasedAttributes
in interface ProfileRequestContext<ProfileConfigurationType extends ProfileConfiguration>
attributeIds
- ids of the attributes released to the peerpublic void setRelyingPartyConfiguration(RelyingPartyConfiguration configuration)
setRelyingPartyConfiguration
in interface ProfileRequestContext<ProfileConfigurationType extends ProfileConfiguration>
configuration
- configuration for the relying party for this requestpublic void setRequestedAttributes(Collection<String> ids)
setRequestedAttributes
in interface AttributeRequestContext
ids
- collection of IDs for the attributes being requested by the relying partypublic void setUserSession(Session session)
setUserSession
in interface ProfileRequestContext<ProfileConfigurationType extends ProfileConfiguration>
session
- current user session
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |