org.opensaml.saml1.binding.decoding

Class HTTPArtifactDecoder

java.lang.Object

org.opensaml.ws.message.decoder.BaseMessageDecoder

org.opensaml.common.binding.decoding.BaseSAMLMessageDecoder

org.opensaml.saml1.binding.decoding.BaseSAML1MessageDecoder

org.opensaml.saml1.binding.decoding.HTTPArtifactDecoder

All Implemented Interfaces:

SAMLMessageDecoder, MessageDecoder

public class HTTPArtifactDecoder
extends BaseSAML1MessageDecoder

SAML 1.X HTTP Artifact message decoder. NOTE: This decoder is not yet implemented.

Constructor Summary

Constructors

Constructor and Description
HTTPArtifactDecoder(SAMLArtifactMap map, ParserPool pool) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	decodeTarget(SAMLMessageContext samlMsgCtx) Decodes the TARGET parameter and adds it to the message context.
protected void	doDecode(MessageContext messageContext) Decodes a message, updating the message context.
String	getBindingURI() Gets the SAML binding URI supported by this decoder.
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 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 void	processArtifacts(SAMLMessageContext samlMsgCtx) Process the incoming artifacts by decoding the artifacts, dereferencing them from the artifact source and storing the resulting response (with assertions) in the message context.

Methods inherited from class org.opensaml.saml1.binding.decoding.BaseSAML1MessageDecoder

decode, extractAssertionArtifactInfo, extractAttributeQueryInfo, extractAuthorizationDecisionQueryInfo, extractRequestInfo, extractResponseInfo, getArtifactMap, getUseQueryResourceAsEntityId, populateMessageContext, populateMessageIdIssueInstantIssuer, populateRelyingPartyMetadata, setUseQueryResourceAsEntityId

Methods inherited from class org.opensaml.common.binding.decoding.BaseSAMLMessageDecoder

checkEndpointURI, compareEndpointURIs, getActualReceiverEndpointURI, getURIComparator, isMessageSigned, setURIComparator

Methods inherited from class org.opensaml.ws.message.decoder.BaseMessageDecoder

getParserPool, logDecodedMessage, processSecurityPolicy, setParserPool, unmarshallMessage

Methods inherited from class java.lang.Object

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

Constructor Detail

HTTPArtifactDecoder

public HTTPArtifactDecoder(SAMLArtifactMap map,
                   ParserPool pool)

Constructor.

Parameters:

map - used to map artifacts to SAML

pool - parser pool used to deserialize messages

Method Detail

getBindingURI

public String getBindingURI()

Gets the SAML binding URI supported by this decoder.

Returns:

SAML binding URI supported by this decoder

doDecode

protected void doDecode(MessageContext messageContext)
                 throws MessageDecodingException

Decodes a message, updating the message context. Security policy evaluation is handled outside this method.

Specified by:

doDecode in class BaseMessageDecoder

Parameters:

messageContext - current message context

Throws:

MessageDecodingException - thrown if there is a problem decoding the message

decodeTarget

protected void decodeTarget(SAMLMessageContext samlMsgCtx)
                     throws MessageDecodingException

Decodes the TARGET parameter and adds it to the message context.

Parameters:

samlMsgCtx - current message context

Throws:

MessageDecodingException - thrown if there is a problem decoding the TARGET parameter.

processArtifacts

protected void processArtifacts(SAMLMessageContext samlMsgCtx)
                         throws MessageDecodingException

Process the incoming artifacts by decoding the artifacts, dereferencing them from the artifact source and storing the resulting response (with assertions) in the message context.

Parameters:

samlMsgCtx - current message context

Throws:

MessageDecodingException - thrown if there is a problem decoding or dereferencing the artifacts

isIntendedDestinationEndpointURIRequired

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

Specified by:

isIntendedDestinationEndpointURIRequired in class BaseSAMLMessageDecoder

Parameters:

samlMsgCtx - current SAML message context

Returns:

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

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.

Overrides:

getIntendedDestinationEndpointURI in class BaseSAML1MessageDecoder

Parameters:

samlMsgCtx - the SAML message context being processed

Returns:

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

Throws:

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