Spring Messaging 6.1.4 · org.springframework.messaging.support.ChannelInterceptor

Method Summary

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

Method Detail

afterReceiveCompletion back to summary

afterReceiveCompletion	back to summary
public default void afterReceiveCompletion(Message<?> message, MessageChannel channel, Exception ex) 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 `preReceive` successfully completed and returned `true`. Since 4.1

public default void afterReceiveCompletion(Message<?> message, MessageChannel channel, Exception ex)

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 preReceive successfully completed and returned true.

Since: 4.1

afterSendCompletion back to summary

afterSendCompletion	back to summary
public default void afterSendCompletion(Message<?> message, MessageChannel channel, boolean sent, Exception ex) 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 `preSend` successfully completed and returned a Message, i.e. it did not return `null`. Since 4.1

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

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 preSend successfully completed and returned a Message, i.e. it did not return null.

Since: 4.1

postReceive back to summary

postReceive	back to summary
public default Message<?> postReceive(Message<?> message, MessageChannel channel) Invoked immediately after a Message has been retrieved but before it is returned to the caller. The Message may be modified if necessary; `null` aborts further interceptor invocations. This only applies to PollableChannels. Annotations @Nullable

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

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

Annotations

@Nullable

postSend	back to summary
public default void postSend(Message<?> message, MessageChannel channel, boolean sent) Invoked immediately after the send invocation. The boolean value argument represents the return value of that invocation.

preReceive	back to summary
public default boolean preReceive(MessageChannel channel) 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.

preSend back to summary

preSend	back to summary
public default Message<?> preSend(Message<?> message, MessageChannel channel) 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. Annotations @Nullable

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

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.

Annotations

@Nullable

public Interface ChannelInterceptor

Method Summary

Method Detail