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

Class HTTPPostDecoder

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

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

Direct Known Subclasses:

HTTPPostSimpleSignDecoder

public class HTTPPostDecoder
extends BaseHttpServletRequestXMLMessageDecoder<SAMLObject>
implements SAMLMessageDecoder

Message decoder implementing the SAML 2.0 HTTP POST binding.

Constructor Summary

Constructors

Constructor and Description
HTTPPostDecoder()

Method Summary

Modifier and Type	Method and Description
protected void	doDecode() Performs the decoding logic.
protected InputStream	getBase64DecodedMessage(javax.servlet.http.HttpServletRequest request) Gets the Base64 encoded message from the request and decodes it.
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.

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

HTTPPostDecoder

public HTTPPostDecoder()

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

getBase64DecodedMessage

protected InputStream getBase64DecodedMessage(javax.servlet.http.HttpServletRequest request)
                                       throws MessageDecodingException

Gets the Base64 encoded message from the request and decodes it.

Parameters:

request - the inbound HTTP servlet request

Returns:

decoded message

Throws:

MessageDecodingException - thrown if the message does not contain a base64 encoded SAML message

populateBindingContext

protected void populateBindingContext(MessageContext<SAMLObject> messageContext)

Populate the context which carries information specific to this binding.

Parameters:

messageContext - the current message context