org.opensaml.ws.message.encoder

Interface MessageEncoder

All Known Subinterfaces:

SAMLMessageEncoder

All Known Implementing Classes:

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.

Method Summary

Methods

Modifier and Type	Method and Description
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.

Method Detail

encode

void encode(MessageContext messageContext)
            throws MessageEncodingException

Encodes the message in the binding specific manner.

Parameters:

messageContext - current message context

Throws:

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.

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

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.