org.springframework.messaging.simp.stomp

Class StompBrokerRelayMessageHandler.SystemStompConnectionHandler

java.lang.Object

org.springframework.messaging.simp.stomp.StompBrokerRelayMessageHandler.StompConnectionHandler

org.springframework.messaging.simp.stomp.StompBrokerRelayMessageHandler.SystemStompConnectionHandler

All Implemented Interfaces:

TcpConnectionHandler<byte[]>

Enclosing class:

StompBrokerRelayMessageHandler

private class StompBrokerRelayMessageHandler.SystemStompConnectionHandler
extends StompBrokerRelayMessageHandler.StompConnectionHandler

Constructor Summary

Constructors

Constructor and Description
SystemStompConnectionHandler(StompHeaderAccessor connectHeaders)

Method Summary

Modifier and Type	Method and Description
void	afterConnectionClosed() Invoked after the connection is closed.
protected void	afterStompConnected(StompHeaderAccessor connectedHeaders) Invoked after the STOMP CONNECTED frame is received.
ListenableFuture<java.lang.Void>	forward(Message<?> message, StompHeaderAccessor accessor) Forward the given message to the STOMP broker.
protected void	handleInboundMessage(Message<?> message)
protected void	handleTcpConnectionFailure(java.lang.String errorMessage, java.lang.Throwable ex) Invoked when any TCP connectivity issue is detected, i.e.
private void	sendSystemSubscriptions()

Methods inherited from class org.springframework.messaging.simp.stomp.StompBrokerRelayMessageHandler.StompConnectionHandler

afterConnected, afterConnectFailure, clearConnection, getSessionId, getTcpConnection, handleFailure, handleMessage, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SystemStompConnectionHandler

public SystemStompConnectionHandler(StompHeaderAccessor connectHeaders)

Method Detail

afterStompConnected

protected void afterStompConnected(StompHeaderAccessor connectedHeaders)

Description copied from class: StompBrokerRelayMessageHandler.StompConnectionHandler

Invoked after the STOMP CONNECTED frame is received. At this point the connection is ready for sending STOMP messages to the broker.

Overrides:

afterStompConnected in class StompBrokerRelayMessageHandler.StompConnectionHandler

sendSystemSubscriptions

private void sendSystemSubscriptions()

handleInboundMessage

protected void handleInboundMessage(Message<?> message)

Overrides:

handleInboundMessage in class StompBrokerRelayMessageHandler.StompConnectionHandler

handleTcpConnectionFailure

protected void handleTcpConnectionFailure(java.lang.String errorMessage,
                                          java.lang.Throwable ex)

Description copied from class: StompBrokerRelayMessageHandler.StompConnectionHandler

Invoked when any TCP connectivity issue is detected, i.e. failure to establish the TCP connection, failure to send a message, missed heartbeat, etc.

Overrides:

handleTcpConnectionFailure in class StompBrokerRelayMessageHandler.StompConnectionHandler

afterConnectionClosed

public void afterConnectionClosed()

Description copied from interface: TcpConnectionHandler

Invoked after the connection is closed.

Specified by:

afterConnectionClosed in interface TcpConnectionHandler<byte[]>

Overrides:

afterConnectionClosed in class StompBrokerRelayMessageHandler.StompConnectionHandler

forward

public ListenableFuture<java.lang.Void> forward(Message<?> message,
                                                StompHeaderAccessor accessor)

Description copied from class: StompBrokerRelayMessageHandler.StompConnectionHandler

Forward the given message to the STOMP broker.

The method checks whether we have an active TCP connection and have received the STOMP CONNECTED frame. For client messages this should be false only if we lose the TCP connection around the same time when a client message is being forwarded, so we simply log the ignored message at debug level. For messages from within the application being sent on the "system" connection an exception is raised so that components sending the message have a chance to handle it -- by default the broker message channel is synchronous.

Note that if messages arrive concurrently around the same time a TCP connection is lost, there is a brief period of time before the connection is reset when one or more messages may sneak through and an attempt made to forward them. Rather than synchronizing to guard against that, this method simply lets them try and fail. For client sessions that may result in an additional STOMP ERROR frame(s) being sent downstream but code handling that downstream should be idempotent in such cases.

Overrides:

forward in class StompBrokerRelayMessageHandler.StompConnectionHandler

Parameters:

message - the message to send (never null)

Returns:

a future to wait for the result