Modifier and Type	Class and Description
private class	SimpleBrokerMessageHandler.HeartbeatTask
private static class	SimpleBrokerMessageHandler.SessionInfo

Modifier and Type	Field and Description
private Integer	cacheLimit
private static final byte[]	EMPTY_PAYLOAD
private MessageHeaderInitializer	headerInitializer
private ScheduledFuture<?>	heartbeatFuture
private long[]	heartbeatValue
private PathMatcher	pathMatcher
private String	selectorHeaderName
private final Map<String, SimpleBrokerMessageHandler.SessionInfo>	sessions
private SubscriptionRegistry	subscriptionRegistry
private TaskScheduler	taskScheduler

Access	Constructor and Description
public	SimpleBrokerMessageHandler(SubscribableChannel the channel for receiving messages from clients (e.g. WebSocket clients) clientInboundChannel, MessageChannel the channel for sending messages to clients (e.g. WebSocket clients) clientOutboundChannel, SubscribableChannel the channel for the application to send messages to the broker brokerChannel, Collection<String> prefixes to use to filter out messages destinationPrefixes) Create a SimpleBrokerMessageHandler instance with the given message channels and destination prefixes.

Method Summary

Modifier and Type	Method and Description
public MessageHeaderInitializer	getHeaderInitializer() Return the configured header initializer.
public long[]	getHeartbeatValue() The configured value for the heart-beat settings.
public SubscriptionRegistry	getSubscriptionRegistry()
public TaskScheduler	getTaskScheduler() Return the configured TaskScheduler.
private void	handleDisconnect(String sessionId, Principal user, Message<?> origMessage)
protected void	handleMessageInternal(Message<?> message) Implements abstract org.springframework.messaging.simp.broker.AbstractBrokerMessageHandler.handleMessageInternal.
private void	initCacheLimitToUse()
private void	initHeaders(SimpMessageHeaderAccessor accessor)
private Duration	initHeartbeatTaskDelay()
private void	initPathMatcherToUse()
private void	initSelectorHeaderNameToUse()
private void	logMessage(Message<?> message)
protected void	sendMessageToSubscribers(String destination, Message<?> message)
public void	setCacheLimit(Integer cacheLimit) When configured, the specified cache limit is passed down to the underlying SubscriptionRegistry, overriding any default there.
public void	setHeaderInitializer(MessageHeaderInitializer headerInitializer) Configure a `MessageHeaderInitializer` to apply to the headers of all messages sent to the client outbound channel.
public void	setHeartbeatValue(long[] heartbeat) Configure the value for the heart-beat settings.
public void	setPathMatcher(PathMatcher pathMatcher) When configured, the given PathMatcher is passed down to the underlying SubscriptionRegistry to use for matching destination to subscriptions.
public void	setSelectorHeaderName(String the name to use for a selector header, or `null` or blank to disable selector header support selectorHeaderName) Configure the name of a header that a subscription message can have for the purpose of filtering messages matched to the subscription.
public void	setSubscriptionRegistry(SubscriptionRegistry subscriptionRegistry) Configure a custom `SubscriptionRegistry` to use for storing subscriptions.
public void	setTaskScheduler(TaskScheduler taskScheduler) Configure the `org.springframework.scheduling.TaskScheduler` to use for providing heartbeat support.
public void	startInternal() Overrides org.springframework.messaging.simp.broker.AbstractBrokerMessageHandler.startInternal.
public void	stopInternal() Overrides org.springframework.messaging.simp.broker.AbstractBrokerMessageHandler.stopInternal.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
private void	updateSessionReadTime(String sessionId)

Field Detail

cacheLimit	back to summary
private Integer cacheLimit Annotations @Nullable

EMPTY_PAYLOAD	back to summary
private static final byte[] EMPTY_PAYLOAD

headerInitializer	back to summary
private MessageHeaderInitializer headerInitializer Annotations @Nullable

heartbeatFuture	back to summary
private ScheduledFuture<?> heartbeatFuture Annotations @Nullable

heartbeatValue	back to summary
private long[] heartbeatValue Annotations @Nullable

pathMatcher	back to summary
private PathMatcher pathMatcher Annotations @Nullable

selectorHeaderName	back to summary
private String selectorHeaderName Annotations @Nullable

sessions	back to summary
private final Map<String, SimpleBrokerMessageHandler.SessionInfo> sessions

subscriptionRegistry	back to summary
private SubscriptionRegistry subscriptionRegistry

taskScheduler	back to summary
private TaskScheduler taskScheduler Annotations @Nullable

Constructor Detail

SimpleBrokerMessageHandler	back to summary
public SimpleBrokerMessageHandler(SubscribableChannel clientInboundChannel, MessageChannel clientOutboundChannel, SubscribableChannel brokerChannel, Collection<String> destinationPrefixes) Create a SimpleBrokerMessageHandler instance with the given message channels and destination prefixes. Parameters clientInboundChannel:SubscribableChannel the channel for receiving messages from clients (e.g. WebSocket clients) clientOutboundChannel:MessageChannel the channel for sending messages to clients (e.g. WebSocket clients) brokerChannel:SubscribableChannel the channel for the application to send messages to the broker destinationPrefixes:Collection<String> prefixes to use to filter out messages

SimpleBrokerMessageHandler

back to summary

public SimpleBrokerMessageHandler(SubscribableChannel clientInboundChannel, MessageChannel clientOutboundChannel, SubscribableChannel brokerChannel, Collection<String> destinationPrefixes)

Create a SimpleBrokerMessageHandler instance with the given message channels and destination prefixes.

Parameters

clientInboundChannel:SubscribableChannel: the channel for receiving messages from clients (e.g. WebSocket clients)
clientOutboundChannel:MessageChannel: the channel for sending messages to clients (e.g. WebSocket clients)
brokerChannel:SubscribableChannel: the channel for the application to send messages to the broker
destinationPrefixes:Collection<String>: prefixes to use to filter out messages

Method Detail

getHeaderInitializer	back to summary
public MessageHeaderInitializer getHeaderInitializer() Return the configured header initializer. Annotations @Nullable Since 4.1

getHeaderInitializer

back to summary

public MessageHeaderInitializer getHeaderInitializer()

Return the configured header initializer.

Annotations

@Nullable

Since

4.1

getHeartbeatValue	back to summary
public long[] getHeartbeatValue() The configured value for the heart-beat settings. Annotations @Nullable Since 4.2

getHeartbeatValue

back to summary

public long[] getHeartbeatValue()

The configured value for the heart-beat settings.

Annotations

@Nullable

Since

4.2

getSubscriptionRegistry	back to summary
public SubscriptionRegistry getSubscriptionRegistry()

getTaskScheduler	back to summary
public TaskScheduler getTaskScheduler() Return the configured TaskScheduler. Annotations @Nullable Since 4.2

getTaskScheduler

back to summary

public TaskScheduler getTaskScheduler()

Return the configured TaskScheduler.

Annotations

@Nullable

Since

4.2

handleDisconnect	back to summary
private void handleDisconnect(String sessionId, Principal user, Message<?> origMessage)

handleMessageInternal	back to summary
protected void handleMessageInternal(Message<?> message) Implements abstract org.springframework.messaging.simp.broker.AbstractBrokerMessageHandler.handleMessageInternal. Annotations @Override

handleMessageInternal

back to summary

protected void handleMessageInternal(Message<?> message)

Implements abstract org.springframework.messaging.simp.broker.AbstractBrokerMessageHandler.handleMessageInternal.

Annotations

@Override

initCacheLimitToUse	back to summary
private void initCacheLimitToUse()

initHeaders	back to summary
private void initHeaders(SimpMessageHeaderAccessor accessor)

initHeartbeatTaskDelay	back to summary
private Duration initHeartbeatTaskDelay()

initPathMatcherToUse	back to summary
private void initPathMatcherToUse()

initSelectorHeaderNameToUse	back to summary
private void initSelectorHeaderNameToUse()

logMessage	back to summary
private void logMessage(Message<?> message)

sendMessageToSubscribers	back to summary
protected void sendMessageToSubscribers(String destination, Message<?> message)

setCacheLimit back to summary

setCacheLimit	back to summary
public void setCacheLimit(Integer cacheLimit) When configured, the specified cache limit is passed down to the underlying SubscriptionRegistry, overriding any default there. With a standard `DefaultSubscriptionRegistry`, the default cache limit is 1024. Setting this property has no effect if the underlying SubscriptionRegistry is not an instance of `DefaultSubscriptionRegistry`. Since 4.3.2 See Also `setSubscriptionRegistry`, `DefaultSubscriptionRegistry#setCacheLimit`, `DefaultSubscriptionRegistry#DEFAULT_CACHE_LIMIT`

public void setCacheLimit(Integer cacheLimit)

When configured, the specified cache limit is passed down to the underlying SubscriptionRegistry, overriding any default there.

With a standard DefaultSubscriptionRegistry, the default cache limit is 1024.

Setting this property has no effect if the underlying SubscriptionRegistry is not an instance of DefaultSubscriptionRegistry.

Since: 4.3.2
See Also: setSubscriptionRegistry, DefaultSubscriptionRegistry#setCacheLimit, DefaultSubscriptionRegistry#DEFAULT_CACHE_LIMIT

setHeaderInitializer back to summary

setHeaderInitializer	back to summary
public void setHeaderInitializer(MessageHeaderInitializer headerInitializer) Configure a `MessageHeaderInitializer` to apply to the headers of all messages sent to the client outbound channel. By default this property is not set. Since 4.1

public void setHeaderInitializer(MessageHeaderInitializer headerInitializer)

Configure a MessageHeaderInitializer to apply to the headers of all messages sent to the client outbound channel.

By default this property is not set.

Since: 4.1

setHeartbeatValue back to summary

setHeartbeatValue	back to summary
public void setHeartbeatValue(long[] heartbeat) Configure the value for the heart-beat settings. The first number represents how often the server will write or send a heartbeat. The second is how often the client should write. 0 means no heartbeats. By default this is set to "0, 0" unless the `taskScheduler` in which case the default becomes "10000,10000" (in milliseconds). Since 4.2

public void setHeartbeatValue(long[] heartbeat)

Configure the value for the heart-beat settings. The first number represents how often the server will write or send a heartbeat. The second is how often the client should write. 0 means no heartbeats.

By default this is set to "0, 0" unless the taskScheduler in which case the default becomes "10000,10000" (in milliseconds).

Since: 4.2

setPathMatcher back to summary

setPathMatcher	back to summary
public void setPathMatcher(PathMatcher pathMatcher) When configured, the given PathMatcher is passed down to the underlying SubscriptionRegistry to use for matching destination to subscriptions. Default is a standard `org.springframework.util.AntPathMatcher`. Setting this property has no effect if the underlying SubscriptionRegistry is not an instance of `DefaultSubscriptionRegistry`. Since 4.1 See Also `setSubscriptionRegistry`, `DefaultSubscriptionRegistry#setPathMatcher`, `org.springframework.util.AntPathMatcher`

public void setPathMatcher(PathMatcher pathMatcher)

When configured, the given PathMatcher is passed down to the underlying SubscriptionRegistry to use for matching destination to subscriptions.

Default is a standard org.springframework.util.AntPathMatcher.

Setting this property has no effect if the underlying SubscriptionRegistry is not an instance of DefaultSubscriptionRegistry.

Since: 4.1
See Also: setSubscriptionRegistry, DefaultSubscriptionRegistry#setPathMatcher, org.springframework.util.AntPathMatcher

setSelectorHeaderName back to summary

setSelectorHeaderName	back to summary
public void setSelectorHeaderName(String selectorHeaderName) Configure the name of a header that a subscription message can have for the purpose of filtering messages matched to the subscription. The header value is expected to be a Spring Expression Language (SpEL) boolean expression to be applied to the headers of messages matched to the subscription. For example: headers.foo == 'bar' By default the selector header name is set to `null` which disables this feature. You can set it to `"selector"` or a different name to enable support for a selector header. Setting this property has no effect if the underlying SubscriptionRegistry is not an instance of `DefaultSubscriptionRegistry`. Parameters selectorHeaderName:String the name to use for a selector header, or `null` or blank to disable selector header support Since 4.3.17 See Also `setSubscriptionRegistry`, `DefaultSubscriptionRegistry#setSelectorHeaderName(String)`

public void setSelectorHeaderName(String selectorHeaderName)

Configure the name of a header that a subscription message can have for the purpose of filtering messages matched to the subscription.

The header value is expected to be a Spring Expression Language (SpEL) boolean expression to be applied to the headers of messages matched to the subscription.

For example:

headers.foo == 'bar'

By default the selector header name is set to null which disables this feature. You can set it to "selector" or a different name to enable support for a selector header.

Setting this property has no effect if the underlying SubscriptionRegistry is not an instance of DefaultSubscriptionRegistry.

Parameters

selectorHeaderName:String: the name to use for a selector header, or null or blank to disable selector header support

Since

4.3.17

setSubscriptionRegistry	back to summary
public void setSubscriptionRegistry(SubscriptionRegistry subscriptionRegistry) Configure a custom `SubscriptionRegistry` to use for storing subscriptions. Note If the custom registry is not an instance of `DefaultSubscriptionRegistry`, the configured `PathMatcher`, cache limit, and selector header name are not used and must be configured directly on the custom registry.

setTaskScheduler back to summary

setTaskScheduler	back to summary
public void setTaskScheduler(TaskScheduler taskScheduler) Configure the `org.springframework.scheduling.TaskScheduler` to use for providing heartbeat support. Setting this property also sets the `heartbeatValue` to "10000, 10000". By default this is not set. Since 4.2

public void setTaskScheduler(TaskScheduler taskScheduler)

Configure the org.springframework.scheduling.TaskScheduler to use for providing heartbeat support. Setting this property also sets the heartbeatValue to "10000, 10000".

By default this is not set.

Since: 4.2

startInternal	back to summary
public void startInternal() Overrides org.springframework.messaging.simp.broker.AbstractBrokerMessageHandler.startInternal. Annotations @Override

startInternal

back to summary

public void startInternal()

Overrides org.springframework.messaging.simp.broker.AbstractBrokerMessageHandler.startInternal.

Annotations

@Override

stopInternal	back to summary
public void stopInternal() Overrides org.springframework.messaging.simp.broker.AbstractBrokerMessageHandler.stopInternal. Annotations @Override

stopInternal

back to summary

public void stopInternal()

Overrides org.springframework.messaging.simp.broker.AbstractBrokerMessageHandler.stopInternal.

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

updateSessionReadTime	back to summary
private void updateSessionReadTime(String sessionId)

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

private Class SimpleBrokerMessageHandler.HeartbeatTask

Class Inheritance

extends Object
implements Runnable

java.lang.Object
org.springframework.messaging.simp.broker.SimpleBrokerMessageHandler.HeartbeatTask

All Implemented Interfaces

java.lang.Runnable

Constructor Summary

Access	Constructor and Description
private	HeartbeatTask()

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

Constructor Detail

HeartbeatTask	back to summary
private HeartbeatTask()

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

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

private Class SimpleBrokerMessageHandler.SessionInfo

Class Inheritance

extends Object

java.lang.Object
org.springframework.messaging.simp.broker.SimpleBrokerMessageHandler.SessionInfo

Field Summary

Modifier and Type	Field and Description
private final MessageChannel	clientOutboundChannel
private static final long	HEARTBEAT_MULTIPLIER
private volatile long	lastReadTime
private volatile long	lastWriteTime
private final long	readInterval
private final String	sessionId
private final Principal	user
private final long	writeInterval

Constructor Summary

Access	Constructor and Description
public	SessionInfo(String sessionId, Principal user, MessageChannel outboundChannel, long[] clientHeartbeat, long[] serverHeartbeat)

Method Summary

Modifier and Type	Method and Description
public MessageChannel	getClientOutboundChannel()
public long	getLastReadTime()
public long	getLastWriteTime()
public long	getReadInterval()
public String	getSessionId()
public Principal	getUser()
public long	getWriteInterval()
public void	setLastReadTime(long lastReadTime)
public void	setLastWriteTime(long lastWriteTime)

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

Field Detail

clientOutboundChannel	back to summary
private final MessageChannel clientOutboundChannel

HEARTBEAT_MULTIPLIER	back to summary
private static final long HEARTBEAT_MULTIPLIER

lastReadTime	back to summary
private volatile long lastReadTime

lastWriteTime	back to summary
private volatile long lastWriteTime

readInterval	back to summary
private final long readInterval

sessionId	back to summary
private final String sessionId

user	back to summary
private final Principal user Annotations @Nullable

writeInterval	back to summary
private final long writeInterval

Constructor Detail

SessionInfo	back to summary
public SessionInfo(String sessionId, Principal user, MessageChannel outboundChannel, long[] clientHeartbeat, long[] serverHeartbeat)

Method Detail

getClientOutboundChannel	back to summary
public MessageChannel getClientOutboundChannel()

getLastReadTime	back to summary
public long getLastReadTime()

getLastWriteTime	back to summary
public long getLastWriteTime()

getReadInterval	back to summary
public long getReadInterval()

getSessionId	back to summary
public String getSessionId()

getUser	back to summary
public Principal getUser() Annotations @Nullable

getWriteInterval	back to summary
public long getWriteInterval()

setLastReadTime	back to summary
public void setLastReadTime(long lastReadTime)

setLastWriteTime	back to summary
public void setLastWriteTime(long lastWriteTime)

public Class SimpleBrokerMessageHandler

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class SimpleBrokerMessageHandler.HeartbeatTask

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class SimpleBrokerMessageHandler.SessionInfo

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail