Top Description Constructors Methods
org.springframework.messaging.simp.stomp

public abstract Class StompSessionHandlerAdapter

extends Object
implements StompSessionHandler
Class Inheritance
All Implemented Interfaces
org.springframework.messaging.simp.stomp.StompSessionHandler, org.springframework.messaging.simp.stomp.StompFrameHandler
Imports
java.lang.reflect.Type, org.springframework.lang.Nullable
Abstract adapter class for StompSessionHandler with mostly empty implementation methods except for getPayloadType which returns String as the default Object type expected for STOMP ERROR frame payloads.
Author
Rossen Stoyanchev
Since
4.2

Constructor Summary

AccessConstructor and Description
public
StompSessionHandlerAdapter()

Method Summary

Modifier and TypeMethod and Description
public void
afterConnected(StompSession
the client STOMP session
session, StompHeaders
the STOMP CONNECTED frame headers
connectedHeaders)

Implements org.springframework.messaging.simp.stomp.StompSessionHandler.afterConnected.

This implementation is empty.
public Type
getPayloadType(StompHeaders
the headers of a message
headers)

Implements org.springframework.messaging.simp.stomp.StompFrameHandler.getPayloadType.

This implementation returns String as the expected payload type for STOMP ERROR frames.
public void
handleException(StompSession
the client STOMP session
session, StompCommand
the STOMP command of the frame
command, StompHeaders
the headers
headers, byte[]
the raw payload
payload, Throwable
the exception
exception)

Implements org.springframework.messaging.simp.stomp.StompSessionHandler.handleException.

This implementation is empty.
public void
handleFrame(StompHeaders
the headers of the frame
headers, Object
the payload, or null if there was no payload
payload)

Implements org.springframework.messaging.simp.stomp.StompFrameHandler.handleFrame.

This implementation is empty.
public void
handleTransportError(StompSession
the client STOMP session
session, Throwable
the exception that occurred
exception)

Implements org.springframework.messaging.simp.stomp.StompSessionHandler.handleTransportError.

This implementation is empty.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

StompSessionHandlerAdapterback to summary
public StompSessionHandlerAdapter()

Method Detail

afterConnectedback to summary
public void afterConnected(StompSession session, StompHeaders connectedHeaders)

Implements org.springframework.messaging.simp.stomp.StompSessionHandler.afterConnected.

This implementation is empty.

Parameters
session:StompSession

Doc from org.springframework.messaging.simp.stomp.StompSessionHandler.afterConnected.

the client STOMP session

connectedHeaders:StompHeaders

Doc from org.springframework.messaging.simp.stomp.StompSessionHandler.afterConnected.

the STOMP CONNECTED frame headers

Annotations
@Override
getPayloadTypeback to summary
public Type getPayloadType(StompHeaders headers)

Implements org.springframework.messaging.simp.stomp.StompFrameHandler.getPayloadType.

This implementation returns String as the expected payload type for STOMP ERROR frames.

Parameters
headers:StompHeaders

Doc from org.springframework.messaging.simp.stomp.StompFrameHandler.getPayloadType.

the headers of a message

Annotations
@Override
handleExceptionback to summary
public void handleException(StompSession session, StompCommand command, StompHeaders headers, byte[] payload, Throwable exception)

Implements org.springframework.messaging.simp.stomp.StompSessionHandler.handleException.

This implementation is empty.

Parameters
session:StompSession

Doc from org.springframework.messaging.simp.stomp.StompSessionHandler.handleException.

the client STOMP session

command:StompCommand

Doc from org.springframework.messaging.simp.stomp.StompSessionHandler.handleException.

the STOMP command of the frame

headers:StompHeaders

Doc from org.springframework.messaging.simp.stomp.StompSessionHandler.handleException.

the headers

payload:byte[]

Doc from org.springframework.messaging.simp.stomp.StompSessionHandler.handleException.

the raw payload

exception:Throwable

Doc from org.springframework.messaging.simp.stomp.StompSessionHandler.handleException.

the exception

Annotations
@Override
handleFrameback to summary
public void handleFrame(StompHeaders headers, Object payload)

Implements org.springframework.messaging.simp.stomp.StompFrameHandler.handleFrame.

This implementation is empty.

Parameters
headers:StompHeaders

Doc from org.springframework.messaging.simp.stomp.StompFrameHandler.handleFrame.

the headers of the frame

payload:Object

Doc from org.springframework.messaging.simp.stomp.StompFrameHandler.handleFrame.

the payload, or null if there was no payload

Annotations
@Override
handleTransportErrorback to summary
public void handleTransportError(StompSession session, Throwable exception)

Implements org.springframework.messaging.simp.stomp.StompSessionHandler.handleTransportError.

This implementation is empty.

Parameters
session:StompSession

Doc from org.springframework.messaging.simp.stomp.StompSessionHandler.handleTransportError.

the client STOMP session

exception:Throwable

Doc from org.springframework.messaging.simp.stomp.StompSessionHandler.handleTransportError.

the exception that occurred

Annotations
@Override