org.opensaml.messaging.pipeline

Interface MessagePipeline<InboundMessageType,OutboundMessageType>

Type Parameters:

OutboundMessageType - the outbound message type

InboundMessageType - the inbound message type

All Known Subinterfaces:

HttpClientMessagePipeline<InboundMessageType,OutboundMessageType>, HttpServletMessagePipeline<InboundMessageType,OutboundMessageType>

All Known Implementing Classes:

BasicHttpClientMessagePipeline, BasicHttpServletMessagePipeline, BasicMessagePipeline

public interface MessagePipeline<InboundMessageType,OutboundMessageType>

Interface representing the basic components of a message processing pipeline.

Method Summary

Modifier and Type	Method and Description
MessageDecoder<InboundMessageType>	getDecoder() Get the message decoder instance.
MessageEncoder<OutboundMessageType>	getEncoder() Get the message encoder instance.
MessageHandler<InboundMessageType>	getInboundMessageHandler() Get the (optional) inbound message handler instance.
MessageHandler<OutboundMessageType>	getOutboundPayloadMessageHandler() Get the (optional) outbound payload message handler instance.
MessageHandler<OutboundMessageType>	getOutboundTransportMessageHandler() Get the (optional) outbound transport message handler instance.

Method Detail

getEncoder

@Nonnull
MessageEncoder<OutboundMessageType> getEncoder()

Get the message encoder instance.

Returns:

the message encoder

getDecoder

@Nonnull
MessageDecoder<InboundMessageType> getDecoder()

Get the message decoder instance.

Returns:

the message decoder

getOutboundPayloadMessageHandler

@Nullable
MessageHandler<OutboundMessageType> getOutboundPayloadMessageHandler()

Get the (optional) outbound payload message handler instance.

This is the handler intended to be called on the outbound message context, prior to any message encoding.

Returns:

the outbound message handler, may be null

getOutboundTransportMessageHandler

@Nullable
MessageHandler<OutboundMessageType> getOutboundTransportMessageHandler()

Get the (optional) outbound transport message handler instance.

This is the handler intended to be called after MessageEncoder.prepareContext(), but before MessageEncoder.encode().

Returns:

the outbound message handler, may be null

getInboundMessageHandler

MessageHandler<InboundMessageType> getInboundMessageHandler()

Get the (optional) inbound message handler instance.

Returns:

the inbound message handler, may be null