org.opensaml.saml2.binding.decoding

クラス BaseSAML2MessageDecoder

java.lang.Object

org.opensaml.ws.message.decoder.BaseMessageDecoder

org.opensaml.common.binding.decoding.BaseSAMLMessageDecoder

org.opensaml.saml2.binding.decoding.BaseSAML2MessageDecoder

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

SAMLMessageDecoder, MessageDecoder

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

HTTPArtifactDecoder, HTTPPostDecoder, HTTPRedirectDeflateDecoder, HTTPSOAP11Decoder, UnsolicitedSSODecoder

public abstract class BaseSAML2MessageDecoder
extends BaseSAMLMessageDecoder

Base class for SAML 2 message decoders.

コンストラクタの概要

コンストラクタ

コンストラクタと説明
BaseSAML2MessageDecoder() Constructor.
BaseSAML2MessageDecoder(ParserPool pool) Constructor.

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
void	decode(MessageContext messageContext) Decodes a message in a binding specific manner.
protected String	extractEntityId(Issuer issuer) Extracts the entity ID from the SAML 2 Issuer.
protected void	extractRequestInfo(SAMLMessageContext messageContext, RequestAbstractType request) Extract information from a SAML RequestAbstractType message.
protected void	extractResponseInfo(SAMLMessageContext messageContext, StatusResponseType statusResponse) Extract information from a SAML StatusResponse message.
protected String	getIntendedDestinationEndpointURI(SAMLMessageContext samlMsgCtx) Extract the message information which indicates to what receiver endpoint URI the SAML message was intended to be delivered.
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.

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

コンストラクタの詳細

BaseSAML2MessageDecoder

public BaseSAML2MessageDecoder()

Constructor.

BaseSAML2MessageDecoder

public BaseSAML2MessageDecoder(ParserPool pool)

Constructor.

パラメータ:

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

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

extractResponseInfo

protected void extractResponseInfo(SAMLMessageContext messageContext,
                       StatusResponseType statusResponse)
                            throws MessageDecodingException

Extract information from a SAML StatusResponse message.

パラメータ:

messageContext - current message context

statusResponse - the SAML message to process

例外:

MessageDecodingException - thrown if the response issuer has a format other than NameIDType.ENTITY or, if the response does not contain an issuer, if the contained assertions contain issuers that are not of NameIDType.ENTITY format or if the assertions contain different issuers

extractRequestInfo

protected void extractRequestInfo(SAMLMessageContext messageContext,
                      RequestAbstractType request)
                           throws MessageDecodingException

Extract information from a SAML RequestAbstractType message.

パラメータ:

messageContext - current message context

request - the SAML message to process

例外:

MessageDecodingException - thrown if the request issuer has a format other than NameIDType.ENTITY

extractEntityId

protected String extractEntityId(Issuer issuer)
                          throws MessageDecodingException

Extracts the entity ID from the SAML 2 Issuer.

パラメータ:

issuer - issuer to extract the entityID from

戻り値:

entity ID of the issuer

例外:

MessageDecodingException - thrown if the given issuer has a format other than NameIDType.ENTITY

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 2-specific implementation extracts the value of the protocol message Destination 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