org.opensaml.saml.saml2.binding.encoding.impl

Class HTTPArtifactEncoder

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.saml2.binding.encoding.impl.BaseSAML2MessageEncoder

org.opensaml.saml.saml2.binding.encoding.impl.HTTPArtifactEncoder

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 HTTPArtifactEncoder
extends BaseSAML2MessageEncoder

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

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
HTTPArtifactEncoder() Constructor.

Method Summary

Modifier and Type	Method and Description
protected AbstractSAML2Artifact	buildArtifact(MessageContext<SAMLObject> messageContext) Builds the SAML 2 artifact for the outgoing message.
protected void	doDestroy()
protected void	doEncode() Performs the encoding logic.
protected void	doInitialize()
SAMLArtifactMap	getArtifactMap() Get the SAML artifact map to use.
String	getBindingURI() Gets the SAML binding URI supported by this encoder.
protected void	getEncode() Performs HTTP GET based encoding.
org.apache.velocity.app.VelocityEngine	getVelocityEngine() Get the VelocityEngine instance.
String	getVelocityTemplateId() Get the Velocity template id.
boolean	isPostEncoding() Get whether the encoder will encode the artifact via POST encoding.
protected void	postEncode() Performs HTTP POST based encoding.
void	setArtifactMap(SAMLArtifactMap newArtifactMap) Set the SAML artifact map to use.
void	setPostEncoding(boolean post) Set whether the encoder will encode the artifact via POST encoding.
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.saml2.binding.encoding.impl.BaseSAML2MessageEncoder

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

@Nonnull
 @NotEmpty
public static final String DEFAULT_TEMPLATE_ID

Default template ID.

See Also:

Constant Field Values

Constructor Detail

HTTPArtifactEncoder

public HTTPArtifactEncoder()

Constructor.

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

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

Set 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

getVelocityEngine

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

Get the VelocityEngine instance.

Returns:

return the VelocityEngine instance

setVelocityEngine

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

Set the VelocityEngine instance.

Parameters:

newVelocityEngine - the new VelocityEngine instane

getVelocityTemplateId

@Nonnull
 @NotEmpty
public String getVelocityTemplateId()

Get the Velocity template id.

Defaults to DEFAULT_TEMPLATE_ID.

Returns:

return the Velocity template id

setVelocityTemplateId

public void setVelocityTemplateId(@Nonnull @NotEmpty
                                  String newVelocityTemplateId)

Set the Velocity template id.

Defaults to DEFAULT_TEMPLATE_ID.

Parameters:

newVelocityTemplateId - the new Velocity template id

getArtifactMap

@NonnullAfterInit
public SAMLArtifactMap getArtifactMap()

Get the SAML artifact map to use.

Returns:

the artifactMap.

setArtifactMap

public void setArtifactMap(@Nonnull
                           SAMLArtifactMap newArtifactMap)

Set the SAML artifact map to use.

Parameters:

newArtifactMap - the new artifactMap

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

doDestroy

protected void doDestroy()

Overrides:

doDestroy in class AbstractHttpServletResponseMessageEncoder<SAMLObject>

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()
                   throws MessageEncodingException

Performs HTTP POST based encoding.

Throws:

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

getEncode

protected void getEncode()
                  throws MessageEncodingException

Performs HTTP GET based encoding.

Throws:

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

buildArtifact

@Nonnull
protected AbstractSAML2Artifact buildArtifact(@Nonnull
                                                       MessageContext<SAMLObject> messageContext)
                                                throws MessageEncodingException

Builds the SAML 2 artifact for the outgoing message.

Parameters:

messageContext - current request context

Returns:

SAML 2 artifact for outgoing message

Throws:

MessageEncodingException - thrown if the artifact can not be created