org.opensaml.saml.saml1.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.saml1.binding.encoding.impl.BaseSAML1MessageEncoder

org.opensaml.saml.saml1.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, org.opensaml.messaging.encoder.MessageEncoder<SAMLObject>, org.opensaml.messaging.encoder.servlet.HttpServletResponseMessageEncoder<SAMLObject>, SAMLMessageEncoder

public class HTTPArtifactEncoder
extends BaseSAML1MessageEncoder

SAML 1.X HTTP Artifact message encoder.

Field Summary

Fields

Modifier and Type	Field and Description
private SAMLArtifactMap	artifactMap SAML artifact map used to store created artifacts for later retrival.
private byte[]	defaultArtifactType Default artifact type to use when encoding messages.
private Logger	log Class logger.

Constructor Summary

Constructors

Constructor and Description
HTTPArtifactEncoder() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doDestroy()
protected void	doEncode()
protected void	doInitialize()
SAMLArtifactMap	getArtifactMap() Get the SAML artifact map to use.
String	getBindingURI()
private String	getInboundMessageIssuer(org.opensaml.messaging.context.MessageContext<SAMLObject> messageContext) Get the requester.
private String	getOutboundMessageIssuer(org.opensaml.messaging.context.MessageContext<SAMLObject> messageContext) Get the outbound message issuer.
private byte[]	getSAMLArtifactType(org.opensaml.messaging.context.MessageContext<SAMLObject> messageContext) Get the SAML artifact type from the message context.
void	setArtifactMap(SAMLArtifactMap newArtifactMap) Set the SAML artifact map to use.
private void	storeSAMLArtifactType(org.opensaml.messaging.context.MessageContext<SAMLObject> messageContext, byte[] artifactType) Store the SAML artifact type in the message context.

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

log

@Nonnull
private final Logger log

Class logger.

artifactMap

@NonnullAfterInit
private SAMLArtifactMap artifactMap

SAML artifact map used to store created artifacts for later retrival.

defaultArtifactType

@Nonnull
@NotEmpty
private byte[] defaultArtifactType

Default artifact type to use when encoding messages.

Constructor Detail

HTTPArtifactEncoder

public HTTPArtifactEncoder()

Constructor.

Method Detail

getBindingURI

public String getBindingURI()

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 org.opensaml.messaging.encoder.servlet.AbstractHttpServletResponseMessageEncoder<SAMLObject>

Throws:

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

doDestroy

protected void doDestroy()

Overrides:

doDestroy in class org.opensaml.messaging.encoder.servlet.AbstractHttpServletResponseMessageEncoder<SAMLObject>

doEncode

protected void doEncode()
                 throws org.opensaml.messaging.encoder.MessageEncodingException

Specified by:

doEncode in class org.opensaml.messaging.encoder.AbstractMessageEncoder<SAMLObject>

Throws:

org.opensaml.messaging.encoder.MessageEncodingException

getOutboundMessageIssuer

@Nullable
private String getOutboundMessageIssuer(@Nonnull
                                       org.opensaml.messaging.context.MessageContext<SAMLObject> messageContext)

Get the outbound message issuer.

Parameters:

messageContext - the message context

Returns:

the outbound message issuer

getInboundMessageIssuer

@Nullable
private String getInboundMessageIssuer(@Nonnull
                                      org.opensaml.messaging.context.MessageContext<SAMLObject> messageContext)

Get the requester.

Parameters:

messageContext - the message context

Returns:

the requester

storeSAMLArtifactType

private void storeSAMLArtifactType(@Nonnull
                         org.opensaml.messaging.context.MessageContext<SAMLObject> messageContext,
                         @Nonnull@NotEmpty
                         byte[] artifactType)

Store the SAML artifact type in the message context.

Parameters:

messageContext - the message context

artifactType - the artifact type to store

getSAMLArtifactType

@Nullable
private byte[] getSAMLArtifactType(@Nonnull
                                  org.opensaml.messaging.context.MessageContext<SAMLObject> messageContext)

Get the SAML artifact type from the message context.

Parameters:

messageContext - the message context

Returns:

the artifact type