org.opensaml.saml1.binding.encoding

Class HTTPPostEncoder

java.lang.Object

org.opensaml.ws.message.encoder.BaseMessageEncoder

org.opensaml.saml1.binding.encoding.BaseSAML1MessageEncoder

org.opensaml.saml1.binding.encoding.HTTPPostEncoder

All Implemented Interfaces:

SAMLMessageEncoder, MessageEncoder

public class HTTPPostEncoder
extends BaseSAML1MessageEncoder

SAML 1.X HTTP POST message encoder.

Constructor Summary

Constructors

Constructor and Description
HTTPPostEncoder(org.apache.velocity.app.VelocityEngine engine, String templateId) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doEncode(MessageContext messageContext) Encodes the outbound message onto the outbound transport.
String	getBindingURI() Gets the SAML binding URI supported by this encoder.
protected void	postEncode(SAMLMessageContext messageContext, String endpointURL) Base64 and POST encodes the outbound message and writes it to the outbound transport.
boolean	providesMessageConfidentiality(MessageContext messageContext) Indicates whether this encoder, given the current message context, provides end-to-end message confidentiality.
boolean	providesMessageIntegrity(MessageContext messageContext) Indicates whether this encoder, given the current message context, provides end-to-end message integrity.

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

getAllowedURLSchemes, getEndpointURL, setAllowedURLSchemes, signMessage

Methods inherited from class org.opensaml.ws.message.encoder.BaseMessageEncoder

encode, logEncodedMessage, marshallMessage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensaml.ws.message.encoder.MessageEncoder

encode

Constructor Detail

HTTPPostEncoder

public HTTPPostEncoder(org.apache.velocity.app.VelocityEngine engine,
               String templateId)

Constructor.

Parameters:

engine - velocity engine instance used to create POST body

templateId - ID of the template used to create POST body

Method Detail

getBindingURI

public String getBindingURI()

Gets the SAML binding URI supported by this encoder.

Returns:

SAML binding URI supported by this encoder

providesMessageConfidentiality

public boolean providesMessageConfidentiality(MessageContext messageContext)
                                       throws MessageEncodingException

Indicates whether this encoder, given the current message context, provides end-to-end message confidentiality.

Parameters:

messageContext - the current message context

Returns:

true if the encoder provides end-to-end message confidentiality, false if not

Throws:

MessageEncodingException - thrown if the encoder encounter an error while attempt to evaluate its ability to provide message confidentiality.

providesMessageIntegrity

public boolean providesMessageIntegrity(MessageContext messageContext)
                                 throws MessageEncodingException

Indicates whether this encoder, given the current message context, provides end-to-end message integrity.

Parameters:

messageContext - the current message context

Returns:

true if the encoder provides end-to-end message integrity, false if not

Throws:

MessageEncodingException - thrown if the encoder encounter an error while attempt to evaluate its ability to provide message integrity.

doEncode

protected void doEncode(MessageContext messageContext)
                 throws MessageEncodingException

Encodes the outbound message onto the outbound transport.

Specified by:

doEncode in class BaseMessageEncoder

Parameters:

messageContext - current message context

Throws:

MessageEncodingException - thrown if there is a problem encoding the message

postEncode

protected void postEncode(SAMLMessageContext 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