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, org.opensaml.messaging.decoder.MessageDecoder<SAMLObject>, org.opensaml.messaging.decoder.servlet.HttpServletRequestMessageDecoder<SAMLObject>, SAMLMessageDecoder

Direct Known Subclasses:

HTTPPostSimpleSignDecoder

public class HTTPPostDecoder
extends org.opensaml.messaging.decoder.servlet.BaseHttpServletRequestXMLMessageDecoder<SAMLObject>
implements SAMLMessageDecoder

Message decoder implementing the SAML 2.0 HTTP POST binding.

Field Summary

Fields

Modifier and Type	Field and Description
private BindingDescriptor	bindingDescriptor Optional BindingDescriptor to inject into SAMLBindingContext created.
private Logger	log Class logger.

Constructor Summary

Constructors

Constructor and Description
HTTPPostDecoder()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doDecode()
protected InputStream	getBase64DecodedMessage(javax.servlet.http.HttpServletRequest request) Gets the Base64 encoded message from the request and decodes it.
BindingDescriptor	getBindingDescriptor() Get an optional BindingDescriptor to inject into SAMLBindingContext created.
String	getBindingURI()
protected void	populateBindingContext(org.opensaml.messaging.context.MessageContext<SAMLObject> messageContext) Populate the context which carries information specific to this binding.
void	setBindingDescriptor(BindingDescriptor descriptor) Set an optional BindingDescriptor to inject into SAMLBindingContext created.

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

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

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

Field Detail

log

@Nonnull
private final Logger log

Class logger.

bindingDescriptor

@Nullable
private BindingDescriptor bindingDescriptor

Optional BindingDescriptor to inject into SAMLBindingContext created.

Constructor Detail

HTTPPostDecoder

public HTTPPostDecoder()

Method Detail

getBindingURI

@Nonnull
@NotEmpty
public String getBindingURI()

Specified by:

getBindingURI in interface SAMLMessageDecoder

getBindingDescriptor

@Nullable
public BindingDescriptor getBindingDescriptor()

Get an optional BindingDescriptor to inject into SAMLBindingContext created.

Returns:

binding descriptor

setBindingDescriptor

public void setBindingDescriptor(@Nullable
                        BindingDescriptor descriptor)

Set an optional BindingDescriptor to inject into SAMLBindingContext created.

Parameters:

descriptor - a binding descriptor

doDecode

protected void doDecode()
                 throws org.opensaml.messaging.decoder.MessageDecodingException

Specified by:

doDecode in class org.opensaml.messaging.decoder.AbstractMessageDecoder<SAMLObject>

Throws:

org.opensaml.messaging.decoder.MessageDecodingException

getBase64DecodedMessage

protected InputStream getBase64DecodedMessage(javax.servlet.http.HttpServletRequest request)
                                       throws org.opensaml.messaging.decoder.MessageDecodingException

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

Parameters:

request - the inbound HTTP servlet request

Returns:

decoded message

Throws:

org.opensaml.messaging.decoder.MessageDecodingException - thrown if the message does not contain a base64 encoded SAML message

populateBindingContext

protected void populateBindingContext(org.opensaml.messaging.context.MessageContext<SAMLObject> messageContext)

Populate the context which carries information specific to this binding.

Parameters:

messageContext - the current message context