org.opensaml.ws.soap.soap11.encoder
Class SOAP11Encoder

java.lang.Object
  extended by org.opensaml.ws.message.encoder.BaseMessageEncoder
      extended by org.opensaml.ws.message.handler.BaseHandlerChainAwareMessageEncoder
          extended by org.opensaml.ws.soap.soap11.encoder.SOAP11Encoder
All Implemented Interfaces:
MessageEncoder, HandlerChainAware
Direct Known Subclasses:
HTTPSOAP11Encoder

public class SOAP11Encoder
extends BaseHandlerChainAwareMessageEncoder

Basic SOAP 1.1 encoder.


Constructor Summary
SOAP11Encoder()
          Constructor.
 
Method Summary
protected  Envelope buildSOAPEnvelope(MessageContext messageContext)
          Builds the SOAP envelope and body skeleton to be encoded.
protected  void encodeToTransport(MessageContext messageContext)
          Encode the message context to the transport.
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)
          Perform any processing or fixup on the message context's outbound transport, prior to encoding the actual message.
 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.
 
Methods inherited from class org.opensaml.ws.message.handler.BaseHandlerChainAwareMessageEncoder
doEncode, invokeHandlerChain, processOutboundHandlerChain
 
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
 

Constructor Detail

SOAP11Encoder

public SOAP11Encoder()
Constructor.

Method Detail

providesMessageConfidentiality

public 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

public 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.

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 BaseHandlerChainAwareMessageEncoder.processOutboundHandlerChain(MessageContext).

Specified by:
prepareMessageContext in class BaseHandlerChainAwareMessageEncoder
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.

Specified by:
encodeToTransport in class BaseHandlerChainAwareMessageEncoder
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
Perform any processing or fixup on the message context's outbound transport, prior to encoding the actual message.

The default implementation does nothing. Subclasses should override to implement transport-specific behavior.

Parameters:
messageContext - the current message context being processed
Throws:
MessageEncodingException - thrown if there is a problem preprocessing the transport

buildSOAPEnvelope

protected Envelope buildSOAPEnvelope(MessageContext messageContext)
Builds the SOAP envelope and body skeleton to be encoded.

Parameters:
messageContext - the message context being processed
Returns:
the minimal SOAP message envelope skeleton


Copyright © 2006-2013 Internet2. All Rights Reserved.