org.opensaml.saml.saml1.binding.encoding.impl

Class HTTPPostEncoder

java.lang.Object

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

org.opensaml.messaging.encoder.AbstractMessageEncoder<MessageType>

org.opensaml.messaging.encoder.servlet.AbstractHttpServletResponseMessageEncoder<MessageType>

org.opensaml.messaging.encoder.servlet.BaseHttpServletResponseXMLMessageEncoder<SAMLObject>

org.opensaml.saml.saml1.binding.encoding.impl.BaseSAML1MessageEncoder

org.opensaml.saml.saml1.binding.encoding.impl.HTTPPostEncoder

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, MessageEncoder<SAMLObject>, HttpServletResponseMessageEncoder<SAMLObject>, SAMLMessageEncoder

public class HTTPPostEncoder
extends BaseSAML1MessageEncoder

SAML 1.X HTTP POST message encoder.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_TEMPLATE_ID Default template ID.

Constructor Summary

Constructors

Constructor and Description
HTTPPostEncoder() Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	doDestroy()
protected void	doEncode() Performs the encoding logic.
protected void	doInitialize()
String	getBindingURI() Gets the SAML binding URI supported by this encoder.
org.apache.velocity.app.VelocityEngine	getVelocityEngine() Get the VelocityEngine instance.
String	getVelocityTemplateId() Get the Velocity template id.
protected void	postEncode(MessageContext<SAMLObject> messageContext, String endpointURL) Base64 and POST encodes the outbound message and writes it to the outbound transport.
void	setVelocityEngine(org.apache.velocity.app.VelocityEngine newVelocityEngine) Set the VelocityEngine instance.
void	setVelocityTemplateId(String newVelocityTemplateId) Set the Velocity template id.

Methods inherited from class org.opensaml.saml.saml1.binding.encoding.impl.BaseSAML1MessageEncoder

getEndpointURL

Methods inherited from class org.opensaml.messaging.encoder.servlet.BaseHttpServletResponseXMLMessageEncoder

encode, getMessageToLog, logEncodedMessage, marshallMessage

Methods inherited from class org.opensaml.messaging.encoder.servlet.AbstractHttpServletResponseMessageEncoder

getHttpServletResponse, setHttpServletResponse

Methods inherited from class org.opensaml.messaging.encoder.AbstractMessageEncoder

getMessageContext, prepareContext, 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.encoder.MessageEncoder

encode, prepareContext, setMessageContext

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

DEFAULT_TEMPLATE_ID

public static final String DEFAULT_TEMPLATE_ID

Default template ID.

See Also:

Constant Field Values

Constructor Detail

HTTPPostEncoder

public HTTPPostEncoder()

Constructor.

Method Detail

getBindingURI

public String getBindingURI()

Gets the SAML binding URI supported by this encoder.

Returns:

SAML binding URI supported by this encoder

getVelocityEngine

public org.apache.velocity.app.VelocityEngine getVelocityEngine()

Get the VelocityEngine instance.

Returns:

return the VelocityEngine instance

setVelocityEngine

public void setVelocityEngine(org.apache.velocity.app.VelocityEngine newVelocityEngine)

Set the VelocityEngine instance.

Parameters:

newVelocityEngine - the new VelocityEngine instane

getVelocityTemplateId

public String getVelocityTemplateId()

Get the Velocity template id.

Defaults to DEFAULT_TEMPLATE_ID.

Returns:

return the Velocity template id

setVelocityTemplateId

public void setVelocityTemplateId(String newVelocityTemplateId)

Set the Velocity template id.

Defaults to DEFAULT_TEMPLATE_ID.

Parameters:

newVelocityTemplateId - the new Velocity template id

doDestroy

protected void doDestroy()

Overrides:

doDestroy in class AbstractHttpServletResponseMessageEncoder<SAMLObject>

doInitialize

protected void doInitialize()
                     throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Overrides:

doInitialize in class AbstractHttpServletResponseMessageEncoder<SAMLObject>

Throws:

net.shibboleth.utilities.java.support.component.ComponentInitializationException

doEncode

protected void doEncode()
                 throws MessageEncodingException

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

Specified by:

doEncode in class AbstractMessageEncoder<SAMLObject>

Throws:

MessageEncodingException - thrown if there is a problem encoding the message

postEncode

protected void postEncode(MessageContext<SAMLObject> messageContext,
                          String endpointURL)
                   throws MessageEncodingException

Base64 and POST encodes the outbound message and writes it to the outbound transport.

Parameters:

messageContext - current message context

endpointURL - endpoint URL to encode message to

Throws:

MessageEncodingException - thrown if there is a problem encoding the message