Modifier and Type	Class and Description
private static class	OrderedMessageChannelDecorator.CallbackTaskInterceptor
private class	OrderedMessageChannelDecorator.PostHandleTask Remove handled message from queue, and send next message.

Modifier and Type	Field and Description
private final MessageChannel	channel
private final Log	logger
private final Queue<Message<?>>	messages
private static final String	NEXT_MESSAGE_TASK_HEADER
private final AtomicBoolean	sendInProgress
private final int	subscriberCount

Access	Constructor and Description
public	OrderedMessageChannelDecorator(MessageChannel channel, Log logger)

Method Summary

Modifier and Type	Method and Description
public static void	configureInterceptor(MessageChannel the channel to configure channel, boolean whether preserve the order or publication; when "true" an interceptor is inserted, when "false" it removed. preserveOrder) Install or remove an `ExecutorChannelInterceptor` that invokes a completion task, if found in the headers of the message.
public static Runnable	getNextMessageTask(Message<?> message) Obtain the task to release the next message, if found.
private boolean	removeMessage(Message<?> message) Remove the message from the top of the queue, but only if it matches, i.e. hasn't been removed already.
public boolean	send(Message<?> the message to send message) Overrides default org.springframework.messaging.MessageChannel.send. Send a `Message` to this channel.
public boolean	send(Message<?> the message to send message, long the timeout in milliseconds or `INDEFINITE_TIMEOUT` timeout) Implements org.springframework.messaging.MessageChannel.send. Send a message, blocking until either the message is accepted or the specified timeout period elapses.
private void	sendNextMessage()
private static void	setTaskHeader(Message<?> message, Runnable task)
public static boolean	supportsOrderedMessages(MessageChannel channel) Whether the channel has been `configured` with an interceptor for sequential handling.
private void	trySend()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

channel	back to summary
private final MessageChannel channel

logger	back to summary
private final Log logger

messages	back to summary
private final Queue<Message<?>> messages

NEXT_MESSAGE_TASK_HEADER	back to summary
private static final String NEXT_MESSAGE_TASK_HEADER

sendInProgress	back to summary
private final AtomicBoolean sendInProgress

subscriberCount	back to summary
private final int subscriberCount

Constructor Detail

OrderedMessageChannelDecorator	back to summary
public OrderedMessageChannelDecorator(MessageChannel channel, Log logger)

Method Detail

configureInterceptor back to summary

configureInterceptor	back to summary
public static void configureInterceptor(MessageChannel channel, boolean preserveOrder) Install or remove an `ExecutorChannelInterceptor` that invokes a completion task, if found in the headers of the message. Parameters channel:MessageChannel the channel to configure preserveOrder:boolean whether preserve the order or publication; when "true" an interceptor is inserted, when "false" it removed.

public static void configureInterceptor(MessageChannel channel, boolean preserveOrder)

Install or remove an ExecutorChannelInterceptor that invokes a completion task, if found in the headers of the message.

Parameters

channel:MessageChannel: the channel to configure
preserveOrder:boolean: whether preserve the order or publication; when "true" an interceptor is inserted, when "false" it removed.

getNextMessageTask	back to summary
public static Runnable getNextMessageTask(Message<?> message) Obtain the task to release the next message, if found. Annotations @Nullable

getNextMessageTask

back to summary

public static Runnable getNextMessageTask(Message<?> message)

Obtain the task to release the next message, if found.

Annotations

@Nullable

removeMessage	back to summary
private boolean removeMessage(Message<?> message) Remove the message from the top of the queue, but only if it matches, i.e. hasn't been removed already.

send back to summary

send	back to summary
public boolean send(Message<?> message) Overrides default org.springframework.messaging.MessageChannel.send. Doc from org.springframework.messaging.MessageChannel.send. Send a `Message` to this channel. If the message is sent successfully, the method returns `true`. If the message cannot be sent due to a non-fatal reason, the method returns `false`. The method may also throw a RuntimeException in case of non-recoverable errors. This method may block indefinitely, depending on the implementation. To provide a maximum wait time, use `send(Message, long)`. Parameters message:Message<?> the message to send Returns:boolean whether the message was sent Annotations @Override

public boolean send(Message<?> message)

Overrides default org.springframework.messaging.MessageChannel.send.

Doc from org.springframework.messaging.MessageChannel.send.

Send a Message to this channel. If the message is sent successfully, the method returns true. If the message cannot be sent due to a non-fatal reason, the method returns false. The method may also throw a RuntimeException in case of non-recoverable errors.

This method may block indefinitely, depending on the implementation. To provide a maximum wait time, use send(Message, long).

Parameters

message:Message<?>: the message to send

Returns:boolean

whether the message was sent

Annotations

@Override

send back to summary

send	back to summary
public boolean send(Message<?> message, long timeout) Implements org.springframework.messaging.MessageChannel.send. Doc from org.springframework.messaging.MessageChannel.send. Send a message, blocking until either the message is accepted or the specified timeout period elapses. Parameters message:Message<?> the message to send timeout:long the timeout in milliseconds or `INDEFINITE_TIMEOUT` Returns:boolean `true` if the message is sent, `false` if not including a timeout of an interrupt of the send Annotations @Override

public boolean send(Message<?> message, long timeout)

Implements org.springframework.messaging.MessageChannel.send.

Doc from org.springframework.messaging.MessageChannel.send.

Send a message, blocking until either the message is accepted or the specified timeout period elapses.

Parameters

message:Message<?>: the message to send
timeout:long: the timeout in milliseconds or INDEFINITE_TIMEOUT

Returns:boolean

true if the message is sent, false if not including a timeout of an interrupt of the send

Annotations

@Override

sendNextMessage	back to summary
private void sendNextMessage()

setTaskHeader	back to summary
private static void setTaskHeader(Message<?> message, Runnable task)

supportsOrderedMessages back to summary

supportsOrderedMessages	back to summary
public static boolean supportsOrderedMessages(MessageChannel channel) Whether the channel has been `configured` with an interceptor for sequential handling. Since 6.1

public static boolean supportsOrderedMessages(MessageChannel channel)

Whether the channel has been configured with an interceptor for sequential handling.

Since: 6.1

trySend	back to summary
private void trySend()

org.springframework.messaging.simp.broker back to summary

private final Class OrderedMessageChannelDecorator.CallbackTaskInterceptor

Class Inheritance

extends Object
implements ExecutorChannelInterceptor

java.lang.Object
org.springframework.messaging.simp.broker.OrderedMessageChannelDecorator.CallbackTaskInterceptor

All Implemented Interfaces

org.springframework.messaging.support.ExecutorChannelInterceptor, org.springframework.messaging.support.ChannelInterceptor

Constructor Summary

Access	Constructor and Description
private	CallbackTaskInterceptor()

Method Summary

Modifier and Type Method and Description

Modifier and Type	Method and Description
public void	afterMessageHandled(Message<?> the message handled message, MessageChannel the channel on which the message was sent to ch, MessageHandler the target handler that handled the message handler, Exception any exception that may have been raised by the handler ex) Overrides default org.springframework.messaging.support.ExecutorChannelInterceptor.afterMessageHandled. Invoked inside the `Runnable` submitted to the Executor after calling the target MessageHandler regardless of the outcome (i.e. Exception raised or not) thus allowing for proper resource cleanup.

public void

afterMessageHandled(Message<?>

the message handled

message, MessageChannel

the channel on which the message was sent to

ch, MessageHandler

the target handler that handled the message

handler, Exception

any exception that may have been raised by the handler

ex)

Overrides default org.springframework.messaging.support.ExecutorChannelInterceptor.afterMessageHandled.

Invoked inside the Runnable submitted to the Executor after calling the target MessageHandler regardless of the outcome (i.e. Exception raised or not) thus allowing for proper resource cleanup.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

CallbackTaskInterceptor	back to summary
private CallbackTaskInterceptor()

Method Detail

afterMessageHandled back to summary

afterMessageHandled	back to summary
public void afterMessageHandled(Message<?> message, MessageChannel ch, MessageHandler handler, Exception ex) Overrides default org.springframework.messaging.support.ExecutorChannelInterceptor.afterMessageHandled. Doc from org.springframework.messaging.support.ExecutorChannelInterceptor.afterMessageHandled. Invoked inside the `Runnable` submitted to the Executor after calling the target MessageHandler regardless of the outcome (i.e. Exception raised or not) thus allowing for proper resource cleanup. Note that this will be invoked only if beforeHandle successfully completed and returned a Message, i.e. it did not return `null`. Parameters message:Message<?> the message handled ch:MessageChannel the channel on which the message was sent to handler:MessageHandler the target handler that handled the message ex:Exception any exception that may have been raised by the handler Annotations @Override

public void afterMessageHandled(Message<?> message, MessageChannel ch, MessageHandler handler, Exception ex)

Overrides default org.springframework.messaging.support.ExecutorChannelInterceptor.afterMessageHandled.

Doc from org.springframework.messaging.support.ExecutorChannelInterceptor.afterMessageHandled.

Invoked inside the Runnable submitted to the Executor after calling the target MessageHandler regardless of the outcome (i.e. Exception raised or not) thus allowing for proper resource cleanup.

Note that this will be invoked only if beforeHandle successfully completed and returned a Message, i.e. it did not return null.

Parameters

message:Message<?>: the message handled
ch:MessageChannel: the channel on which the message was sent to
handler:MessageHandler: the target handler that handled the message
ex:Exception: any exception that may have been raised by the handler

Annotations

@Override

org.springframework.messaging.simp.broker back to summary

private final Class OrderedMessageChannelDecorator.PostHandleTask

Class Inheritance

extends Object
implements Runnable

java.lang.Object
org.springframework.messaging.simp.broker.OrderedMessageChannelDecorator.PostHandleTask

All Implemented Interfaces

java.lang.Runnable

Remove handled message from queue, and send next message.

Field Summary

Modifier and Type	Field and Description
private final AtomicInteger	handledCount
private final Message<?>	message

Constructor Summary

Access	Constructor and Description
private	PostHandleTask(Message<?> message)

Method Summary

Modifier and Type	Method and Description
public void	run() Implements java.lang.Runnable.run. Runs this operation.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

handledCount	back to summary
private final AtomicInteger handledCount Annotations @Nullable

message	back to summary
private final Message<?> message

Constructor Detail

PostHandleTask	back to summary
private PostHandleTask(Message<?> message)

Method Detail

run	back to summary
public void run() Implements java.lang.Runnable.run. Doc from java.lang.Runnable.run. Runs this operation. Annotations @Override

run

back to summary

public void run()

Implements java.lang.Runnable.run.

Doc from java.lang.Runnable.run.

Runs this operation.

Annotations

@Override

public Class OrderedMessageChannelDecorator

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class OrderedMessageChannelDecorator.CallbackTaskInterceptor

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private final Class OrderedMessageChannelDecorator.PostHandleTask

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail