DefaultStompSession

java.lang.Object
- org.springframework.messaging.simp.stomp.DefaultStompSession

All Implemented Interfaces:

ConnectionHandlingStompSession, StompSession, TcpConnectionHandler<byte[]>
```
public class DefaultStompSession
extends java.lang.Object
implements ConnectionHandlingStompSession
```
Default implementation of ConnectionHandlingStompSession.

Since:

4.2

Author:

Rossen Stoyanchev

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private class`	`DefaultStompSession.DefaultSubscription`
`private class`	`DefaultStompSession.ReadInactivityTask`
`private class`	`DefaultStompSession.ReceiptHandler`
`private class`	`DefaultStompSession.WriteInactivityTask`

Nested classes/interfaces inherited from interface org.springframework.messaging.simp.stomp.StompSession
StompSession.Receiptable, StompSession.Subscription

Field Summary

Fields
Modifier and Type	Field and Description
`private boolean`	`autoReceiptEnabled`
`private boolean`	`closing`
`private StompHeaders`	`connectHeaders`
`private TcpConnection<byte[]>`	`connection`
`private MessageConverter`	`converter`
`static byte[]`	`EMPTY_PAYLOAD`
`private static Message<byte[]>`	`HEARTBEAT`
`private static long`	`HEARTBEAT_MULTIPLIER`
`private static IdGenerator`	`idGenerator`
`private static Log`	`logger`
`private java.util.Map<java.lang.String,DefaultStompSession.ReceiptHandler>`	`receiptHandlers`
`private java.util.concurrent.atomic.AtomicInteger`	`receiptIndex`
`private long`	`receiptTimeLimit`
`private SettableListenableFuture<StompSession>`	`sessionFuture`
`private StompSessionHandler`	`sessionHandler`
`private java.lang.String`	`sessionId`
`private java.util.concurrent.atomic.AtomicInteger`	`subscriptionIndex`
`private java.util.Map<java.lang.String,DefaultStompSession.DefaultSubscription>`	`subscriptions`
`private TaskScheduler`	`taskScheduler`

Constructor Summary

Constructors
Constructor and Description

DefaultStompSession(StompSessionHandler sessionHandler, StompHeaders connectHeaders)
Create a new session.

Constructors
Constructor and Description
`DefaultStompSession(StompSessionHandler sessionHandler, StompHeaders connectHeaders)` Create a new session.

Method Summary

All Methods Instance Methods Concrete Methods
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 java.lang.String`	`checkOrAddReceipt(StompHeaders stompHeaders)`
`private StompHeaderAccessor`	`createHeaderAccessor(StompCommand command)`
`private Message<byte[]>`	`createMessage(StompHeaderAccessor accessor, java.lang.Object payload)`
`void`	`disconnect()` Disconnect the session by sending a DISCONNECT frame.
`private void`	`execute(Message<byte[]> message)`
`MessageConverter`	`getMessageConverter()` Return the configured `MessageConverter`.
`long`	`getReceiptTimeLimit()` Return the configured time limit before a receipt expires.
`ListenableFuture<StompSession>`	`getSessionFuture()` Return a future that will complete when the session is ready for use.
`StompSessionHandler`	`getSessionHandler()` Return the configured session handler.
`java.lang.String`	`getSessionId()` Return the id for the session.
`TaskScheduler`	`getTaskScheduler()` Return the configured TaskScheduler to use for receipt tracking.
`void`	`handleFailure(java.lang.Throwable ex)` Handle a failure on the connection.
`void`	`handleMessage(Message<byte[]> message)` Handle a message received from the remote host.
`private void`	`initHeartbeatTasks(StompHeaders connectedHeaders)`
`private void`	`invokeHandler(StompFrameHandler handler, Message<byte[]> message, StompHeaders stompHeaders)`
`boolean`	`isAutoReceiptEnabled()` Whether receipt headers should be automatically added.
`boolean`	`isConnected()` Whether the session is connected.
`private void`	`resetConnection()`
`StompSession.Receiptable`	`send(StompHeaders stompHeaders, java.lang.Object payload)` An overloaded version of `StompSession.send(String, Object)` that accepts full `StompHeaders` instead of a destination.
`StompSession.Receiptable`	`send(java.lang.String destination, java.lang.Object payload)` Send a message to the specified destination, converting the payload to a `byte[]` with the help of a `MessageConverter`.
`void`	`setAutoReceipt(boolean autoReceiptEnabled)` When enabled, a receipt header is automatically added to future `send` and `subscribe` operations on this session, which causes the server to return a RECEIPT.
`void`	`setMessageConverter(MessageConverter messageConverter)` Set the `MessageConverter` to use to convert the payload of incoming and outgoing messages to and from `byte[]` based on object type, or expected object type, and the "content-type" header.
`void`	`setReceiptTimeLimit(long receiptTimeLimit)` Configure the time in milliseconds before a receipt expires.
`void`	`setTaskScheduler(TaskScheduler taskScheduler)` Configure the TaskScheduler to use for receipt tracking.
`StompSession.Subscription`	`subscribe(StompHeaders stompHeaders, StompFrameHandler handler)` An overloaded version of `StompSession.subscribe(String, StompFrameHandler)` that accepts full `StompHeaders` rather instead of a destination.
`StompSession.Subscription`	`subscribe(java.lang.String destination, StompFrameHandler handler)` Subscribe to the given destination by sending a SUBSCRIBE frame and handle received messages with the specified `StompFrameHandler`.
`private void`	`unsubscribe(java.lang.String id)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - logger
```
private static Log logger
```
  - idGenerator
```
private static final IdGenerator idGenerator
```
  - EMPTY_PAYLOAD
```
public static final byte[] EMPTY_PAYLOAD
```
  - HEARTBEAT_MULTIPLIER
```
private static final long HEARTBEAT_MULTIPLIER
```
    See Also:
    
    Constant Field Values
  - HEARTBEAT
```
private static final Message<byte[]> HEARTBEAT
```
  - sessionId
```
private final java.lang.String sessionId
```
  - sessionHandler
```
private final StompSessionHandler sessionHandler
```
  - connectHeaders
```
private final StompHeaders connectHeaders
```
  - sessionFuture
```
private final SettableListenableFuture<StompSession> sessionFuture
```
  - converter
```
private MessageConverter converter
```
  - taskScheduler
```
private TaskScheduler taskScheduler
```
  - receiptTimeLimit
```
private long receiptTimeLimit
```
  - autoReceiptEnabled
```
private volatile boolean autoReceiptEnabled
```
  - connection
```
private volatile TcpConnection<byte[]> connection
```
  - subscriptionIndex
```
private final java.util.concurrent.atomic.AtomicInteger subscriptionIndex
```
  - subscriptions
```
private final java.util.Map<java.lang.String,DefaultStompSession.DefaultSubscription> subscriptions
```
  - receiptIndex
```
private final java.util.concurrent.atomic.AtomicInteger receiptIndex
```
  - receiptHandlers
```
private final java.util.Map<java.lang.String,DefaultStompSession.ReceiptHandler> receiptHandlers
```
  - closing
```
private volatile boolean closing
```
- Constructor Detail
  - DefaultStompSession
```
public DefaultStompSession(StompSessionHandler sessionHandler,
                           StompHeaders connectHeaders)
```
    Create a new session.
    
    Parameters:
    
    sessionHandler - the application handler for the session
    
    connectHeaders - headers for the STOMP CONNECT frame
- Method Detail
  - getSessionId
```
public java.lang.String getSessionId()
```
    Description copied from interface: StompSession
    
    Return the id for the session.
    
    Specified by:
    
    getSessionId in interface StompSession
  - getSessionHandler
```
public StompSessionHandler getSessionHandler()
```
    Return the configured session handler.
  - getSessionFuture
```
public ListenableFuture<StompSession> getSessionFuture()
```
    Description copied from interface: ConnectionHandlingStompSession
    
    Return a future that will complete when the session is ready for use.
    
    Specified by:
    
    getSessionFuture in interface ConnectionHandlingStompSession
  - setMessageConverter
```
public void setMessageConverter(MessageConverter messageConverter)
```
    Set the MessageConverter to use to convert the payload of incoming and outgoing messages to and from byte[] based on object type, or expected object type, and the "content-type" header.
    By default, SimpleMessageConverter is configured.
    
    Parameters:
    
    messageConverter - the message converter to use
  - getMessageConverter
```
public MessageConverter getMessageConverter()
```
    Return the configured MessageConverter.
  - setTaskScheduler
```
public void setTaskScheduler(TaskScheduler taskScheduler)
```
    Configure the TaskScheduler to use for receipt tracking.
  - getTaskScheduler
```
public TaskScheduler getTaskScheduler()
```
    Return the configured TaskScheduler to use for receipt tracking.
  - setReceiptTimeLimit
```
public void setReceiptTimeLimit(long receiptTimeLimit)
```
    Configure the time in milliseconds before a receipt expires.
    By default set to 15,000 (15 seconds).
  - getReceiptTimeLimit
```
public long getReceiptTimeLimit()
```
    Return the configured time limit before a receipt expires.
  - setAutoReceipt
```
public void setAutoReceipt(boolean autoReceiptEnabled)
```
    Description copied from interface: StompSession
    
    When enabled, a receipt header is automatically added to future send and subscribe operations on this session, which causes the server to return a RECEIPT. An application can then use the Receiptable returned from the operation to track the receipt.
    A receipt header can also be added manually through the overloaded methods that accept StompHeaders.
    
    Specified by:
    
    setAutoReceipt in interface StompSession
  - isAutoReceiptEnabled
```
public boolean isAutoReceiptEnabled()
```
    Whether receipt headers should be automatically added.
  - isConnected
```
public boolean isConnected()
```
    Description copied from interface: StompSession
    
    Whether the session is connected.
    
    Specified by:
    
    isConnected in interface StompSession
  - send
```
public StompSession.Receiptable send(java.lang.String destination,
                                     java.lang.Object payload)
```
    Description copied from interface: StompSession
    
    Send a message to the specified destination, converting the payload to a byte[] with the help of a MessageConverter.
    
    Specified by:
    
    send in interface StompSession
    
    Parameters:
    
    destination - the destination to send a message to
    
    payload - the message payload
    
    Returns:
    
    a Receiptable for tracking receipts
  - send
```
public StompSession.Receiptable send(StompHeaders stompHeaders,
                                     java.lang.Object payload)
```
    Description copied from interface: StompSession
    
    An overloaded version of StompSession.send(String, Object) that accepts full StompHeaders instead of a destination. The headers must contain a destination and may also have other headers such as "content-type" or custom headers for the broker to propagate to subscribers, or broker-specific, non-standard headers..
    
    Specified by:
    
    send in interface StompSession
    
    Parameters:
    
    stompHeaders - the message headers
    
    payload - the message payload
    
    Returns:
    
    a Receiptable for tracking receipts
  - checkOrAddReceipt
```
private java.lang.String checkOrAddReceipt(StompHeaders stompHeaders)
```
  - createHeaderAccessor
```
private StompHeaderAccessor createHeaderAccessor(StompCommand command)
```
  - createMessage
```
private Message<byte[]> createMessage(StompHeaderAccessor accessor,
                                      java.lang.Object payload)
```
  - execute
```
private void execute(Message<byte[]> message)
```
  - subscribe
```
public StompSession.Subscription subscribe(java.lang.String destination,
                                           StompFrameHandler handler)
```
    Description copied from interface: StompSession
    
    Subscribe to the given destination by sending a SUBSCRIBE frame and handle received messages with the specified StompFrameHandler.
    
    Specified by:
    
    subscribe in interface StompSession
    
    Parameters:
    
    destination - the destination to subscribe to
    
    handler - the handler for received messages
    
    Returns:
    
    a handle to use to unsubscribe and/or track receipts
  - subscribe
```
public StompSession.Subscription subscribe(StompHeaders stompHeaders,
                                           StompFrameHandler handler)
```
    Description copied from interface: StompSession
    
    An overloaded version of StompSession.subscribe(String, StompFrameHandler) that accepts full StompHeaders rather instead of a destination.
    
    Specified by:
    
    subscribe in interface StompSession
    
    Parameters:
    
    stompHeaders - the headers for the subscribe message frame
    
    handler - the handler for received messages
    
    Returns:
    
    a handle to use to unsubscribe and/or track receipts
  - unsubscribe
```
private void unsubscribe(java.lang.String id)
```
  - disconnect
```
public void disconnect()
```
    Description copied from interface: StompSession
    
    Disconnect the session by sending a DISCONNECT frame.
    
    Specified by:
    
    disconnect in interface StompSession
  - 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
  - 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
  - invokeHandler
```
private void invokeHandler(StompFrameHandler handler,
                           Message<byte[]> message,
                           StompHeaders stompHeaders)
```
  - initHeartbeatTasks
```
private void initHeartbeatTasks(StompHeaders 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[]>
  - resetConnection
```
private void resetConnection()
```

Class DefaultStompSession

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.messaging.simp.stomp.StompSession

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

idGenerator

EMPTY_PAYLOAD

HEARTBEAT_MULTIPLIER

HEARTBEAT

sessionId

sessionHandler

connectHeaders

sessionFuture

converter

taskScheduler

receiptTimeLimit

autoReceiptEnabled

connection

subscriptionIndex

subscriptions

receiptIndex

receiptHandlers

closing

Constructor Detail

DefaultStompSession

Method Detail

getSessionId

getSessionHandler

getSessionFuture

setMessageConverter

getMessageConverter

setTaskScheduler

getTaskScheduler

setReceiptTimeLimit

getReceiptTimeLimit

setAutoReceipt

isAutoReceiptEnabled

isConnected

send

send

checkOrAddReceipt

createHeaderAccessor

createMessage

execute

subscribe

subscribe

unsubscribe

disconnect

afterConnected

afterConnectFailure

handleMessage

invokeHandler

initHeartbeatTasks

handleFailure

afterConnectionClosed

resetConnection