Package org.springframework.web.socket.messaging

Class StompSubProtocolHandler

java.lang.Object

org.springframework.web.socket.messaging.StompSubProtocolHandler

All Implemented Interfaces:

Aware, ApplicationEventPublisherAware, SubProtocolHandler

public class StompSubProtocolHandler
extends Object
implements SubProtocolHandler, ApplicationEventPublisherAware

A SubProtocolHandler for STOMP that supports versions 1.0, 1.1, and 1.2 of the STOMP specification.

Since:

4.0

Author:

Rossen Stoyanchev, Andy Wilkinson

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StompSubProtocolHandler.Stats	Contract for access to session counters.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONNECTED_USER_HEADER	The name of the header set on the CONNECTED frame indicating the name of the user authenticated on the WebSocket session.
static final int	MINIMUM_WEBSOCKET_MESSAGE_SIZE	This handler supports assembling large STOMP messages split into multiple WebSocket messages and STOMP clients (like stomp.js) indeed split large STOMP messages at 16K boundaries.

Constructor Summary

Constructors

Constructor	Description
StompSubProtocolHandler()

Method Summary

Modifier and Type

Method

Description

void

afterSessionEnded(WebSocketSession session, CloseStatus closeStatus, MessageChannel outputChannel)

Invoked after a WebSocketSession has ended.

void

afterSessionStarted(WebSocketSession session, MessageChannel outputChannel)

Invoked after a WebSocketSession has started.

StompSubProtocolErrorHandler

getErrorHandler()

Return the configured error handler.

MessageHeaderInitializer

getHeaderInitializer()

Return the configured header initializer.

int

getMessageSizeLimit()

Get the configured message buffer size limit in bytes.

StompSubProtocolHandler.Stats

getStats()

Return a structured object with internal state and counters.