org.opensaml.ws.message.encoder

インタフェース MessageEncoder

既知のサブインタフェースのリスト:

SAMLMessageEncoder

既知の実装クラスのリスト:

BaseHandlerChainAwareMessageEncoder, BaseMessageEncoder, BaseSAML1MessageEncoder, BaseSAML2MessageEncoder, HandlerChainAwareHTTPSOAP11Encoder, HTTPArtifactEncoder, HTTPArtifactEncoder, HTTPPostEncoder, HTTPPostEncoder, HTTPPostSimpleSignEncoder, HTTPRedirectDeflateEncoder, HTTPSOAP11Encoder, HTTPSOAP11Encoder, HTTPSOAP11Encoder, SOAP11Encoder

public interface MessageEncoder

Encodes a message onto the outbound transport. Message encoders MUST must be thread safe and stateless.

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
void	encode(MessageContext messageContext) Encodes the message in the binding specific manner.
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.

メソッドの詳細

encode

void encode(MessageContext messageContext)
            throws MessageEncodingException

Encodes the message in the binding specific manner.

パラメータ:

messageContext - current message context

例外:

MessageEncodingException - thrown if the problem can not be encoded

providesMessageConfidentiality

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

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.