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

クラス BaseSAMLProfileRequestContext<InboundMessage extends SAMLObject,OutboundMessage extends SAMLObject,NameIdentifierType extends 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>

型パラメータ:

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

すべての実装されたインタフェース:

AttributeRequestContext, ProfileRequestContext<ProfileConfigurationType>, SAMLProfileRequestContext<InboundMessage,OutboundMessage,NameIdentifierType,ProfileConfigurationType>, SAMLMessageContext<InboundMessage,OutboundMessage,NameIdentifierType>, MessageContext

直系の既知のサブクラス:

BaseSAML1ProfileRequestContext, BaseSAML2ProfileRequestContext

public class BaseSAMLProfileRequestContext<InboundMessage extends SAMLObject,OutboundMessage extends SAMLObject,NameIdentifierType extends SAMLObject,ProfileConfigurationType extends ProfileConfiguration>
extends BasicSAMLMessageContext<InboundMessage,OutboundMessage,NameIdentifierType>
implements SAMLProfileRequestContext<InboundMessage,OutboundMessage,NameIdentifierType,ProfileConfigurationType>

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

コンストラクタの概要

コンストラクタ

コンストラクタと説明
BaseSAMLProfileRequestContext()

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
Map<String,BaseAttribute>	getAttributes() Gets the retrieved attributes.
SAMLMessageDecoder	getMessageDecoder() Gets the message decoder used to decode the message from the inbound transport.
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(SAMLMessageDecoder decoder) Sets the message decoder used to decode the message from the inbound transport.
void	setMessageEncoder(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.

クラスから継承されたメソッド 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

クラスから継承されたメソッド 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

クラスから継承されたメソッド java.lang.Object

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

インタフェースから継承されたメソッド 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

インタフェースから継承されたメソッド 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

コンストラクタの詳細

BaseSAMLProfileRequestContext

public BaseSAMLProfileRequestContext()

メソッドの詳細

getAttributes

public Map<String,BaseAttribute> getAttributes()

Gets the retrieved attributes.

定義:

getAttributes インタフェース内 AttributeRequestContext

戻り値:

retrieved attributes

getMessageDecoder

public SAMLMessageDecoder getMessageDecoder()

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

戻り値:

message decoder used to decode the message from the inbound transport

getMessageEncoder

public SAMLMessageEncoder getMessageEncoder()

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

戻り値:

message encoder used to encoder the message onto the outbound transport

getNameIdentifierAttribute

public BaseAttribute getNameIdentifierAttribute()

Gets the attribute encoded as the SAML name identifier.

戻り値:

attribute encoded as the SAML name identifier

getPrincipalAuthenticationMethod

public String getPrincipalAuthenticationMethod()

Gets the method used to authenticate the principal.

定義:

getPrincipalAuthenticationMethod インタフェース内 AttributeRequestContext

戻り値:

method used to authenticate the principal

getPrincipalName

public String getPrincipalName()

Gets the principal name of the subject of the request.

定義:

getPrincipalName インタフェース内 AttributeRequestContext

戻り値:

principal name of the subject of the request

getProfileConfiguration

public ProfileConfigurationType getProfileConfiguration()

Gets the configuration for the profile for the relying party.

定義:

getProfileConfiguration インタフェース内 ProfileRequestContext<ProfileConfigurationType extends ProfileConfiguration>

戻り値:

configuration for the profile for the relying party

getReleasedAttributes

public Collection<String> getReleasedAttributes()

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

定義:

getReleasedAttributes インタフェース内 ProfileRequestContext<ProfileConfigurationType extends ProfileConfiguration>

戻り値:

attributes released to the peer

getRelyingPartyConfiguration

public RelyingPartyConfiguration getRelyingPartyConfiguration()

Gets the configuration for the relying party for this request.

定義:

getRelyingPartyConfiguration インタフェース内 ProfileRequestContext<ProfileConfigurationType extends ProfileConfiguration>

戻り値:

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.

定義:

getRequestedAttributesIds インタフェース内 AttributeRequestContext

戻り値:

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.

定義:

getUserSession インタフェース内 ProfileRequestContext<ProfileConfigurationType extends ProfileConfiguration>

戻り値:

current user session

setAttributes

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

Sets the retrieved attributes.

定義:

setAttributes インタフェース内 AttributeRequestContext

パラメータ:

attributes - retrieved attributes

setMessageDecoder

public void setMessageDecoder(SAMLMessageDecoder decoder)

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

パラメータ:

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

setMessageEncoder

public void setMessageEncoder(SAMLMessageEncoder encoder)

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

パラメータ:

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.

パラメータ:

attribute - attribute encoded as the SAML name identifier

setPrincipalAuthenticationMethod

public void setPrincipalAuthenticationMethod(String method)

Sets the method used to authenticate the principal.

定義:

setPrincipalAuthenticationMethod インタフェース内 AttributeRequestContext

パラメータ:

method - method used to authenticate the principal

setPrincipalName

public void setPrincipalName(String name)

Sets the principal name of the subject of the request.

定義:

setPrincipalName インタフェース内 AttributeRequestContext

パラメータ:

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.

定義:

setProfileConfiguration インタフェース内 ProfileRequestContext<ProfileConfigurationType extends ProfileConfiguration>

パラメータ:

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.

定義:

setReleasedAttributes インタフェース内 ProfileRequestContext<ProfileConfigurationType extends ProfileConfiguration>

パラメータ:

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.

定義:

setRelyingPartyConfiguration インタフェース内 ProfileRequestContext<ProfileConfigurationType extends ProfileConfiguration>

パラメータ:

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.

定義:

setRequestedAttributes インタフェース内 AttributeRequestContext

パラメータ:

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

setUserSession

public void setUserSession(Session session)

Sets the current user session.

定義:

setUserSession インタフェース内 ProfileRequestContext<ProfileConfigurationType extends ProfileConfiguration>

パラメータ:

session - current user session