org.opensaml.common.binding.decoding

クラス BaseSAMLMessageDecoder

java.lang.Object

org.opensaml.ws.message.decoder.BaseMessageDecoder

org.opensaml.common.binding.decoding.BaseSAMLMessageDecoder

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

SAMLMessageDecoder, MessageDecoder

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

BaseSAML1MessageDecoder, BaseSAML2MessageDecoder

public abstract class BaseSAMLMessageDecoder
extends BaseMessageDecoder
implements SAMLMessageDecoder

Base class for all SAML message decoders.

コンストラクタの概要

コンストラクタ

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

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
protected void	checkEndpointURI(SAMLMessageContext messageContext) Check the validity of the SAML protocol message receiver endpoint against requirements indicated in the message.
protected boolean	compareEndpointURIs(String messageDestination, String receiverEndpoint) Compare the message endpoint URI's specified.
protected String	getActualReceiverEndpointURI(SAMLMessageContext messageContext) Extract the transport endpoint at which this message was received.
protected abstract String	getIntendedDestinationEndpointURI(SAMLMessageContext samlMsgCtx) Extract the message information which indicates to what receiver endpoint URI the SAML message was intended to be delivered.
URIComparator	getURIComparator() Get the URIComparator to use in compareEndpointURIs(String, String).
protected abstract boolean	isIntendedDestinationEndpointURIRequired(SAMLMessageContext samlMsgCtx) Determine whether the binding implemented by the decoder requires the presence within the message of information indicating the intended message destination endpoint URI.
protected boolean	isMessageSigned(SAMLMessageContext messageContext) Determine whether the SAML message represented by the message context is digitally signed.
void	setURIComparator(URIComparator comparator) Set the URIComparator to use in compareEndpointURIs(String, String).

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

decode, 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

インタフェースから継承されたメソッド org.opensaml.ws.message.decoder.MessageDecoder

decode

コンストラクタの詳細

BaseSAMLMessageDecoder

public BaseSAMLMessageDecoder()

Constructor.

BaseSAMLMessageDecoder

public BaseSAMLMessageDecoder(ParserPool pool)

Constructor.

パラメータ:

pool - parser pool used to deserialize messages

メソッドの詳細

setURIComparator

public void setURIComparator(URIComparator comparator)

Set the URIComparator to use in compareEndpointURIs(String, String).

パラメータ:

comparator - The uriComparator to set.

getURIComparator

public URIComparator getURIComparator()

Get the URIComparator to use in compareEndpointURIs(String, String).

戻り値:

Returns the uriComparator.

isMessageSigned

protected boolean isMessageSigned(SAMLMessageContext messageContext)

Determine whether the SAML message represented by the message context is digitally signed.

The default behavior is to examine whether an XML signature is present on the SAML protocol message. Subclasses may augment or replace with binding-specific behavior.

パラメータ:

messageContext - current message context

戻り値:

true if the message is considered to be digitially signed, false otherwise

isIntendedDestinationEndpointURIRequired

protected abstract boolean isIntendedDestinationEndpointURIRequired(SAMLMessageContext samlMsgCtx)

Determine whether the binding implemented by the decoder requires the presence within the message of information indicating the intended message destination endpoint URI.

パラメータ:

samlMsgCtx - current SAML message context

戻り値:

true if the intended message destination endpoint is required, false if not

getIntendedDestinationEndpointURI

protected abstract 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.

パラメータ:

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

getActualReceiverEndpointURI

protected String getActualReceiverEndpointURI(SAMLMessageContext messageContext)
                                       throws MessageDecodingException

Extract the transport endpoint at which this message was received.

This default implementation assumes an underlying message context InTransport type of HttpServletRequestAdapter and returns the string representation of the underlying request URL as constructed via HttpServletRequest.getRequestURL().

Subclasses should override if binding-specific behavior or support for other transport typs is required. In this case, see also compareEndpointURIs(String, String).

パラメータ:

messageContext - current message context

戻り値:

string representing the transport endpoint URI at which the current message was received

例外:

MessageDecodingException - thrown if the endpoint can not be extracted from the message context and converted to a string representation

compareEndpointURIs

protected boolean compareEndpointURIs(String messageDestination,
                          String receiverEndpoint)
                               throws MessageDecodingException

Compare the message endpoint URI's specified.

The comparison is performed using the configured instance of URIComparator. By default, the URL subtype of URI is supported, and the default comparator implementation used is BasicURLComparator. Other types of URI's may be supported by configuring a different implementation of URIComparator.

Subclasses should override if binding-specific behavior is required. In this case, see also getActualReceiverEndpointURI(SAMLMessageContext).

パラメータ:

messageDestination - the intended message destination endpoint URI

receiverEndpoint - the endpoint URI at which the message was received

戻り値:

true if the endpoints are equivalent, false otherwise

例外:

MessageDecodingException - thrown if the endpoints specified are not equivalent

checkEndpointURI

protected void checkEndpointURI(SAMLMessageContext messageContext)
                         throws SecurityException,
                                MessageDecodingException

Check the validity of the SAML protocol message receiver endpoint against requirements indicated in the message.

パラメータ:

messageContext - current message context

例外:

SecurityException - thrown if the message Destination attribute is invalid with respect to the receiver's endpoint

MessageDecodingException - thrown if there is a problem decoding and processing the message Destination or receiver endpoint information