Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.opensaml.saml2.binding.encoding
Class HandlerChainAwareHTTPSOAP11Encoder

java.lang.Object
  extended by org.opensaml.ws.message.encoder.BaseMessageEncoder
      extended by org.opensaml.saml2.binding.encoding.BaseSAML2MessageEncoder
          extended by org.opensaml.saml2.binding.encoding.HandlerChainAwareHTTPSOAP11Encoder
All Implemented Interfaces:
SAMLMessageEncoder, MessageEncoder, HandlerChainAware
public class HandlerChainAwareHTTPSOAP11Encoder
extends BaseSAML2MessageEncoder
implements HandlerChainAware

Field Summary
private  SOAPObjectBuilder<Body> bodyBuilder
          SOAP Body builder.
private  SOAPObjectBuilder<Envelope> envBuilder
          SOAP Envelope builder.
private  org.slf4j.Logger log
          Class logger.
private  boolean notConfidential
          Overrides binding confidentiality.
 
Constructor Summary
HandlerChainAwareHTTPSOAP11Encoder()
          Constructor.
 
Method Summary
protected  void doEncode(MessageContext messageContext)
          
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)
          
 boolean providesMessageIntegrity(MessageContext messageContext)
          
 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
 

Field Detail

log

private final org.slf4j.Logger log
Class logger.

envBuilder

private SOAPObjectBuilder<Envelope> envBuilder
SOAP Envelope builder.

bodyBuilder

private SOAPObjectBuilder<Body> bodyBuilder
SOAP Body builder.

notConfidential

private boolean notConfidential
Overrides binding confidentiality.

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

Specified by:
providesMessageConfidentiality in interface MessageEncoder
Throws:
MessageEncodingException

providesMessageIntegrity

public boolean providesMessageIntegrity(MessageContext messageContext)
                                 throws MessageEncodingException

Specified by:
providesMessageIntegrity in interface MessageEncoder
Throws:
MessageEncodingException

doEncode

protected void doEncode(MessageContext messageContext)
                 throws MessageEncodingException

Specified by:
doEncode in class BaseMessageEncoder
Throws:
MessageEncodingException

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
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 1999-2013. All Rights Reserved.