org.opensaml.saml2.binding.encoding

Class HTTPArtifactEncoder

java.lang.Object

org.opensaml.ws.message.encoder.BaseMessageEncoder

org.opensaml.saml2.binding.encoding.BaseSAML2MessageEncoder

org.opensaml.saml2.binding.encoding.HTTPArtifactEncoder

All Implemented Interfaces:

SAMLMessageEncoder, MessageEncoder

public class HTTPArtifactEncoder
extends BaseSAML2MessageEncoder

SAML 2 Artifact Binding encoder, support both HTTP GET and POST.

Constructor Summary

Constructors

Constructor and Description
HTTPArtifactEncoder(org.apache.velocity.app.VelocityEngine engine, String template, SAMLArtifactMap map) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected AbstractSAML2Artifact	buildArtifact(SAMLMessageContext artifactContext) Builds the SAML 2 artifact for the outgoing message.
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	getEncode(SAMLMessageContext artifactContext, HTTPOutTransport outTransport) Performs HTTP GET based encoding.
boolean	isPostEncoding() Gets whether the encoder will encode the artifact via POST encoding.
protected void	postEncode(SAMLMessageContext artifactContext, HTTPOutTransport outTransport) Performs HTTP POST based encoding.
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.
void	setPostEncoding(boolean post) Sets whether the encoder will encode the artifact via POST encoding.

Methods inherited from class org.opensaml.saml2.binding.encoding.BaseSAML2MessageEncoder

checkRelayState, getAllowedURLSchemes, getEndpointURL, setAllowedURLSchemes, setResponseDestination, 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

HTTPArtifactEncoder

public HTTPArtifactEncoder(org.apache.velocity.app.VelocityEngine engine,
                   String template,
                   SAMLArtifactMap map)

Constructor.

Parameters:

engine - velocity engine used to construct the POST form

template - ID of velocity template used to construct the POST form

map - artifact map used to store artifact/message bindings

Method Detail

getBindingURI

public String getBindingURI()

Gets the SAML binding URI supported by this encoder.

Returns:

SAML binding URI supported by this encoder

isPostEncoding

public boolean isPostEncoding()

Gets whether the encoder will encode the artifact via POST encoding.

Returns:

true if POST encoding will be used, false if GET encoding will be used

setPostEncoding

public void setPostEncoding(boolean post)

Sets whether the encoder will encode the artifact via POST encoding.

Parameters:

post - true if POST encoding will be used, false if GET encoding will be used

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 artifactContext,
              HTTPOutTransport outTransport)
                   throws MessageEncodingException

Performs HTTP POST based encoding.

Parameters:

artifactContext - current request context

outTransport - outbound HTTP transport

Throws:

MessageEncodingException - thrown if there is a problem POST encoding the artifact

getEncode

protected void getEncode(SAMLMessageContext artifactContext,
             HTTPOutTransport outTransport)
                  throws MessageEncodingException

Performs HTTP GET based encoding.

Parameters:

artifactContext - current request context

outTransport - outbound HTTP transport

Throws:

MessageEncodingException - thrown if there is a problem GET encoding the artifact

buildArtifact

protected AbstractSAML2Artifact buildArtifact(SAMLMessageContext artifactContext)
                                       throws MessageEncodingException

Builds the SAML 2 artifact for the outgoing message.

Parameters:

artifactContext - current request context

Returns:

SAML 2 artifact for outgoing message

Throws:

MessageEncodingException - thrown if the artifact can not be created