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

Class HTTPPostDecoder

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

org.opensaml.messaging.decoder.AbstractMessageDecoder

org.opensaml.messaging.decoder.servlet.AbstractHttpServletRequestMessageDecoder

org.opensaml.messaging.decoder.servlet.BaseHttpServletRequestXMLMessageDecoder

org.opensaml.saml.common.binding.impl.BaseSAMLHttpServletRequestDecoder

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

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, UnmodifiableComponent, MessageDecoder, HttpServletRequestMessageDecoder, SAMLMessageDecoder

Direct Known Subclasses:

HTTPPostSimpleSignDecoder

public class HTTPPostDecoder
extends BaseSAMLHttpServletRequestDecoder
implements SAMLMessageDecoder

Message decoder implementing the SAML 2.0 HTTP POST binding.

Field Summary

Fields

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

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

BASE_PROTOCOL_MESSAGE_LOGGER_CATEGORY

Constructor Summary

Constructors

Constructor	Description
HTTPPostDecoder()

Method Summary

Modifier and Type	Method	Description
protected void	doDecode()	Performs the decoding logic.
protected InputStream	getBase64DecodedMessage(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()	Gets the SAML binding URI supported by this decoder.
protected void	populateBindingContext(MessageContext 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, doInitialize, getParserPool, serializeMessageForLogging, setParserPool, unmarshallMessage, validateHttpRequest

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

getHttpServletRequest, getHttpServletRequestSupplier, setHttpServletRequestSupplier

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

getMessageContext, getMessageToLog, getProtocolMessageLogger, getProtocolMessageLoggerSubCategory, logDecodedMessage, setMessageContext, setProtocolMessageLoggerSubCategory

Methods inherited from class net.shibboleth.shared.component.AbstractInitializableComponent

checkComponentActive, checkSetterPreconditions, destroy, doDestroy, ifDestroyedThrowDestroyedComponentException, ifInitializedThrowUnmodifiabledComponentException, ifNotInitializedThrowUninitializedComponentException, 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 net.shibboleth.shared.component.DestructableComponent

destroy, isDestroyed

Methods inherited from interface net.shibboleth.shared.component.InitializableComponent

initialize, isInitialized

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

decode, getMessageContext

Field Details

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

bindingDescriptor

@Nullable
private BindingDescriptor bindingDescriptor

Optional BindingDescriptor to inject into SAMLBindingContext created.

Constructor Details

HTTPPostDecoder

public HTTPPostDecoder()

Method Details

getBindingURI

@Nonnull
@NotEmpty
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

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

Throws:

MessageDecodingException - thrown if there is a problem decoding the message

getBase64DecodedMessage

@Nonnull
protected InputStream getBase64DecodedMessage(@Nonnull
 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, or the message can not be base64-decoded.

populateBindingContext

protected void populateBindingContext(@Nonnull
 MessageContext messageContext)

Populate the context which carries information specific to this binding.

Parameters:

messageContext - the current message context