org.opensaml.saml.saml2.binding.decoding.impl

Class HTTPArtifactDecoder

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

org.opensaml.messaging.decoder.AbstractMessageDecoder<MessageType>

org.opensaml.messaging.decoder.servlet.AbstractHttpServletRequestMessageDecoder<MessageType>

org.opensaml.messaging.decoder.servlet.BaseHttpServletRequestXMLMessageDecoder<SAMLObject>

org.opensaml.saml.saml2.binding.decoding.impl.HTTPArtifactDecoder

All Implemented Interfaces:

net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.InitializableComponent, net.shibboleth.utilities.java.support.component.UnmodifiableComponent, MessageDecoder<SAMLObject>, HttpServletRequestMessageDecoder<SAMLObject>, SAMLMessageDecoder

public class HTTPArtifactDecoder
extends BaseHttpServletRequestXMLMessageDecoder<SAMLObject>
implements SAMLMessageDecoder

SAML 2 Artifact Binding decoder, support both HTTP GET and POST. NOTE: This decoder is not yet implemented.

Constructor Summary

Constructors

Constructor and Description
HTTPArtifactDecoder()

Method Summary

Modifier and Type	Method and Description
protected void	doDecode() Performs the decoding logic.
String	getBindingURI() Gets the SAML binding URI supported by this decoder.
protected void	populateBindingContext(MessageContext<SAMLObject> messageContext) Populate the context which carries information specific to this binding.
protected void	processArtifact(MessageContext messageContext, javax.servlet.http.HttpServletRequest request) Process the incoming artifact by decoding the artifacts, dereferencing it from the artifact issuer and storing the resulting protocol message in the message context.

Methods inherited from class org.opensaml.messaging.decoder.servlet.BaseHttpServletRequestXMLMessageDecoder

decode, doDestroy, doInitialize, getMessageToLog, getParserPool, logDecodedMessage, setParserPool, unmarshallMessage

Methods inherited from class org.opensaml.messaging.decoder.servlet.AbstractHttpServletRequestMessageDecoder

getHttpServletRequest, setHttpServletRequest

Methods inherited from class org.opensaml.messaging.decoder.AbstractMessageDecoder

getMessageContext, setMessageContext

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensaml.messaging.decoder.MessageDecoder

decode, getMessageContext

Methods inherited from interface net.shibboleth.utilities.java.support.component.InitializableComponent

initialize, isInitialized

Methods inherited from interface net.shibboleth.utilities.java.support.component.DestructableComponent

destroy, isDestroyed

Constructor Detail

HTTPArtifactDecoder

public HTTPArtifactDecoder()

Method Detail

getBindingURI

public String getBindingURI()

Gets the SAML binding URI supported by this decoder.

Specified by:

getBindingURI in interface SAMLMessageDecoder

Returns:

SAML binding URI supported by this decoder

doDecode

protected void doDecode()
                 throws MessageDecodingException

Performs the decoding logic. By the time this is called, this decoder has already been initialized and checked to ensure that it has not been destroyed.

Specified by:

doDecode in class AbstractMessageDecoder<SAMLObject>

Throws:

MessageDecodingException - thrown if there is a problem decoding the message

processArtifact

protected void processArtifact(MessageContext messageContext,
                               javax.servlet.http.HttpServletRequest request)
                        throws MessageDecodingException

Process the incoming artifact by decoding the artifacts, dereferencing it from the artifact issuer and storing the resulting protocol message in the message context.

Parameters:

messageContext - the message context being processed

request - the HTTP servlet request

Throws:

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

populateBindingContext

protected void populateBindingContext(MessageContext<SAMLObject> messageContext)

Populate the context which carries information specific to this binding.

Parameters:

messageContext - the current message context