org.springframework.messaging.support

Class ChannelInterceptorAdapter

java.lang.Object

org.springframework.messaging.support.ChannelInterceptorAdapter

All Implemented Interfaces:

ChannelInterceptor

Direct Known Subclasses:

ImmutableMessageChannelInterceptor

public abstract class ChannelInterceptorAdapter
extends java.lang.Object
implements ChannelInterceptor

A ChannelInterceptor base class with empty method implementations as a convenience.

Since:

4.0

Author:

Mark Fisher, Rossen Stoyanchev

Constructor Summary

Constructors

Constructor and Description
ChannelInterceptorAdapter()

Method Summary

Modifier and Type	Method and Description
void	afterReceiveCompletion(Message<?> message, MessageChannel channel, java.lang.Exception ex) Invoked after the completion of a receive regardless of any exception that have been raised thus allowing for proper resource cleanup.
void	afterSendCompletion(Message<?> message, MessageChannel channel, boolean sent, java.lang.Exception ex) Invoked after the completion of a send regardless of any exception that have been raised thus allowing for proper resource cleanup.
Message<?>	postReceive(Message<?> message, MessageChannel channel) Invoked immediately after a Message has been retrieved but before it is returned to the caller.
void	postSend(Message<?> message, MessageChannel channel, boolean sent) Invoked immediately after the send invocation.
boolean	preReceive(MessageChannel channel) Invoked as soon as receive is called and before a Message is actually retrieved.
Message<?>	preSend(Message<?> message, MessageChannel channel) Invoked before the Message is actually sent to the channel.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelInterceptorAdapter

public ChannelInterceptorAdapter()

Method Detail

preSend

public Message<?> preSend(Message<?> message,
                          MessageChannel channel)

Description copied from interface: ChannelInterceptor

Invoked before the Message is actually sent to the channel. This allows for modification of the Message if necessary. If this method returns null then the actual send invocation will not occur.

Specified by:

preSend in interface ChannelInterceptor

postSend

public void postSend(Message<?> message,
                     MessageChannel channel,
                     boolean sent)

Description copied from interface: ChannelInterceptor

Invoked immediately after the send invocation. The boolean value argument represents the return value of that invocation.

Specified by:

postSend in interface ChannelInterceptor

afterSendCompletion

public void afterSendCompletion(Message<?> message,
                                MessageChannel channel,
                                boolean sent,
                                java.lang.Exception ex)

Description copied from interface: ChannelInterceptor

Invoked after the completion of a send regardless of any exception that have been raised thus allowing for proper resource cleanup.

Note that this will be invoked only if ChannelInterceptor.preSend(org.springframework.messaging.Message<?>, org.springframework.messaging.MessageChannel) successfully completed and returned a Message, i.e. it did not return null.

Specified by:

afterSendCompletion in interface ChannelInterceptor

preReceive

public boolean preReceive(MessageChannel channel)

Description copied from interface: ChannelInterceptor

Invoked as soon as receive is called and before a Message is actually retrieved. If the return value is 'false', then no Message will be retrieved. This only applies to PollableChannels.

Specified by:

preReceive in interface ChannelInterceptor

postReceive

public Message<?> postReceive(Message<?> message,
                              MessageChannel channel)

Description copied from interface: ChannelInterceptor

Invoked immediately after a Message has been retrieved but before it is returned to the caller. The Message may be modified if necessary. This only applies to PollableChannels.

Specified by:

postReceive in interface ChannelInterceptor

afterReceiveCompletion

public void afterReceiveCompletion(Message<?> message,
                                   MessageChannel channel,
                                   java.lang.Exception ex)

Description copied from interface: ChannelInterceptor

Invoked after the completion of a receive regardless of any exception that have been raised thus allowing for proper resource cleanup.

Note that this will be invoked only if ChannelInterceptor.preReceive(org.springframework.messaging.MessageChannel) successfully completed and returned true.

Specified by:

afterReceiveCompletion in interface ChannelInterceptor