org.opensaml.messaging.pipeline

Class BasicMessagePipeline<InboundMessageType,OutboundMessageType>

java.lang.Object

org.opensaml.messaging.pipeline.BasicMessagePipeline<InboundMessageType,OutboundMessageType>

Type Parameters:

OutboundMessageType - the outbound message type

InboundMessageType - the inbound message type

All Implemented Interfaces:

MessagePipeline<InboundMessageType,OutboundMessageType>

Direct Known Subclasses:

BasicHttpClientMessagePipeline, BasicHttpServletMessagePipeline

public class BasicMessagePipeline<InboundMessageType,OutboundMessageType>
extends Object
implements MessagePipeline<InboundMessageType,OutboundMessageType>

Basic implementation of MessagePipeline.

Field Summary

Fields

Modifier and Type	Field and Description
private MessageDecoder<InboundMessageType>	decoder Message decoder.
private MessageEncoder<OutboundMessageType>	encoder Message encoder.
private MessageHandler<InboundMessageType>	inboundHandler Inbound message handler.
private MessageHandler<OutboundMessageType>	outboundPayloadHandler Outbound payload message handler.
private MessageHandler<OutboundMessageType>	outboundTransportHandler Outbound transport message handler.

Constructor Summary

Constructors

Constructor and Description
BasicMessagePipeline(MessageEncoder<OutboundMessageType> newEncoder, MessageDecoder<InboundMessageType> newDecoder) Constructor.

Method Summary

Methods

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.
protected void	setDecoder(MessageDecoder<InboundMessageType> newDecoder) Set the message decoder instance.
protected void	setEncoder(MessageEncoder<OutboundMessageType> newEncoder) Set the message encoder instance.
void	setInboundHandler(MessageHandler<InboundMessageType> handler) Set the inbound message handler.
void	setOutboundPayloadHandler(MessageHandler<OutboundMessageType> handler) Set the outbound payload message handler.
void	setOutboundTransportHandler(MessageHandler<OutboundMessageType> handler) Set the outbound transport message handler.

Methods inherited from class java.lang.Object

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

Field Detail

encoder

private MessageEncoder<OutboundMessageType> encoder

Message encoder.

decoder

private MessageDecoder<InboundMessageType> decoder

Message decoder.

outboundPayloadHandler

private MessageHandler<OutboundMessageType> outboundPayloadHandler

Outbound payload message handler.

outboundTransportHandler

private MessageHandler<OutboundMessageType> outboundTransportHandler

Outbound transport message handler.

inboundHandler

private MessageHandler<InboundMessageType> inboundHandler

Inbound message handler.

Constructor Detail

BasicMessagePipeline

public BasicMessagePipeline(@Nonnull
                    MessageEncoder<OutboundMessageType> newEncoder,
                    @Nonnull
                    MessageDecoder<InboundMessageType> newDecoder)

Constructor.

Parameters:

newEncoder - the message encoder instance

newDecoder - the message decoder instance

Method Detail

getEncoder

public MessageEncoder<OutboundMessageType> getEncoder()

Get the message encoder instance.

Specified by:

getEncoder in interface MessagePipeline<InboundMessageType,OutboundMessageType>

Returns:

the message encoder

setEncoder

protected void setEncoder(@Nonnull
              MessageEncoder<OutboundMessageType> newEncoder)

Set the message encoder instance.

Parameters:

newEncoder - the new message encoder

getDecoder

public MessageDecoder<InboundMessageType> getDecoder()

Get the message decoder instance.

Specified by:

getDecoder in interface MessagePipeline<InboundMessageType,OutboundMessageType>

Returns:

the message decoder

setDecoder

protected void setDecoder(@Nonnull
              MessageDecoder<InboundMessageType> newDecoder)

Set the message decoder instance.

Parameters:

newDecoder - the new message decoder

getOutboundPayloadMessageHandler

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

Specified by:

getOutboundPayloadMessageHandler in interface MessagePipeline<InboundMessageType,OutboundMessageType>

Returns:

the outbound message handler, may be null

setOutboundPayloadHandler

public void setOutboundPayloadHandler(@Nullable
                             MessageHandler<OutboundMessageType> handler)

Set the outbound payload message handler.

Parameters:

handler - the new handler

getOutboundTransportMessageHandler

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

Specified by:

getOutboundTransportMessageHandler in interface MessagePipeline<InboundMessageType,OutboundMessageType>

Returns:

the outbound message handler, may be null

setOutboundTransportHandler

public void setOutboundTransportHandler(MessageHandler<OutboundMessageType> handler)

Set the outbound transport message handler.

Parameters:

handler - the new handler

getInboundMessageHandler

public MessageHandler<InboundMessageType> getInboundMessageHandler()

Get the (optional) inbound message handler instance.

Specified by:

getInboundMessageHandler in interface MessagePipeline<InboundMessageType,OutboundMessageType>

Returns:

the inbound message handler, may be null

setInboundHandler

public void setInboundHandler(MessageHandler<InboundMessageType> handler)

Set the inbound message handler.

Parameters:

handler - the new handler