org.opensaml.saml1.binding.decoding

クラス BaseSAML1MessageDecoder

java.lang.Object

org.opensaml.ws.message.decoder.BaseMessageDecoder

org.opensaml.common.binding.decoding.BaseSAMLMessageDecoder

org.opensaml.saml1.binding.decoding.BaseSAML1MessageDecoder

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

SAMLMessageDecoder, MessageDecoder

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

HTTPArtifactDecoder, HTTPPostDecoder, HTTPSOAP11Decoder, ShibbolethSSODecoder

public abstract class BaseSAML1MessageDecoder
extends BaseSAMLMessageDecoder

Base class for SAML 1 message decoders.

コンストラクタの概要

コンストラクタ

コンストラクタと説明
BaseSAML1MessageDecoder() Constructor.
BaseSAML1MessageDecoder(ParserPool pool) Constructor.
BaseSAML1MessageDecoder(SAMLArtifactMap map) 推奨されていません。
BaseSAML1MessageDecoder(SAMLArtifactMap map, ParserPool pool) 推奨されていません。

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
void	decode(MessageContext messageContext) Decodes a message in a binding specific manner.
protected void	extractAssertionArtifactInfo(SAMLMessageContext messageContext, List<AssertionArtifact> artifacts) Extract the issuer, and populate message context, as the relying party corresponding to the first AssertionArtifact in the message.
protected void	extractAttributeQueryInfo(SAMLMessageContext messageContext, AttributeQuery query) Extract the issuer, and populate message context, from the Resource attribute of the Attribute query if useQueryResourceAsEntityId is true.
protected void	extractAuthorizationDecisionQueryInfo(SAMLMessageContext messageContext, AuthorizationDecisionQuery query) Extract the issuer, and populate message context, from the Resource attribute of the AuthorizationDecisionQuery query if useQueryResourceAsEntityId is true.
protected void	extractRequestInfo(SAMLMessageContext messageContext, RequestAbstractType abstractRequest) Extract information from a SAML RequestAbstractType message.
protected void	extractResponseInfo(SAMLMessageContext messageContext, Response response) Extract information from a SAML StatusResponse message.
SAMLArtifactMap	getArtifactMap() Gets the artifact map used to retrieve SAML information from an artifact.
protected String	getIntendedDestinationEndpointURI(SAMLMessageContext samlMsgCtx) Extract the message information which indicates to what receiver endpoint URI the SAML message was intended to be delivered.
boolean	getUseQueryResourceAsEntityId() Gets whether to use the Resource attribute of some SAML 1 queries as the entity ID of the inbound message issuer.
protected void	populateMessageContext(SAMLMessageContext messageContext) Populates the message context with the message ID, issue instant, and issuer as well as the peer's entity descriptor if a metadata provider is present in the message context and the peer's role descriptor if its entity descriptor was retrieved and the message context has a populated peer role name.
protected void	populateMessageIdIssueInstantIssuer(SAMLMessageContext messageContext) Extracts the message ID, issue instant, and issuer from the incoming SAML message and populates the message context with it.
protected void	populateRelyingPartyMetadata(SAMLMessageContext messageContext) Populates the peer's entity metadata if a metadata provide is present in the message context.
void	setUseQueryResourceAsEntityId(boolean useResource) Sets whether to use the Resource attribute of some SAML 1 queries as the entity ID of the inbound message issuer.

クラスから継承されたメソッド org.opensaml.common.binding.decoding.BaseSAMLMessageDecoder

checkEndpointURI, compareEndpointURIs, getActualReceiverEndpointURI, getURIComparator, isIntendedDestinationEndpointURIRequired, isMessageSigned, setURIComparator

クラスから継承されたメソッド org.opensaml.ws.message.decoder.BaseMessageDecoder

doDecode, getParserPool, logDecodedMessage, processSecurityPolicy, setParserPool, unmarshallMessage

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

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

インタフェースから継承されたメソッド org.opensaml.common.binding.decoding.SAMLMessageDecoder

getBindingURI

コンストラクタの詳細

BaseSAML1MessageDecoder

public BaseSAML1MessageDecoder()

Constructor.

BaseSAML1MessageDecoder

public BaseSAML1MessageDecoder(ParserPool pool)

Constructor.

パラメータ:

pool - parser pool used to deserialize messages

BaseSAML1MessageDecoder

public BaseSAML1MessageDecoder(SAMLArtifactMap map)

推奨されていません。

Constructor.

パラメータ:

map - used to map artifacts to SAML

BaseSAML1MessageDecoder

public BaseSAML1MessageDecoder(SAMLArtifactMap map,
                       ParserPool pool)

推奨されていません。

Constructor.

パラメータ:

map - used to map artifacts to SAML

pool - parser pool used to deserialize messages

メソッドの詳細

decode

public void decode(MessageContext messageContext)
            throws MessageDecodingException,
                   SecurityException

Decodes a message in a binding specific manner.

定義:

decode インタフェース内 MessageDecoder

オーバーライド:

decode クラス内 BaseMessageDecoder

パラメータ:

messageContext - current message context

例外:

MessageDecodingException - thrown if the message can not be decoded

SecurityException - thrown if the decoded message does not meet the required security constraints

getArtifactMap

public SAMLArtifactMap getArtifactMap()

Gets the artifact map used to retrieve SAML information from an artifact.

戻り値:

artifact map used to retrieve SAML information from an artifact

getUseQueryResourceAsEntityId

public boolean getUseQueryResourceAsEntityId()

Gets whether to use the Resource attribute of some SAML 1 queries as the entity ID of the inbound message issuer.

戻り値:

whether to use the Resource attribute of some SAML 1 queries as the entity ID of the inbound message issuer

setUseQueryResourceAsEntityId

public void setUseQueryResourceAsEntityId(boolean useResource)

Sets whether to use the Resource attribute of some SAML 1 queries as the entity ID of the inbound message issuer.

パラメータ:

useResource - whether to use the Resource attribute of some SAML 1 queries as the entity ID of the inbound message issuer

populateMessageContext

protected void populateMessageContext(SAMLMessageContext messageContext)
                               throws MessageDecodingException

Populates the message context with the message ID, issue instant, and issuer as well as the peer's entity descriptor if a metadata provider is present in the message context and the peer's role descriptor if its entity descriptor was retrieved and the message context has a populated peer role name.

パラメータ:

messageContext - message context to populate

例外:

MessageDecodingException - thrown if there is a problem populating the message context

populateMessageIdIssueInstantIssuer

protected void populateMessageIdIssueInstantIssuer(SAMLMessageContext messageContext)
                                            throws MessageDecodingException

Extracts the message ID, issue instant, and issuer from the incoming SAML message and populates the message context with it.

パラメータ:

messageContext - current message context

例外:

MessageDecodingException - thrown if there is a problem populating the message context

extractRequestInfo

protected void extractRequestInfo(SAMLMessageContext messageContext,
                      RequestAbstractType abstractRequest)

Extract information from a SAML RequestAbstractType message.

パラメータ:

messageContext - current message context

abstractRequest - the SAML message to process

extractAttributeQueryInfo

protected void extractAttributeQueryInfo(SAMLMessageContext messageContext,
                             AttributeQuery query)

Extract the issuer, and populate message context, from the Resource attribute of the Attribute query if useQueryResourceAsEntityId is true.

パラメータ:

messageContext - current message context

query - query to extract resource name from

extractAuthorizationDecisionQueryInfo

protected void extractAuthorizationDecisionQueryInfo(SAMLMessageContext messageContext,
                                         AuthorizationDecisionQuery query)

Extract the issuer, and populate message context, from the Resource attribute of the AuthorizationDecisionQuery query if useQueryResourceAsEntityId is true.

パラメータ:

messageContext - current message context

query - query to extract resource name from

extractAssertionArtifactInfo

protected void extractAssertionArtifactInfo(SAMLMessageContext messageContext,
                                List<AssertionArtifact> artifacts)

Extract the issuer, and populate message context, as the relying party corresponding to the first AssertionArtifact in the message.

パラメータ:

messageContext - current message context

artifacts - AssertionArtifacts in the request

extractResponseInfo

protected void extractResponseInfo(SAMLMessageContext messageContext,
                       Response response)
                            throws MessageDecodingException

Extract information from a SAML StatusResponse message.

パラメータ:

messageContext - current message context

response - the SAML message to process

例外:

MessageDecodingException - thrown if the assertions within the response contain differening issuer IDs

populateRelyingPartyMetadata

protected void populateRelyingPartyMetadata(SAMLMessageContext messageContext)
                                     throws MessageDecodingException

Populates the peer's entity metadata if a metadata provide is present in the message context. Populates the peer's role descriptor if the entity metadata was available and the role name is present in the message context.

パラメータ:

messageContext - current message context

例外:

MessageDecodingException - thrown if there is a problem populating the message context

getIntendedDestinationEndpointURI

protected String getIntendedDestinationEndpointURI(SAMLMessageContext samlMsgCtx)
                                            throws MessageDecodingException

Extract the message information which indicates to what receiver endpoint URI the SAML message was intended to be delivered.

This SAML 1-specific implementation extracts the value of the ResponseAbstractType protocol message Recipient attribute.

定義:

getIntendedDestinationEndpointURI クラス内 BaseSAMLMessageDecoder

パラメータ:

samlMsgCtx - the SAML message context being processed

戻り値:

the value of the intended destination endpoint URI, or null if not present or empty

例外:

MessageDecodingException - thrown if the message is not an instance of SAML message that could be processed by the decoder