org.opensaml.saml2.binding.encoding

クラス HTTPArtifactEncoder

java.lang.Object

org.opensaml.ws.message.encoder.BaseMessageEncoder

org.opensaml.saml2.binding.encoding.BaseSAML2MessageEncoder

org.opensaml.saml2.binding.encoding.HTTPArtifactEncoder

すべての実装されたインタフェース:

SAMLMessageEncoder, MessageEncoder

public class HTTPArtifactEncoder
extends BaseSAML2MessageEncoder

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

コンストラクタの概要

コンストラクタ

コンストラクタと説明
HTTPArtifactEncoder(org.apache.velocity.app.VelocityEngine engine, String template, SAMLArtifactMap map) Constructor.

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
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.

クラスから継承されたメソッド org.opensaml.saml2.binding.encoding.BaseSAML2MessageEncoder

checkRelayState, getAllowedURLSchemes, getEndpointURL, setAllowedURLSchemes, setResponseDestination, signMessage

クラスから継承されたメソッド org.opensaml.ws.message.encoder.BaseMessageEncoder

encode, logEncodedMessage, marshallMessage

クラスから継承されたメソッド java.lang.Object

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

インタフェースから継承されたメソッド org.opensaml.ws.message.encoder.MessageEncoder

encode

コンストラクタの詳細

HTTPArtifactEncoder

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

Constructor.

パラメータ:

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

メソッドの詳細

getBindingURI

public String getBindingURI()

Gets the SAML binding URI supported by this encoder.

戻り値:

SAML binding URI supported by this encoder

isPostEncoding

public boolean isPostEncoding()

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

戻り値:

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.

パラメータ:

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.

パラメータ:

messageContext - the current message context

戻り値:

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

例外:

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.

パラメータ:

messageContext - the current message context

戻り値:

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

例外:

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.

定義:

doEncode クラス内 BaseMessageEncoder

パラメータ:

messageContext - current message context

例外:

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.

パラメータ:

artifactContext - current request context

outTransport - outbound HTTP transport

例外:

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.

パラメータ:

artifactContext - current request context

outTransport - outbound HTTP transport

例外:

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.

パラメータ:

artifactContext - current request context

戻り値:

SAML 2 artifact for outgoing message

例外:

MessageEncodingException - thrown if the artifact can not be created