net.shibboleth.idp.saml.saml2.profile.delegation.messaging.impl

Class LibertyHTTPSOAP11Decoder

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<org.opensaml.saml.common.SAMLObject>

net.shibboleth.idp.saml.saml2.profile.delegation.messaging.impl.LibertyHTTPSOAP11Decoder

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, UnmodifiableComponent, org.opensaml.messaging.decoder.MessageDecoder<org.opensaml.saml.common.SAMLObject>, org.opensaml.messaging.decoder.servlet.HttpServletRequestMessageDecoder<org.opensaml.saml.common.SAMLObject>, org.opensaml.saml.common.binding.decoding.SAMLMessageDecoder

public class LibertyHTTPSOAP11Decoder
extends org.opensaml.messaging.decoder.servlet.BaseHttpServletRequestXMLMessageDecoder<org.opensaml.saml.common.SAMLObject>
implements org.opensaml.saml.common.binding.decoding.SAMLMessageDecoder

Decoder for Liberty ID-WSF 2.0 SOAP 1.1 HTTP binding carrying SAML protocol messages used in SAML delegation.

This decoder takes a mandatory MessageHandler instance which is used to determine and populate the message that is returned as the MessageContext.getMessage().

A SOAP message-oriented message exchange style might just populate the Envelope as the message. An application-specific payload-oriented message exchange would handle a specific type of payload structure.

Field Summary

Fields

Modifier and Type	Field and Description
private org.opensaml.saml.common.binding.BindingDescriptor	bindingDescriptor Optional BindingDescriptor to inject into SAMLBindingContext created.
private org.opensaml.messaging.handler.MessageHandler<org.opensaml.saml.common.SAMLObject>	bodyHandler Message handler to use in processing the message body.
private org.slf4j.Logger	log Class logger.

Constructor Summary

Constructors

Constructor and Description
LibertyHTTPSOAP11Decoder() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doDecode()
protected void	doInitialize()
org.opensaml.saml.common.binding.BindingDescriptor	getBindingDescriptor() Get an optional BindingDescriptor to inject into SAMLBindingContext created.
String	getBindingURI()
org.opensaml.messaging.handler.MessageHandler<org.opensaml.saml.common.SAMLObject>	getBodyHandler() Get the configured body handler MessageHandler.
protected org.opensaml.core.xml.XMLObject	getMessageToLog()
protected void	populateBindingContext(org.opensaml.messaging.context.MessageContext<org.opensaml.saml.common.SAMLObject> messageContext) Populate the context which carries information specific to this binding.
void	setBindingDescriptor(org.opensaml.saml.common.binding.BindingDescriptor descriptor) Set an optional BindingDescriptor to inject into SAMLBindingContext created.
void	setBodyHandler(org.opensaml.messaging.handler.MessageHandler<org.opensaml.saml.common.SAMLObject> newBodyHandler) Set the configured body handler MessageHandler.

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

decode, doDestroy, 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 org.slf4j.Logger log

Class logger.

bindingDescriptor

@Nullable
private org.opensaml.saml.common.binding.BindingDescriptor bindingDescriptor

Optional BindingDescriptor to inject into SAMLBindingContext created.

bodyHandler

private org.opensaml.messaging.handler.MessageHandler<org.opensaml.saml.common.SAMLObject> bodyHandler

Message handler to use in processing the message body.

Constructor Detail

LibertyHTTPSOAP11Decoder

public LibertyHTTPSOAP11Decoder()

Constructor.

Method Detail

getBindingURI

@Nonnull
@NotEmpty
public String getBindingURI()

Specified by:

getBindingURI in interface org.opensaml.saml.common.binding.decoding.SAMLMessageDecoder

getBindingDescriptor

@Nullable
public org.opensaml.saml.common.binding.BindingDescriptor getBindingDescriptor()

Get an optional BindingDescriptor to inject into SAMLBindingContext created.

Returns:

binding descriptor

setBindingDescriptor

public void setBindingDescriptor(@Nullable
                        org.opensaml.saml.common.binding.BindingDescriptor descriptor)

Set an optional BindingDescriptor to inject into SAMLBindingContext created.

Parameters:

descriptor - a binding descriptor

getBodyHandler

public org.opensaml.messaging.handler.MessageHandler<org.opensaml.saml.common.SAMLObject> getBodyHandler()

Get the configured body handler MessageHandler.

Returns:

Returns the bodyHandler.

setBodyHandler

public void setBodyHandler(org.opensaml.messaging.handler.MessageHandler<org.opensaml.saml.common.SAMLObject> newBodyHandler)

Set the configured body handler MessageHandler.

Parameters:

newBodyHandler - The bodyHandler to set.

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class org.opensaml.messaging.decoder.servlet.BaseHttpServletRequestXMLMessageDecoder<org.opensaml.saml.common.SAMLObject>

Throws:

ComponentInitializationException

doDecode

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

Specified by:

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

Throws:

org.opensaml.messaging.decoder.MessageDecodingException

populateBindingContext

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

Populate the context which carries information specific to this binding.

Parameters:

messageContext - the current message context

getMessageToLog

protected org.opensaml.core.xml.XMLObject getMessageToLog()

Overrides:

getMessageToLog in class org.opensaml.messaging.decoder.servlet.BaseHttpServletRequestXMLMessageDecoder<org.opensaml.saml.common.SAMLObject>