Spring Framework 6.1.4 · org.springframework.messaging.simp.config.StompBrokerRelayRegistration

Modifier and Type	Field and Description
private boolean	autoStartup
private String	clientLogin
private String	clientPasscode
private String	relayHost
private int	relayPort
private Long	systemHeartbeatReceiveInterval
private Long	systemHeartbeatSendInterval
private String	systemLogin
private String	systemPasscode
private TaskScheduler	taskScheduler
private TcpOperations<byte[]>	tcpClient
private String	userDestinationBroadcast
private String	userRegistryBroadcast
private String	virtualHost

Access	Constructor and Description
public	StompBrokerRelayRegistration(SubscribableChannel the inbound channel clientInboundChannel, MessageChannel the outbound channel clientOutboundChannel, String[] the destination prefixes destinationPrefixes) Create a new `StompBrokerRelayRegistration`.

Method Summary

Modifier and Type	Method and Description
protected StompBrokerRelayMessageHandler	getMessageHandler(SubscribableChannel brokerChannel) Implements abstract org.springframework.messaging.simp.config.AbstractBrokerRegistration.getMessageHandler.
protected String	getUserDestinationBroadcast()
protected String	getUserRegistryBroadcast()
public StompBrokerRelayRegistration	setAutoStartup(boolean autoStartup) Configure whether the `StompBrokerRelayMessageHandler` should start automatically when the Spring ApplicationContext is refreshed.
public StompBrokerRelayRegistration	setClientLogin(String login) Set the login to use when creating connections to the STOMP broker on behalf of connected clients.
public StompBrokerRelayRegistration	setClientPasscode(String passcode) Set the passcode to use when creating connections to the STOMP broker on behalf of connected clients.
public StompBrokerRelayRegistration	setRelayHost(String relayHost) Set the STOMP message broker host.
public StompBrokerRelayRegistration	setRelayPort(int relayPort) Set the STOMP message broker port.
public StompBrokerRelayRegistration	setSystemHeartbeatReceiveInterval(long heartbeatReceiveInterval) Set the maximum interval, in milliseconds, at which the "system" relay session expects, in the absence of any other data, to receive a heartbeat from the STOMP broker.
public StompBrokerRelayRegistration	setSystemHeartbeatSendInterval(long systemHeartbeatSendInterval) Set the interval, in milliseconds, at which the "system" relay session will, in the absence of any other data being sent, send a heartbeat to the STOMP broker.
public StompBrokerRelayRegistration	setSystemLogin(String login) Set the login for the shared "system" connection used to send messages to the STOMP broker from within the application, i.e. messages not associated with a specific client session (e.g. REST/HTTP request handling method).
public StompBrokerRelayRegistration	setSystemPasscode(String passcode) Set the passcode for the shared "system" connection used to send messages to the STOMP broker from within the application, i.e. messages not associated with a specific client session (e.g. REST/HTTP request handling method).
public StompBrokerRelayRegistration	setTaskScheduler(TaskScheduler taskScheduler) Some STOMP clients (e.g. stomp-js) always send heartbeats at a fixed rate but others (Spring STOMP client) do so only when no other messages are sent.
public StompBrokerRelayRegistration	setTcpClient(TcpOperations<byte[]> tcpClient) Configure a TCP client for managing TCP connections to the STOMP broker.
public StompBrokerRelayRegistration	setUserDestinationBroadcast(String the destination to broadcast unresolved messages to, e.g. "/topic/unresolved-user-destination" destination) Set a destination to broadcast messages to user destinations that remain unresolved because the user appears not to be connected.
public StompBrokerRelayRegistration	setUserRegistryBroadcast(String the destination for broadcasting user registry details, e.g. "/topic/simp-user-registry". destination) Set a destination to broadcast the content of the local user registry to and to listen for such broadcasts from other servers.
public StompBrokerRelayRegistration	setVirtualHost(String virtualHost) Set the value of the "host" header to use in STOMP CONNECT frames.

Inherited from org.springframework.messaging.simp.config.AbstractBrokerRegistration:: getClientInboundChannel getClientOutboundChannel getDestinationPrefixes

autoStartup	back to summary
private boolean autoStartup

clientLogin	back to summary
private String clientLogin

clientPasscode	back to summary
private String clientPasscode

relayHost	back to summary
private String relayHost

relayPort	back to summary
private int relayPort

systemHeartbeatReceiveInterval	back to summary
private Long systemHeartbeatReceiveInterval Annotations @Nullable

systemHeartbeatSendInterval	back to summary
private Long systemHeartbeatSendInterval Annotations @Nullable

systemLogin	back to summary
private String systemLogin

systemPasscode	back to summary
private String systemPasscode

taskScheduler	back to summary
private TaskScheduler taskScheduler Annotations @Nullable

tcpClient	back to summary
private TcpOperations<byte[]> tcpClient Annotations @Nullable

userDestinationBroadcast	back to summary
private String userDestinationBroadcast Annotations @Nullable

userRegistryBroadcast	back to summary
private String userRegistryBroadcast Annotations @Nullable

virtualHost	back to summary
private String virtualHost Annotations @Nullable

StompBrokerRelayRegistration	back to summary
public StompBrokerRelayRegistration(SubscribableChannel clientInboundChannel, MessageChannel clientOutboundChannel, String[] destinationPrefixes) Create a new `StompBrokerRelayRegistration`. Parameters clientInboundChannel:SubscribableChannel the inbound channel clientOutboundChannel:MessageChannel the outbound channel destinationPrefixes:String[] the destination prefixes

Method Detail

getMessageHandler	back to summary
protected StompBrokerRelayMessageHandler getMessageHandler(SubscribableChannel brokerChannel) Implements abstract org.springframework.messaging.simp.config.AbstractBrokerRegistration.getMessageHandler. Annotations @Override

getMessageHandler

back to summary

protected StompBrokerRelayMessageHandler getMessageHandler(SubscribableChannel brokerChannel)

Implements abstract org.springframework.messaging.simp.config.AbstractBrokerRegistration.getMessageHandler.

Annotations

@Override

getUserDestinationBroadcast	back to summary
protected String getUserDestinationBroadcast() Annotations @Nullable

getUserRegistryBroadcast	back to summary
protected String getUserRegistryBroadcast() Annotations @Nullable

setAutoStartup back to summary

setAutoStartup	back to summary
public StompBrokerRelayRegistration setAutoStartup(boolean autoStartup) Configure whether the `StompBrokerRelayMessageHandler` should start automatically when the Spring ApplicationContext is refreshed. The default setting is `true`.

public StompBrokerRelayRegistration setAutoStartup(boolean autoStartup)

Configure whether the StompBrokerRelayMessageHandler should start automatically when the Spring ApplicationContext is refreshed.

The default setting is true.

setClientLogin	back to summary
public StompBrokerRelayRegistration setClientLogin(String login) Set the login to use when creating connections to the STOMP broker on behalf of connected clients. By default this is set to "guest".

setClientLogin

back to summary

public StompBrokerRelayRegistration setClientLogin(String login)

Set the login to use when creating connections to the STOMP broker on behalf of connected clients.

By default this is set to "guest".

setClientPasscode	back to summary
public StompBrokerRelayRegistration setClientPasscode(String passcode) Set the passcode to use when creating connections to the STOMP broker on behalf of connected clients. By default this is set to "guest".

setClientPasscode

back to summary

public StompBrokerRelayRegistration setClientPasscode(String passcode)

Set the passcode to use when creating connections to the STOMP broker on behalf of connected clients.

By default this is set to "guest".

setRelayHost	back to summary
public StompBrokerRelayRegistration setRelayHost(String relayHost) Set the STOMP message broker host.

setRelayPort	back to summary
public StompBrokerRelayRegistration setRelayPort(int relayPort) Set the STOMP message broker port.

setSystemHeartbeatReceiveInterval	back to summary
public StompBrokerRelayRegistration setSystemHeartbeatReceiveInterval(long heartbeatReceiveInterval) Set the maximum interval, in milliseconds, at which the "system" relay session expects, in the absence of any other data, to receive a heartbeat from the STOMP broker. A value of zero will configure the relay session to expect not to receive heartbeats from the broker. The default value is 10000.

setSystemHeartbeatReceiveInterval

back to summary

public StompBrokerRelayRegistration setSystemHeartbeatReceiveInterval(long heartbeatReceiveInterval)

Set the maximum interval, in milliseconds, at which the "system" relay session expects, in the absence of any other data, to receive a heartbeat from the STOMP broker. A value of zero will configure the relay session to expect not to receive heartbeats from the broker.

The default value is 10000.

setSystemHeartbeatSendInterval	back to summary
public StompBrokerRelayRegistration setSystemHeartbeatSendInterval(long systemHeartbeatSendInterval) Set the interval, in milliseconds, at which the "system" relay session will, in the absence of any other data being sent, send a heartbeat to the STOMP broker. A value of zero will prevent heartbeats from being sent to the broker. The default value is 10000.

setSystemHeartbeatSendInterval

back to summary

public StompBrokerRelayRegistration setSystemHeartbeatSendInterval(long systemHeartbeatSendInterval)

Set the interval, in milliseconds, at which the "system" relay session will, in the absence of any other data being sent, send a heartbeat to the STOMP broker. A value of zero will prevent heartbeats from being sent to the broker.

The default value is 10000.

setSystemLogin	back to summary
public StompBrokerRelayRegistration setSystemLogin(String login) Set the login for the shared "system" connection used to send messages to the STOMP broker from within the application, i.e. messages not associated with a specific client session (e.g. REST/HTTP request handling method). By default this is set to "guest".

setSystemLogin

back to summary

public StompBrokerRelayRegistration setSystemLogin(String login)

Set the login for the shared "system" connection used to send messages to the STOMP broker from within the application, i.e. messages not associated with a specific client session (e.g. REST/HTTP request handling method).

By default this is set to "guest".

setSystemPasscode	back to summary
public StompBrokerRelayRegistration setSystemPasscode(String passcode) Set the passcode for the shared "system" connection used to send messages to the STOMP broker from within the application, i.e. messages not associated with a specific client session (e.g. REST/HTTP request handling method). By default this is set to "guest".

setSystemPasscode

back to summary

public StompBrokerRelayRegistration setSystemPasscode(String passcode)

Set the passcode for the shared "system" connection used to send messages to the STOMP broker from within the application, i.e. messages not associated with a specific client session (e.g. REST/HTTP request handling method).

By default this is set to "guest".

setTaskScheduler back to summary

setTaskScheduler	back to summary
public StompBrokerRelayRegistration setTaskScheduler(TaskScheduler taskScheduler) Some STOMP clients (e.g. stomp-js) always send heartbeats at a fixed rate but others (Spring STOMP client) do so only when no other messages are sent. However messages with a non-broker `destination prefix` aren't forwarded and as a result the broker may deem the connection inactive. When this `TaskScheduler` is set, it is used to reset a count of the number of messages sent from client to broker since the beginning of the current heartbeat period. This is then used to decide whether to send a heartbeat to the broker when ignoring a message with a non-broker destination prefix. Since 5.3

public StompBrokerRelayRegistration setTaskScheduler(TaskScheduler taskScheduler)

Some STOMP clients (e.g. stomp-js) always send heartbeats at a fixed rate but others (Spring STOMP client) do so only when no other messages are sent. However messages with a non-broker destination prefix aren't forwarded and as a result the broker may deem the connection inactive.

When this TaskScheduler is set, it is used to reset a count of the number of messages sent from client to broker since the beginning of the current heartbeat period. This is then used to decide whether to send a heartbeat to the broker when ignoring a message with a non-broker destination prefix.

Since: 5.3

setTcpClient back to summary

setTcpClient	back to summary
public StompBrokerRelayRegistration setTcpClient(TcpOperations<byte[]> tcpClient) Configure a TCP client for managing TCP connections to the STOMP broker. By default `ReactorNettyTcpClient` is used. Note when this property is used, any `host` or `port` specified are effectively ignored. Since 4.3.15

public StompBrokerRelayRegistration setTcpClient(TcpOperations<byte[]> tcpClient)

Configure a TCP client for managing TCP connections to the STOMP broker.

By default ReactorNettyTcpClient is used.

Note

when this property is used, any host or port specified are effectively ignored.

Since: 4.3.15

setUserDestinationBroadcast	back to summary
public StompBrokerRelayRegistration setUserDestinationBroadcast(String destination) Set a destination to broadcast messages to user destinations that remain unresolved because the user appears not to be connected. In a multi-application server scenario this gives other application servers a chance to try. By default this is not set. Parameters destination:String the destination to broadcast unresolved messages to, e.g. "/topic/unresolved-user-destination"

setUserDestinationBroadcast

back to summary

public StompBrokerRelayRegistration setUserDestinationBroadcast(String destination)

Set a destination to broadcast messages to user destinations that remain unresolved because the user appears not to be connected. In a multi-application server scenario this gives other application servers a chance to try.

By default this is not set.

Parameters

destination:String: the destination to broadcast unresolved messages to, e.g. "/topic/unresolved-user-destination"

setUserRegistryBroadcast	back to summary
public StompBrokerRelayRegistration setUserRegistryBroadcast(String destination) Set a destination to broadcast the content of the local user registry to and to listen for such broadcasts from other servers. In a multi-application server scenarios this allows each server's user registry to be aware of users connected to other servers. By default this is not set. Parameters destination:String the destination for broadcasting user registry details, e.g. "/topic/simp-user-registry".

setUserRegistryBroadcast

back to summary

public StompBrokerRelayRegistration setUserRegistryBroadcast(String destination)

Set a destination to broadcast the content of the local user registry to and to listen for such broadcasts from other servers. In a multi-application server scenarios this allows each server's user registry to be aware of users connected to other servers.

By default this is not set.

Parameters

destination:String: the destination for broadcasting user registry details, e.g. "/topic/simp-user-registry".

setVirtualHost	back to summary
public StompBrokerRelayRegistration setVirtualHost(String virtualHost) Set the value of the "host" header to use in STOMP CONNECT frames. When this property is configured, a "host" header will be added to every STOMP frame sent to the STOMP broker. This may be useful for example in a cloud environment where the actual host to which the TCP connection is established is different from the host providing the cloud-based STOMP service. By default this property is not set.

setVirtualHost

back to summary

public StompBrokerRelayRegistration setVirtualHost(String virtualHost)

Set the value of the "host" header to use in STOMP CONNECT frames. When this property is configured, a "host" header will be added to every STOMP frame sent to the STOMP broker. This may be useful for example in a cloud environment where the actual host to which the TCP connection is established is different from the host providing the cloud-based STOMP service.

By default this property is not set.

public Class StompBrokerRelayRegistration

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail