org.opensaml.saml2.binding.encoding

Class HandlerChainAwareHTTPSOAP11Encoder

java.lang.Object

org.opensaml.ws.message.encoder.BaseMessageEncoder

org.opensaml.saml2.binding.encoding.BaseSAML2MessageEncoder

org.opensaml.saml2.binding.encoding.HandlerChainAwareHTTPSOAP11Encoder

All Implemented Interfaces:

SAMLMessageEncoder, MessageEncoder, HandlerChainAware

public class HandlerChainAwareHTTPSOAP11Encoder
extends BaseSAML2MessageEncoder
implements HandlerChainAware

Constructor Summary

Constructors

Constructor and Description
HandlerChainAwareHTTPSOAP11Encoder() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doEncode(MessageContext messageContext) Encodes the outbound message onto the outbound transport.
protected void	encodeToTransport(MessageContext messageContext) Encode the message context to the transport.
String	getBindingURI() Gets the SAML binding URI supported by this encoder.
protected void	invokeHandlerChain(HandlerChain handlerChain, MessageContext messageContext) Invoke a handler chain on the specified message context.
boolean	isNotConfidential() Returns confidentiality override flag.
protected void	prepareMessageContext(MessageContext messageContext) Perform final binding-specific processing of message context and prepare it for encoding to the transport.
protected void	preprocessTransport(MessageContext messageContext) This implementation performs the following actions on the context's HTTPOutTransport: Adds the HTTP header: "Cache-control: no-cache, no-store" Adds the HTTP header: "Pragma: no-cache" Sets the character encoding to: "UTF-8" Sets the content type to: "text/xml" Sets the SOAPAction HTTP header
protected void	processOutboundHandlerChain(MessageContext messageContext) Process the outbound HandlerChain for the message context, if any.
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	setNotConfidential(boolean flag) Sets confidentiality override flag.

Methods inherited from class org.opensaml.saml2.binding.encoding.BaseSAML2MessageEncoder

checkRelayState, getAllowedURLSchemes, getEndpointURL, setAllowedURLSchemes, setResponseDestination, signMessage

Methods inherited from class org.opensaml.ws.message.encoder.BaseMessageEncoder

encode, logEncodedMessage, marshallMessage

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensaml.ws.message.encoder.MessageEncoder

encode

Constructor Detail

HandlerChainAwareHTTPSOAP11Encoder

public HandlerChainAwareHTTPSOAP11Encoder()

Constructor.

Method Detail

isNotConfidential

public boolean isNotConfidential()

Returns confidentiality override flag.

Returns:

true iff the encoder cannot provide confidentiality

setNotConfidential

public void setNotConfidential(boolean flag)

Sets confidentiality override flag.

Parameters:

flag - override flag

getBindingURI

public String getBindingURI()

Gets the SAML binding URI supported by this encoder.

Specified by:

getBindingURI in interface SAMLMessageEncoder

Returns:

SAML binding URI supported by this encoder

providesMessageConfidentiality

public boolean providesMessageConfidentiality(MessageContext messageContext)
                                       throws MessageEncodingException

Indicates whether this encoder, given the current message context, provides end-to-end message confidentiality.

Specified by:

providesMessageConfidentiality in interface MessageEncoder

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

public boolean providesMessageIntegrity(MessageContext messageContext)
                                 throws MessageEncodingException

Indicates whether this encoder, given the current message context, provides end-to-end message integrity.

Specified by:

providesMessageIntegrity in interface MessageEncoder

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.

doEncode

protected void doEncode(MessageContext messageContext)
                 throws MessageEncodingException

Encodes the outbound message onto the outbound transport.

Specified by:

doEncode in class BaseMessageEncoder

Parameters:

messageContext - current message context

Throws:

MessageEncodingException - thrown if there is a problem encoding the message

prepareMessageContext

protected void prepareMessageContext(MessageContext messageContext)
                              throws MessageEncodingException

Perform final binding-specific processing of message context and prepare it for encoding to the transport.

This should include constructing and populating all binding-specific structure and data that needs to be reflected by the message context's properties.

This method is called prior to processOutboundHandlerChain(MessageContext).

Parameters:

messageContext - the message context to process

Throws:

MessageEncodingException - thrown if there is a problem preparing the message context for encoding

encodeToTransport

protected void encodeToTransport(MessageContext messageContext)
                          throws MessageEncodingException

Encode the message context to the transport.

Parameters:

messageContext - the message context to process

Throws:

MessageEncodingException - thrown if there is a problem encoding the message context to the transport

preprocessTransport

protected void preprocessTransport(MessageContext messageContext)
                            throws MessageEncodingException

This implementation performs the following actions on the context's HTTPOutTransport:

1. Adds the HTTP header: "Cache-control: no-cache, no-store"
2. Adds the HTTP header: "Pragma: no-cache"
3. Sets the character encoding to: "UTF-8"
4. Sets the content type to: "text/xml"
5. Sets the SOAPAction HTTP header

Parameters:

messageContext - the current message context being processed

Throws:

MessageEncodingException - thrown if there is a problem preprocessing the transport

processOutboundHandlerChain

protected void processOutboundHandlerChain(MessageContext messageContext)
                                    throws MessageEncodingException

Process the outbound HandlerChain for the message context, if any.

Parameters:

messageContext - the message context to process

Throws:

MessageEncodingException - thrown if a handler indicates a problem handling the message

invokeHandlerChain

protected void invokeHandlerChain(HandlerChain handlerChain,
                      MessageContext messageContext)
                           throws HandlerException

Invoke a handler chain on the specified message context.

Parameters:

handlerChain - the handle chain to invoke

messageContext - the message context to process

Throws:

HandlerException - if handler chain encountered a problem handling the message context