|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opensaml.ws.message.encoder.BaseMessageEncoder
org.opensaml.ws.message.handler.BaseHandlerChainAwareMessageEncoder
public abstract class BaseHandlerChainAwareMessageEncoder
Base class for message encoders which are capable of processing the message context's outbound HandlerChain
.
Constructor Summary | |
---|---|
BaseHandlerChainAwareMessageEncoder()
|
Method Summary | |
---|---|
protected void |
doEncode(MessageContext messageContext)
Encodes the outbound message onto the outbound transport. |
protected abstract void |
encodeToTransport(MessageContext messageContext)
Encode the message context to the transport. |
protected void |
invokeHandlerChain(HandlerChain handlerChain,
MessageContext messageContext)
Invoke a handler chain on the specified message context. |
protected abstract void |
prepareMessageContext(MessageContext messageContext)
Perform final binding-specific processing of message context and prepare it for encoding to the transport. |
protected void |
processOutboundHandlerChain(MessageContext messageContext)
Process the outbound HandlerChain for the message context, if any. |
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 |
---|
providesMessageConfidentiality, providesMessageIntegrity |
Constructor Detail |
---|
public BaseHandlerChainAwareMessageEncoder()
Method Detail |
---|
protected void doEncode(MessageContext messageContext) throws MessageEncodingException
doEncode
in class BaseMessageEncoder
messageContext
- current message context
MessageEncodingException
- thrown if there is a problem encoding the messageprotected abstract void prepareMessageContext(MessageContext messageContext) throws MessageEncodingException
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)
.
messageContext
- the message context to process
MessageEncodingException
- thrown if there is a problem preparing the message context
for encodingprotected abstract void encodeToTransport(MessageContext messageContext) throws MessageEncodingException
messageContext
- the message context to process
MessageEncodingException
- thrown if there is a problem encoding the message context
to the transportprotected void processOutboundHandlerChain(MessageContext messageContext) throws MessageEncodingException
HandlerChain
for the message context, if any.
messageContext
- the message context to process
MessageEncodingException
- thrown if a handler indicates a problem handling the messageprotected void invokeHandlerChain(HandlerChain handlerChain, MessageContext messageContext) throws HandlerException
handlerChain
- the handle chain to invokemessageContext
- the message context to process
HandlerException
- if handler chain encountered a problem handling the message context
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |