org.springframework.messaging.simp.stomp

Class StompBrokerRelayMessageHandler.StompConnectionHandler

java.lang.Object

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

All Implemented Interfaces:

TcpConnectionHandler<byte[]>

Direct Known Subclasses:

StompBrokerRelayMessageHandler.SystemStompConnectionHandler

Enclosing class:

StompBrokerRelayMessageHandler

private class StompBrokerRelayMessageHandler.StompConnectionHandler
extends java.lang.Object
implements TcpConnectionHandler<byte[]>

Field Summary

Fields

Modifier and Type	Field and Description
private StompHeaderAccessor	connectHeaders
private boolean	isRemoteClientSession
private boolean	isStompConnected
private java.lang.String	sessionId
private TcpConnection<byte[]>	tcpConnection

Constructor Summary

Constructors

Modifier	Constructor and Description
private	StompConnectionHandler(java.lang.String sessionId, StompHeaderAccessor connectHeaders)
private	StompConnectionHandler(java.lang.String sessionId, StompHeaderAccessor connectHeaders, boolean isClientSession)

Method Summary

Modifier and Type	Method and Description
void	afterConnected(TcpConnection<byte[]> connection) Invoked after a connection is successfully established.
void	afterConnectFailure(java.lang.Throwable ex) Invoked on failure to connect.
void	afterConnectionClosed() Invoked after the connection is closed.
private void	afterDisconnectSent(StompHeaderAccessor accessor) After a DISCONNECT there should be no more client frames so we can close the connection pro-actively.
protected void	afterStompConnected(StompHeaderAccessor connectedHeaders) Invoked after the STOMP CONNECTED frame is received.
void	clearConnection() Clean up state associated with the connection and close it.
ListenableFuture<java.lang.Void>	forward(Message<?> message, StompHeaderAccessor accessor) Forward the given message to the STOMP broker.
java.lang.String	getSessionId()
protected TcpConnection<byte[]>	getTcpConnection()
void	handleFailure(java.lang.Throwable ex) Handle a failure on the connection.
protected void	handleInboundMessage(Message<?> message)
void	handleMessage(Message<byte[]> message) Handle a message received from the remote host.
protected void	handleTcpConnectionFailure(java.lang.String error, java.lang.Throwable ex) Invoked when any TCP connectivity issue is detected, i.e.
private void	initHeartbeats(StompHeaderAccessor connectedHeaders)
private void	sendStompErrorFrameToClient(java.lang.String errorText)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

sessionId

private final java.lang.String sessionId

isRemoteClientSession

private final boolean isRemoteClientSession

connectHeaders

private final StompHeaderAccessor connectHeaders

tcpConnection

private volatile TcpConnection<byte[]> tcpConnection

isStompConnected

private volatile boolean isStompConnected

Constructor Detail

StompConnectionHandler

private StompConnectionHandler(java.lang.String sessionId,
                               StompHeaderAccessor connectHeaders)

StompConnectionHandler

private StompConnectionHandler(java.lang.String sessionId,
                               StompHeaderAccessor connectHeaders,
                               boolean isClientSession)

Method Detail

getSessionId

public java.lang.String getSessionId()

getTcpConnection

protected TcpConnection<byte[]> getTcpConnection()

afterConnected

public void afterConnected(TcpConnection<byte[]> connection)

Description copied from interface: TcpConnectionHandler

Invoked after a connection is successfully established.

Specified by:

afterConnected in interface TcpConnectionHandler<byte[]>

Parameters:

connection - the connection

afterConnectFailure

public void afterConnectFailure(java.lang.Throwable ex)

Description copied from interface: TcpConnectionHandler

Invoked on failure to connect.

Specified by:

afterConnectFailure in interface TcpConnectionHandler<byte[]>

Parameters:

ex - the exception

handleTcpConnectionFailure

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

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

sendStompErrorFrameToClient

private void sendStompErrorFrameToClient(java.lang.String errorText)

handleInboundMessage

protected void handleInboundMessage(Message<?> message)

handleMessage

public void handleMessage(Message<byte[]> message)

Description copied from interface: TcpConnectionHandler

Handle a message received from the remote host.

Specified by:

handleMessage in interface TcpConnectionHandler<byte[]>

Parameters:

message - the message

afterStompConnected

protected void afterStompConnected(StompHeaderAccessor connectedHeaders)

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

initHeartbeats

private void initHeartbeats(StompHeaderAccessor connectedHeaders)

handleFailure

public void handleFailure(java.lang.Throwable ex)

Description copied from interface: TcpConnectionHandler

Handle a failure on the connection.

Specified by:

handleFailure in interface TcpConnectionHandler<byte[]>

Parameters:

ex - the exception

afterConnectionClosed

public void afterConnectionClosed()

Description copied from interface: TcpConnectionHandler

Invoked after the connection is closed.

Specified by:

afterConnectionClosed in interface TcpConnectionHandler<byte[]>

forward

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

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.

Parameters:

message - the message to send (never null)

Returns:

a future to wait for the result

afterDisconnectSent

private void afterDisconnectSent(StompHeaderAccessor accessor)

After a DISCONNECT there should be no more client frames so we can close the connection pro-actively. However, if the DISCONNECT has a receipt header we leave the connection open and expect the server will respond with a RECEIPT and then close the connection.

See Also:

STOMP Specification 1.2 DISCONNECT

clearConnection

public void clearConnection()

Clean up state associated with the connection and close it. Any exception arising from closing the connection are propagated.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object