Index

A B C D E F G H I J K L M N O P R S T U V W X
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AbstractClientSockJsSession - Class in org.springframework.web.socket.sockjs.client

Base class for SockJS client implementations of WebSocketSession.

AbstractClientSockJsSession(TransportRequest, WebSocketHandler, CompletableFuture<WebSocketSession>) - Constructor for class org.springframework.web.socket.sockjs.client.AbstractClientSockJsSession

AbstractClientSockJsSession(TransportRequest, WebSocketHandler, SettableListenableFuture<WebSocketSession>) - Constructor for class org.springframework.web.socket.sockjs.client.AbstractClientSockJsSession

Deprecated.

as of 6.0, in favor of AbstractClientSockJsSession(TransportRequest, WebSocketHandler, CompletableFuture)

AbstractHandshakeHandler - Class in org.springframework.web.socket.server.support

A base class for HandshakeHandler implementations, independent of the Servlet API.

AbstractHandshakeHandler() - Constructor for class org.springframework.web.socket.server.support.AbstractHandshakeHandler

Default constructor that auto-detects and instantiates a RequestUpgradeStrategy suitable for the runtime container.

AbstractHandshakeHandler(RequestUpgradeStrategy) - Constructor for class org.springframework.web.socket.server.support.AbstractHandshakeHandler

A constructor that accepts a runtime-specific RequestUpgradeStrategy.

AbstractHttpReceivingTransportHandler - Class in org.springframework.web.socket.sockjs.transport.handler

Base class for HTTP transport handlers that receive messages via HTTP POST.

AbstractHttpReceivingTransportHandler() - Constructor for class org.springframework.web.socket.sockjs.transport.handler.AbstractHttpReceivingTransportHandler

AbstractHttpSendingTransportHandler - Class in org.springframework.web.socket.sockjs.transport.handler

Base class for HTTP transport handlers that push messages to connected clients.

AbstractHttpSendingTransportHandler() - Constructor for class org.springframework.web.socket.sockjs.transport.handler.AbstractHttpSendingTransportHandler

AbstractHttpSockJsSession - Class in org.springframework.web.socket.sockjs.transport.session

An abstract base class for use with HTTP transport SockJS sessions.

AbstractHttpSockJsSession(String, SockJsServiceConfig, WebSocketHandler, Map<String, Object>) - Constructor for class org.springframework.web.socket.sockjs.transport.session.AbstractHttpSockJsSession

AbstractSockJsMessageCodec - Class in org.springframework.web.socket.sockjs.frame

A base class for SockJS message codec that provides an implementation of AbstractSockJsMessageCodec.encode(String[]).

AbstractSockJsMessageCodec() - Constructor for class org.springframework.web.socket.sockjs.frame.AbstractSockJsMessageCodec

AbstractSockJsService - Class in org.springframework.web.socket.sockjs.support

An abstract base class for SockJsService implementations that provides SockJS path resolution and handling of static SockJS requests (e.g.

AbstractSockJsService(TaskScheduler) - Constructor for class org.springframework.web.socket.sockjs.support.AbstractSockJsService

AbstractSockJsSession - Class in org.springframework.web.socket.sockjs.transport.session

An abstract base class for SockJS sessions implementing SockJsSession.

AbstractSockJsSession(String, SockJsServiceConfig, WebSocketHandler, Map<String, Object>) - Constructor for class org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession

Create a new instance.

AbstractStandardUpgradeStrategy - Class in org.springframework.web.socket.server.standard

A base class for RequestUpgradeStrategy implementations that build on the standard WebSocket API for Java (JSR-356).

AbstractStandardUpgradeStrategy() - Constructor for class org.springframework.web.socket.server.standard.AbstractStandardUpgradeStrategy

AbstractSubProtocolEvent - Class in org.springframework.web.socket.messaging

A base class for events for a message received from a WebSocket client and parsed into a higher-level sub-protocol (e.g.

AbstractSubProtocolEvent(Object, Message<byte[]>) - Constructor for class org.springframework.web.socket.messaging.AbstractSubProtocolEvent

Create a new AbstractSubProtocolEvent.

AbstractSubProtocolEvent(Object, Message<byte[]>, Principal) - Constructor for class org.springframework.web.socket.messaging.AbstractSubProtocolEvent

Create a new AbstractSubProtocolEvent.

AbstractTransportHandler - Class in org.springframework.web.socket.sockjs.transport.handler

Common base class for TransportHandler implementations.

AbstractTransportHandler() - Constructor for class org.springframework.web.socket.sockjs.transport.handler.AbstractTransportHandler

AbstractTyrusRequestUpgradeStrategy - Class in org.springframework.web.socket.server.standard

A base class for RequestUpgradeStrategy implementations on top of JSR-356 based servers which include Tyrus as their WebSocket engine.

AbstractTyrusRequestUpgradeStrategy() - Constructor for class org.springframework.web.socket.server.standard.AbstractTyrusRequestUpgradeStrategy

AbstractWebSocketClient - Class in org.springframework.web.socket.client

Abstract base class for WebSocketClient implementations.

AbstractWebSocketClient() - Constructor for class org.springframework.web.socket.client.AbstractWebSocketClient

AbstractWebSocketHandler - Class in org.springframework.web.socket.handler

A convenient base class for WebSocketHandler implementation with empty methods.

AbstractWebSocketHandler() - Constructor for class org.springframework.web.socket.handler.AbstractWebSocketHandler

AbstractWebSocketHandlerRegistration<M> - Class in org.springframework.web.socket.config.annotation

Base class for WebSocketHandlerRegistrations that gathers all the configuration options but allows subclasses to put together the actual HTTP request mappings.

AbstractWebSocketHandlerRegistration() - Constructor for class org.springframework.web.socket.config.annotation.AbstractWebSocketHandlerRegistration

AbstractWebSocketMessage<T> - Class in org.springframework.web.socket

A message that can be handled or sent on a WebSocket connection.

AbstractWebSocketSession<T> - Class in org.springframework.web.socket.adapter

An abstract base class for implementations of WebSocketSession.

AbstractWebSocketSession(Map<String, Object>) - Constructor for class org.springframework.web.socket.adapter.AbstractWebSocketSession

Create a new instance and associate the given attributes with it.

AbstractXhrTransport - Class in org.springframework.web.socket.sockjs.client

Abstract base class for XHR transport implementations to extend.

AbstractXhrTransport() - Constructor for class org.springframework.web.socket.sockjs.client.AbstractXhrTransport

add(String, String) - Method in class org.springframework.web.socket.WebSocketHttpHeaders

Add the given, single header value under the given name.

addArgumentResolvers(List<HandlerMethodArgumentResolver>) - Method in class org.springframework.web.socket.config.annotation.DelegatingWebSocketMessageBrokerConfiguration

addArgumentResolvers(List<HandlerMethodArgumentResolver>) - Method in interface org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurer

Add resolvers to support custom controller method argument types.

addCacheHeaders(ServerHttpResponse) - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService

addDecoratorFactory(WebSocketHandlerDecoratorFactory) - Method in class org.springframework.web.socket.config.annotation.WebSocketTransportRegistration

Add a factory that to decorate the handler used to process WebSocket messages.

addEndpoint(String...) - Method in interface org.springframework.web.socket.config.annotation.StompEndpointRegistry

Register a STOMP over WebSocket endpoint at the given mapping path.

addEndpoint(String...) - Method in class org.springframework.web.socket.config.annotation.WebMvcStompEndpointRegistry

addHandler(WebSocketHandler, String...) - Method in class org.springframework.web.socket.config.annotation.AbstractWebSocketHandlerRegistration

addHandler(WebSocketHandler, String...) - Method in class org.springframework.web.socket.config.annotation.ServletWebSocketHandlerRegistry

addHandler(WebSocketHandler, String...) - Method in interface org.springframework.web.socket.config.annotation.WebSocketHandlerRegistration

Add more handlers that will share the same configuration (interceptors, SockJS config, etc).

addHandler(WebSocketHandler, String...) - Method in interface org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry

Configure a WebSocketHandler at the specified URL paths.

addInterceptors(HandshakeInterceptor...) - Method in class org.springframework.web.socket.config.annotation.AbstractWebSocketHandlerRegistration

addInterceptors(HandshakeInterceptor...) - Method in interface org.springframework.web.socket.config.annotation.StompWebSocketEndpointRegistration

Configure the HandshakeInterceptor's to use.

addInterceptors(HandshakeInterceptor...) - Method in class org.springframework.web.socket.config.annotation.WebMvcStompWebSocketEndpointRegistration

addInterceptors(HandshakeInterceptor...) - Method in interface org.springframework.web.socket.config.annotation.WebSocketHandlerRegistration

Configure interceptors for the handshake request.

addNoCacheHeaders(ServerHttpResponse) - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService

addProtocolHandler(SubProtocolHandler) - Method in class org.springframework.web.socket.messaging.SubProtocolWebSocketHandler

Register a sub-protocol handler.

addReturnValueHandlers(List<HandlerMethodReturnValueHandler>) - Method in class org.springframework.web.socket.config.annotation.DelegatingWebSocketMessageBrokerConfiguration

addReturnValueHandlers(List<HandlerMethodReturnValueHandler>) - Method in interface org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurer

Add handlers to support custom controller method return value types.

addSockJsServiceMapping(M, SockJsService, WebSocketHandler, String) - Method in class org.springframework.web.socket.config.annotation.AbstractWebSocketHandlerRegistration

addSockJsServiceMapping(MultiValueMap<HttpRequestHandler, String>, SockJsService, WebSocketHandler, String) - Method in class org.springframework.web.socket.config.annotation.ServletWebSocketHandlerRegistration

addTimeoutTask(Runnable) - Method in interface org.springframework.web.socket.sockjs.client.TransportRequest

Register a timeout cleanup task to invoke if the SockJS session is not fully established within the calculated retransmission timeout period.

addWebSocketHandlerMapping(M, WebSocketHandler, HandshakeHandler, HandshakeInterceptor[], String) - Method in class org.springframework.web.socket.config.annotation.AbstractWebSocketHandlerRegistration

addWebSocketHandlerMapping(MultiValueMap<HttpRequestHandler, String>, WebSocketHandler, HandshakeHandler, HandshakeInterceptor[], String) - Method in class org.springframework.web.socket.config.annotation.ServletWebSocketHandlerRegistration

afterConnectionClosed(WebSocketSession, CloseStatus) - Method in class org.springframework.web.socket.handler.AbstractWebSocketHandler

afterConnectionClosed(WebSocketSession, CloseStatus) - Method in class org.springframework.web.socket.handler.ExceptionWebSocketHandlerDecorator

afterConnectionClosed(WebSocketSession, CloseStatus) - Method in class org.springframework.web.socket.handler.LoggingWebSocketHandlerDecorator

afterConnectionClosed(WebSocketSession, CloseStatus) - Method in class org.springframework.web.socket.handler.PerConnectionWebSocketHandler

afterConnectionClosed(WebSocketSession, CloseStatus) - Method in class org.springframework.web.socket.handler.WebSocketHandlerDecorator

afterConnectionClosed(WebSocketSession, CloseStatus) - Method in class org.springframework.web.socket.messaging.SubProtocolWebSocketHandler

afterConnectionClosed(WebSocketSession, CloseStatus) - Method in class org.springframework.web.socket.sockjs.transport.handler.SockJsWebSocketHandler

afterConnectionClosed(WebSocketSession, CloseStatus) - Method in interface org.springframework.web.socket.WebSocketHandler

Invoked after the WebSocket connection has been closed by either side, or after a transport error has occurred.

afterConnectionEstablished(WebSocketSession) - Method in class org.springframework.web.socket.handler.AbstractWebSocketHandler

afterConnectionEstablished(WebSocketSession) - Method in class org.springframework.web.socket.handler.ExceptionWebSocketHandlerDecorator

afterConnectionEstablished(WebSocketSession) - Method in class org.springframework.web.socket.handler.LoggingWebSocketHandlerDecorator

afterConnectionEstablished(WebSocketSession) - Method in class org.springframework.web.socket.handler.PerConnectionWebSocketHandler

afterConnectionEstablished(WebSocketSession) - Method in class org.springframework.web.socket.handler.WebSocketHandlerDecorator

afterConnectionEstablished(WebSocketSession) - Method in class org.springframework.web.socket.messaging.SubProtocolWebSocketHandler

afterConnectionEstablished(WebSocketSession) - Method in class org.springframework.web.socket.sockjs.transport.handler.SockJsWebSocketHandler

afterConnectionEstablished(WebSocketSession) - Method in interface org.springframework.web.socket.WebSocketHandler

Invoked after WebSocket negotiation has succeeded and the WebSocket connection is opened and ready for use.

afterHandshake(ServerHttpRequest, ServerHttpResponse, WebSocketHandler, Exception) - Method in interface org.springframework.web.socket.server.HandshakeInterceptor

Invoked after the handshake is done.

afterHandshake(ServerHttpRequest, ServerHttpResponse, WebSocketHandler, Exception) - Method in class org.springframework.web.socket.server.support.HttpSessionHandshakeInterceptor

afterHandshake(ServerHttpRequest, ServerHttpResponse, WebSocketHandler, Exception) - Method in class org.springframework.web.socket.server.support.OriginHandshakeInterceptor

afterPropertiesSet() - Method in class org.springframework.web.socket.messaging.WebSocketAnnotationMethodMessageHandler

afterPropertiesSet() - Method in class org.springframework.web.socket.server.standard.ServerEndpointExporter

afterPropertiesSet() - Method in class org.springframework.web.socket.server.standard.ServletServerContainerFactoryBean

afterSessionEnded(WebSocketSession, CloseStatus, MessageChannel) - Method in class org.springframework.web.socket.messaging.StompSubProtocolHandler

afterSessionEnded(WebSocketSession, CloseStatus, MessageChannel) - Method in interface org.springframework.web.socket.messaging.SubProtocolHandler

Invoked after a WebSocketSession has ended.

afterSessionStarted(WebSocketSession, MessageChannel) - Method in class org.springframework.web.socket.messaging.StompSubProtocolHandler

afterSessionStarted(WebSocketSession, MessageChannel) - Method in interface org.springframework.web.socket.messaging.SubProtocolHandler

Invoked after a WebSocketSession has started.

afterSingletonsInstantiated() - Method in class org.springframework.web.socket.config.WebSocketMessageBrokerStats

afterSingletonsInstantiated() - Method in class org.springframework.web.socket.server.standard.ServerEndpointExporter

afterTransportClosed(CloseStatus) - Method in class org.springframework.web.socket.sockjs.client.AbstractClientSockJsSession

AnnotatedEndpointConnectionManager - Class in org.springframework.web.socket.client.standard

WebSocket connection manager that connects to the server via WebSocketContainer and handles the session with an @ClientEndpoint endpoint.

AnnotatedEndpointConnectionManager(Class<?>, String, Object...) - Constructor for class org.springframework.web.socket.client.standard.AnnotatedEndpointConnectionManager

AnnotatedEndpointConnectionManager(Object, String, Object...) - Constructor for class org.springframework.web.socket.client.standard.AnnotatedEndpointConnectionManager

applyAfterHandshake(ServerHttpRequest, ServerHttpResponse, Exception) - Method in class org.springframework.web.socket.server.support.HandshakeInterceptorChain

applyBeforeHandshake(ServerHttpRequest, ServerHttpResponse, Map<String, Object>) - Method in class org.springframework.web.socket.server.support.HandshakeInterceptorChain

applyJsonQuoting(String) - Method in class org.springframework.web.socket.sockjs.frame.AbstractSockJsMessageCodec

Apply standard JSON string quoting (see json.org).

applyJsonQuoting(String) - Method in class org.springframework.web.socket.sockjs.frame.Jackson2SockJsMessageCodec

asBytes() - Method in class org.springframework.web.socket.TextMessage

assertUri(URI) - Method in class org.springframework.web.socket.client.AbstractWebSocketClient

B

BAD_DATA - Static variable in class org.springframework.web.socket.CloseStatus

"1007 indicates that an endpoint is terminating the connection because it has received data within a message that was not consistent with the type of the message (e.g., non-UTF-8 [RFC3629] data within a text message)."

BeanCreatingHandlerProvider<T> - Class in org.springframework.web.socket.handler

Instantiates a target handler through a Spring BeanFactory and also provides an equivalent destroy method.

BeanCreatingHandlerProvider(Class<? extends T>) - Constructor for class org.springframework.web.socket.handler.BeanCreatingHandlerProvider

beforeHandshake(ServerHttpRequest, ServerHttpResponse, WebSocketHandler, Map<String, Object>) - Method in interface org.springframework.web.socket.server.HandshakeInterceptor

Invoked before the handshake is processed.

beforeHandshake(ServerHttpRequest, ServerHttpResponse, WebSocketHandler, Map<String, Object>) - Method in class org.springframework.web.socket.server.support.HttpSessionHandshakeInterceptor

beforeHandshake(ServerHttpRequest, ServerHttpResponse, WebSocketHandler, Map<String, Object>) - Method in class org.springframework.web.socket.server.support.OriginHandshakeInterceptor

BinaryDecoder() - Constructor for class org.springframework.web.socket.adapter.standard.ConvertingEncoderDecoderSupport.BinaryDecoder

BinaryEncoder() - Constructor for class org.springframework.web.socket.adapter.standard.ConvertingEncoderDecoderSupport.BinaryEncoder

BinaryMessage - Class in org.springframework.web.socket

A binary WebSocket message.

BinaryMessage(byte[]) - Constructor for class org.springframework.web.socket.BinaryMessage

Create a new binary WebSocket message with the given byte[] payload.

BinaryMessage(byte[], boolean) - Constructor for class org.springframework.web.socket.BinaryMessage

Create a new binary WebSocket message with the given byte[] payload representing the full or partial message content.

BinaryMessage(byte[], int, int, boolean) - Constructor for class org.springframework.web.socket.BinaryMessage

Create a new binary WebSocket message by wrapping an existing byte array.

BinaryMessage(ByteBuffer) - Constructor for class org.springframework.web.socket.BinaryMessage

Create a new binary WebSocket message with the given ByteBuffer payload.

BinaryMessage(ByteBuffer, boolean) - Constructor for class org.springframework.web.socket.BinaryMessage

Create a new binary WebSocket message with the given payload representing the full or partial message content.

BinaryWebSocketHandler - Class in org.springframework.web.socket.handler

A convenient base class for WebSocketHandler implementations that process binary messages only.

BinaryWebSocketHandler() - Constructor for class org.springframework.web.socket.handler.BinaryWebSocketHandler

C

cancelHeartbeat() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession

CHARSET - Static variable in class org.springframework.web.socket.sockjs.frame.SockJsFrame

The charset used by SockJS.

checkNativeSessionInitialized() - Method in class org.springframework.web.socket.adapter.AbstractWebSocketSession

checkOrigin(ServerHttpRequest, ServerHttpResponse, HttpMethod...) - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService

checkSessionType(SockJsSession) - Method in class org.springframework.web.socket.sockjs.transport.handler.AbstractHttpReceivingTransportHandler

checkSessionType(SockJsSession) - Method in class org.springframework.web.socket.sockjs.transport.handler.EventSourceTransportHandler

checkSessionType(SockJsSession) - Method in class org.springframework.web.socket.sockjs.transport.handler.HtmlFileTransportHandler

checkSessionType(SockJsSession) - Method in class org.springframework.web.socket.sockjs.transport.handler.WebSocketTransportHandler

checkSessionType(SockJsSession) - Method in class org.springframework.web.socket.sockjs.transport.handler.XhrPollingTransportHandler

checkSessionType(SockJsSession) - Method in class org.springframework.web.socket.sockjs.transport.handler.XhrStreamingTransportHandler

checkSessionType(SockJsSession) - Method in interface org.springframework.web.socket.sockjs.transport.TransportHandler

Check whether the type of the given session matches the transport type of this TransportHandler where session id and the transport type are extracted from the SockJS URL.

clear() - Method in class org.springframework.web.socket.WebSocketHttpHeaders

clearServerInfoCache() - Method in class org.springframework.web.socket.sockjs.client.SockJsClient

By default, the result of a SockJS "Info" request, including whether the server has WebSocket disabled and how long the request took (used for calculating transport timeout time) is cached.

close() - Method in class org.springframework.web.socket.adapter.AbstractWebSocketSession

close() - Method in class org.springframework.web.socket.handler.WebSocketSessionDecorator

close() - Method in class org.springframework.web.socket.sockjs.client.AbstractClientSockJsSession

close() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession

Performs cleanup and notify the WebSocketHandler.

close() - Method in interface org.springframework.web.socket.WebSocketSession

Close the WebSocket connection with status 1000, i.e.

close(CloseStatus) - Method in class org.springframework.web.socket.adapter.AbstractWebSocketSession

close(CloseStatus) - Method in class org.springframework.web.socket.handler.ConcurrentWebSocketSessionDecorator

close(CloseStatus) - Method in class org.springframework.web.socket.handler.WebSocketSessionDecorator

close(CloseStatus) - Method in class org.springframework.web.socket.sockjs.client.AbstractClientSockJsSession

close(CloseStatus) - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession

Performs cleanup and notify the WebSocketHandler.

close(CloseStatus) - Method in interface org.springframework.web.socket.WebSocketSession

Close the WebSocket connection with the given close status.

CLOSE - Enum constant in enum class org.springframework.web.socket.sockjs.frame.SockJsFrameType

closeConnection() - Method in class org.springframework.web.socket.client.ConnectionManagerSupport

Subclasses implement this to close the connection.

closeConnection() - Method in class org.springframework.web.socket.client.standard.AnnotatedEndpointConnectionManager

closeConnection() - Method in class org.springframework.web.socket.client.standard.EndpointConnectionManager

closeConnection() - Method in class org.springframework.web.socket.client.WebSocketConnectionManager

closeFrame(int, String) - Static method in class org.springframework.web.socket.sockjs.frame.SockJsFrame

closeFrameAnotherConnectionOpen() - Static method in class org.springframework.web.socket.sockjs.frame.SockJsFrame

closeFrameGoAway() - Static method in class org.springframework.web.socket.sockjs.frame.SockJsFrame

closeInternal(CloseStatus) - Method in class org.springframework.web.socket.adapter.AbstractWebSocketSession

closeInternal(CloseStatus) - Method in class org.springframework.web.socket.adapter.jetty.JettyWebSocketSession

closeInternal(CloseStatus) - Method in class org.springframework.web.socket.adapter.standard.StandardWebSocketSession

closeInternal(CloseStatus) - Method in class org.springframework.web.socket.sockjs.client.AbstractClientSockJsSession

CloseStatus - Class in org.springframework.web.socket

Represents a WebSocket close status code and reason.

CloseStatus(int) - Constructor for class org.springframework.web.socket.CloseStatus

Create a new CloseStatus instance.

CloseStatus(int, String) - Constructor for class org.springframework.web.socket.CloseStatus

Create a new CloseStatus instance.

ConcurrentWebSocketSessionDecorator - Class in org.springframework.web.socket.handler

Wrap a WebSocketSession to guarantee only one thread can send messages at a time.

ConcurrentWebSocketSessionDecorator(WebSocketSession, int, int) - Constructor for class org.springframework.web.socket.handler.ConcurrentWebSocketSessionDecorator

Basic constructor.

ConcurrentWebSocketSessionDecorator(WebSocketSession, int, int, ConcurrentWebSocketSessionDecorator.OverflowStrategy) - Constructor for class org.springframework.web.socket.handler.ConcurrentWebSocketSessionDecorator

Constructor that also specifies the overflow strategy to use.

ConcurrentWebSocketSessionDecorator.OverflowStrategy - Enum Class in org.springframework.web.socket.handler

Enum for options of what to do when the buffer fills up.

configureClientInboundChannel(ChannelRegistration) - Method in class org.springframework.web.socket.config.annotation.DelegatingWebSocketMessageBrokerConfiguration

configureClientInboundChannel(ChannelRegistration) - Method in interface org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurer

Configure the MessageChannel used for incoming messages from WebSocket clients.

configureClientOutboundChannel(ChannelRegistration) - Method in class org.springframework.web.socket.config.annotation.DelegatingWebSocketMessageBrokerConfiguration

configureClientOutboundChannel(ChannelRegistration) - Method in interface org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurer

Configure the MessageChannel used for outbound messages to WebSocket clients.

configureMessageBroker(MessageBrokerRegistry) - Method in class org.springframework.web.socket.config.annotation.DelegatingWebSocketMessageBrokerConfiguration

configureMessageBroker(MessageBrokerRegistry) - Method in interface org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurer

Configure message broker options.

configureMessageConverters(List<MessageConverter>) - Method in class org.springframework.web.socket.config.annotation.DelegatingWebSocketMessageBrokerConfiguration

configureMessageConverters(List<MessageConverter>) - Method in interface org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurer

Configure the message converters to use when extracting the payload of messages in annotated methods and when sending messages (e.g.

configureWebSocketTransport(WebSocketTransportRegistration) - Method in class org.springframework.web.socket.config.annotation.DelegatingWebSocketMessageBrokerConfiguration

configureWebSocketTransport(WebSocketTransportRegistration) - Method in class org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurationSupport

configureWebSocketTransport(WebSocketTransportRegistration) - Method in interface org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurer

Configure options related to the processing of messages received from and sent to WebSocket clients.

connect(String, StompSessionHandler, Object...) - Method in class org.springframework.web.socket.messaging.WebSocketStompClient

Deprecated.

as of 6.0, in favor of WebSocketStompClient.connectAsync(String, StompSessionHandler, Object...)

connect(String, WebSocketHttpHeaders, StompHeaders, StompSessionHandler, Object...) - Method in class org.springframework.web.socket.messaging.WebSocketStompClient

Deprecated.

as of 6.0, in favor of WebSocketStompClient.connectAsync(String, WebSocketHttpHeaders, StompHeaders, StompSessionHandler, Object...)

connect(String, WebSocketHttpHeaders, StompSessionHandler, Object...) - Method in class org.springframework.web.socket.messaging.WebSocketStompClient

Deprecated.

as of 6.0, in favor of WebSocketStompClient.connectAsync(String, WebSocketHttpHeaders, StompSessionHandler, Object...)

connect(URI, WebSocketHttpHeaders, StompHeaders, StompSessionHandler) - Method in class org.springframework.web.socket.messaging.WebSocketStompClient

Deprecated.

as of 6.0, in favor of WebSocketStompClient.connectAsync(URI, WebSocketHttpHeaders, StompHeaders, StompSessionHandler)

connect(TransportRequest, WebSocketHandler) - Method in interface org.springframework.web.socket.sockjs.client.Transport

Deprecated.

as of 6.0, in favor of Transport.connectAsync(TransportRequest, WebSocketHandler)

connectAsync(String, StompSessionHandler, Object...) - Method in class org.springframework.web.socket.messaging.WebSocketStompClient

Connect to the given WebSocket URL and notify the given StompSessionHandler when connected on the STOMP level after the CONNECTED frame is received.

connectAsync(String, WebSocketHttpHeaders, StompHeaders, StompSessionHandler, Object...) - Method in class org.springframework.web.socket.messaging.WebSocketStompClient

An overloaded version of WebSocketStompClient.connect(String, StompSessionHandler, Object...) that also accepts WebSocketHttpHeaders to use for the WebSocket handshake and StompHeaders for the STOMP CONNECT frame.

connectAsync(String, WebSocketHttpHeaders, StompSessionHandler, Object...) - Method in class org.springframework.web.socket.messaging.WebSocketStompClient

An overloaded version of WebSocketStompClient.connect(String, StompSessionHandler, Object...) that also accepts WebSocketHttpHeaders to use for the WebSocket handshake.

connectAsync(URI, WebSocketHttpHeaders, StompHeaders, StompSessionHandler) - Method in class org.springframework.web.socket.messaging.WebSocketStompClient

An overloaded version of WebSocketStompClient.connect(String, WebSocketHttpHeaders, StompSessionHandler, Object...) that accepts a fully prepared URI.

connectAsync(TransportRequest, WebSocketHandler) - Method in class org.springframework.web.socket.sockjs.client.AbstractXhrTransport

connectAsync(TransportRequest, WebSocketHandler) - Method in interface org.springframework.web.socket.sockjs.client.Transport

Connect the transport.

connectAsync(TransportRequest, WebSocketHandler) - Method in class org.springframework.web.socket.sockjs.client.WebSocketTransport

CONNECTED_USER_HEADER - Static variable in class org.springframework.web.socket.messaging.StompSubProtocolHandler

The name of the header set on the CONNECTED frame indicating the name of the user authenticated on the WebSocket session.

connectInternal(TransportRequest, WebSocketHandler, URI, HttpHeaders, XhrClientSockJsSession, CompletableFuture<WebSocketSession>) - Method in class org.springframework.web.socket.sockjs.client.AbstractXhrTransport

connectInternal(TransportRequest, WebSocketHandler, URI, HttpHeaders, XhrClientSockJsSession, CompletableFuture<WebSocketSession>) - Method in class org.springframework.web.socket.sockjs.client.JettyXhrTransport

connectInternal(TransportRequest, WebSocketHandler, URI, HttpHeaders, XhrClientSockJsSession, CompletableFuture<WebSocketSession>) - Method in class org.springframework.web.socket.sockjs.client.RestTemplateXhrTransport

connectInternal(TransportRequest, WebSocketHandler, URI, HttpHeaders, XhrClientSockJsSession, CompletableFuture<WebSocketSession>) - Method in class org.springframework.web.socket.sockjs.client.UndertowXhrTransport

connectInternal(TransportRequest, WebSocketHandler, URI, HttpHeaders, XhrClientSockJsSession, SettableListenableFuture<WebSocketSession>) - Method in class org.springframework.web.socket.sockjs.client.AbstractXhrTransport

Deprecated.

ConnectionManagerSupport - Class in org.springframework.web.socket.client

Base class for a connection manager that automates the process of connecting to a WebSocket server with the Spring ApplicationContext lifecycle.

ConnectionManagerSupport(String, Object...) - Constructor for class org.springframework.web.socket.client.ConnectionManagerSupport

Constructor with a URI template and variables.

ConnectionManagerSupport(URI) - Constructor for class org.springframework.web.socket.client.ConnectionManagerSupport

Constructor with a prepared URI.

containsKey(Object) - Method in class org.springframework.web.socket.WebSocketHttpHeaders

containsValue(Object) - Method in class org.springframework.web.socket.WebSocketHttpHeaders

ConvertingEncoderDecoderSupport<T,M> - Class in org.springframework.web.socket.adapter.standard

Base class that can be used to implement a standard Encoder and/or Decoder.

ConvertingEncoderDecoderSupport() - Constructor for class org.springframework.web.socket.adapter.standard.ConvertingEncoderDecoderSupport

ConvertingEncoderDecoderSupport.BinaryDecoder<T> - Class in org.springframework.web.socket.adapter.standard

A binary jakarta.websocket.Encoder that delegates to Spring's conversion service.

ConvertingEncoderDecoderSupport.BinaryEncoder<T> - Class in org.springframework.web.socket.adapter.standard

A binary jakarta.websocket.Encoder that delegates to Spring's conversion service.

ConvertingEncoderDecoderSupport.TextDecoder<T> - Class in org.springframework.web.socket.adapter.standard

A Text jakarta.websocket.Encoder that delegates to Spring's conversion service.

ConvertingEncoderDecoderSupport.TextEncoder<T> - Class in org.springframework.web.socket.adapter.standard

A text jakarta.websocket.Encoder that delegates to Spring's conversion service.

corsConfiguration - Variable in class org.springframework.web.socket.sockjs.support.AbstractSockJsService

createAnnotationMethodMessageHandler(AbstractSubscribableChannel, AbstractSubscribableChannel, SimpMessagingTemplate) - Method in class org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurationSupport

createJacksonConverter() - Method in class org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurationSupport

createLocalUserRegistry(Integer) - Method in class org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurationSupport

createMappings() - Method in class org.springframework.web.socket.config.annotation.AbstractWebSocketHandlerRegistration

createMappings() - Method in class org.springframework.web.socket.config.annotation.ServletWebSocketHandlerRegistration

createSession(String, WebSocketHandler, Map<String, Object>) - Method in class org.springframework.web.socket.sockjs.transport.handler.EventSourceTransportHandler

createSession(String, WebSocketHandler, Map<String, Object>) - Method in class org.springframework.web.socket.sockjs.transport.handler.HtmlFileTransportHandler

createSession(String, WebSocketHandler, Map<String, Object>) - Method in class org.springframework.web.socket.sockjs.transport.handler.WebSocketTransportHandler

createSession(String, WebSocketHandler, Map<String, Object>) - Method in class org.springframework.web.socket.sockjs.transport.handler.XhrPollingTransportHandler

createSession(String, WebSocketHandler, Map<String, Object>) - Method in class org.springframework.web.socket.sockjs.transport.handler.XhrStreamingTransportHandler

createSession(String, WebSocketHandler, Map<String, Object>) - Method in interface org.springframework.web.socket.sockjs.transport.SockJsSessionFactory

Create a new SockJS session.

D

decode(String) - Method in class org.springframework.web.socket.sockjs.frame.Jackson2SockJsMessageCodec

decode(String) - Method in interface org.springframework.web.socket.sockjs.frame.SockJsMessageCodec

Decode the given SockJS message frame.

decode(M) - Method in class org.springframework.web.socket.adapter.standard.ConvertingEncoderDecoderSupport

Decode the message into an object.

decodeInputStream(InputStream) - Method in class org.springframework.web.socket.sockjs.frame.Jackson2SockJsMessageCodec

decodeInputStream(InputStream) - Method in interface org.springframework.web.socket.sockjs.frame.SockJsMessageCodec

Decode the given SockJS message frame.

decorate(WebSocketHandler) - Method in interface org.springframework.web.socket.handler.WebSocketHandlerDecoratorFactory

Decorate the given WebSocketHandler.

decorate(WebSocketHandler) - Method in class org.springframework.web.socket.server.support.WebSocketHttpRequestHandler

Decorate the WebSocketHandler passed into the constructor.

decorateSession(WebSocketSession) - Method in class org.springframework.web.socket.messaging.SubProtocolWebSocketHandler

Decorate the given WebSocketSession, if desired.

decorateWebSocketHandler(WebSocketHandler) - Method in class org.springframework.web.socket.client.WebSocketConnectionManager

Decorate the WebSocketHandler provided to the class constructor.

decorateWebSocketHandler(WebSocketHandler) - Method in class org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurationSupport

DefaultHandshakeHandler - Class in org.springframework.web.socket.server.support

A default HandshakeHandler implementation, extending AbstractHandshakeHandler with Servlet-specific initialization support.

DefaultHandshakeHandler() - Constructor for class org.springframework.web.socket.server.support.DefaultHandshakeHandler

DefaultHandshakeHandler(RequestUpgradeStrategy) - Constructor for class org.springframework.web.socket.server.support.DefaultHandshakeHandler

DefaultSimpUserRegistry - Class in org.springframework.web.socket.messaging

A default implementation of SimpUserRegistry that relies on AbstractSubProtocolEvent application context events to keep track of connected users and their subscriptions.

DefaultSimpUserRegistry() - Constructor for class org.springframework.web.socket.messaging.DefaultSimpUserRegistry

DefaultSockJsFrameFormat - Class in org.springframework.web.socket.sockjs.frame

A default implementation of SockJsFrameFormat that relies on String.format(String, Object...)..

DefaultSockJsFrameFormat(String) - Constructor for class org.springframework.web.socket.sockjs.frame.DefaultSockJsFrameFormat

DefaultSockJsService - Class in org.springframework.web.socket.sockjs.transport.handler

A default implementation of SockJsService with all default TransportHandler implementations pre-registered.

DefaultSockJsService(TaskScheduler) - Constructor for class org.springframework.web.socket.sockjs.transport.handler.DefaultSockJsService

Create a DefaultSockJsService with default handler types.

DefaultSockJsService(TaskScheduler, Collection<TransportHandler>) - Constructor for class org.springframework.web.socket.sockjs.transport.handler.DefaultSockJsService

Create a DefaultSockJsService with overridden handler types replacing the corresponding default handler implementation.

DefaultSockJsService(TaskScheduler, TransportHandler...) - Constructor for class org.springframework.web.socket.sockjs.transport.handler.DefaultSockJsService

Create a DefaultSockJsService with overridden handler types replacing the corresponding default handler implementation.

delegateConnectionClosed(CloseStatus) - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession

Invoked when the underlying connection is closed.

delegateConnectionEstablished() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession

delegateError(Throwable) - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession

delegateMessages(String...) - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession

DelegatingWebSocketConfiguration - Class in org.springframework.web.socket.config.annotation

A variation of WebSocketConfigurationSupport that detects implementations of WebSocketConfigurer in Spring configuration and invokes them in order to configure WebSocket request handling.

DelegatingWebSocketConfiguration() - Constructor for class org.springframework.web.socket.config.annotation.DelegatingWebSocketConfiguration

DelegatingWebSocketMessageBrokerConfiguration - Class in org.springframework.web.socket.config.annotation

A WebSocketMessageBrokerConfigurationSupport extension that detects beans of type WebSocketMessageBrokerConfigurer and delegates to all of them allowing callback style customization of the configuration provided in WebSocketMessageBrokerConfigurationSupport.

DelegatingWebSocketMessageBrokerConfiguration() - Constructor for class org.springframework.web.socket.config.annotation.DelegatingWebSocketMessageBrokerConfiguration

destroy() - Method in class org.springframework.web.socket.adapter.standard.ConvertingEncoderDecoderSupport

Called to destroy the encoder/decoder.

destroy(T) - Method in class org.springframework.web.socket.handler.BeanCreatingHandlerProvider

determineHandlerSupportedProtocols(WebSocketHandler) - Method in class org.springframework.web.socket.server.support.AbstractHandshakeHandler

Determine the sub-protocols supported by the given WebSocketHandler by checking whether it is an instance of SubProtocolCapable.

determineUser(ServerHttpRequest, WebSocketHandler, Map<String, Object>) - Method in class org.springframework.web.socket.server.support.AbstractHandshakeHandler

A method that can be used to associate a user with the WebSocket session in the process of being established.

disableHeartbeat() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession

disableHeartbeat() - Method in interface org.springframework.web.socket.sockjs.transport.SockJsSession

Disable the SockJS heartbeat, presumably because a higher-level protocol has heartbeats enabled for the session already.

disconnect(CloseStatus) - Method in class org.springframework.web.socket.sockjs.client.AbstractClientSockJsSession

disconnect(CloseStatus) - Method in class org.springframework.web.socket.sockjs.client.WebSocketClientSockJsSession

disconnect(CloseStatus) - Method in class org.springframework.web.socket.sockjs.client.XhrClientSockJsSession

disconnect(CloseStatus) - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractHttpSockJsSession

disconnect(CloseStatus) - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession

Actually close the underlying WebSocket session or in the case of HTTP transports complete the underlying request.

disconnect(CloseStatus) - Method in class org.springframework.web.socket.sockjs.transport.session.WebSocketServerSockJsSession

DISCONNECTED_CLIENT_LOG_CATEGORY - Static variable in class org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession

Log category to use on network IO exceptions after a client has gone away.

disconnectedClientLogger - Static variable in class org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession

Separate logger to use on network IO failure after a client has gone away.

doHandshake(ServerHttpRequest, ServerHttpResponse, WebSocketHandler, Map<String, Object>) - Method in interface org.springframework.web.socket.server.HandshakeHandler

Initiate the handshake.

doHandshake(ServerHttpRequest, ServerHttpResponse, WebSocketHandler, Map<String, Object>) - Method in class org.springframework.web.socket.server.support.AbstractHandshakeHandler

doHandshake(ServerHttpRequest, ServerHttpResponse, WebSocketHandler, Map<String, Object>) - Method in class org.springframework.web.socket.sockjs.transport.handler.WebSocketTransportHandler

doHandshake(WebSocketHandler, String, Object...) - Method in interface org.springframework.web.socket.client.WebSocketClient

Deprecated.

as of 6.0, in favor of WebSocketClient.execute(WebSocketHandler, String, Object...)

doHandshake(WebSocketHandler, WebSocketHttpHeaders, URI) - Method in interface org.springframework.web.socket.client.WebSocketClient

Deprecated.

as of 6.0, in favor of WebSocketClient.execute(WebSocketHandler, WebSocketHttpHeaders, URI)

doHandshakeInternal(WebSocketHandler, HttpHeaders, URI, List<String>, List<WebSocketExtension>, Map<String, Object>) - Method in class org.springframework.web.socket.client.AbstractWebSocketClient

Deprecated.

as of 6.0, in favor of AbstractWebSocketClient.executeInternal(WebSocketHandler, HttpHeaders, URI, List, List, Map)

doStart() - Method in class org.springframework.web.socket.server.support.AbstractHandshakeHandler

doStop() - Method in class org.springframework.web.socket.server.support.AbstractHandshakeHandler

DROP - Enum constant in enum class org.springframework.web.socket.handler.ConcurrentWebSocketSessionDecorator.OverflowStrategy

Drop the oldest messages from the buffer.

E

EnableWebSocket - Annotation Interface in org.springframework.web.socket.config.annotation

Add this annotation to an @Configuration class to configure processing WebSocket requests.

EnableWebSocketMessageBroker - Annotation Interface in org.springframework.web.socket.config.annotation

Add this annotation to an @Configuration class to enable broker-backed messaging over WebSocket using a higher-level messaging sub-protocol.

encode(String...) - Method in class org.springframework.web.socket.sockjs.frame.AbstractSockJsMessageCodec

encode(String...) - Method in interface org.springframework.web.socket.sockjs.frame.SockJsMessageCodec

Encode the given messages as a SockJS message frame.

encode(T) - Method in class org.springframework.web.socket.adapter.standard.ConvertingEncoderDecoderSupport

Encode an object to a message.

EndpointConnectionManager - Class in org.springframework.web.socket.client.standard

WebSocket connection manager that connects to the server via WebSocketContainer and handles the session with an Endpoint.

EndpointConnectionManager(Endpoint, String, Object...) - Constructor for class org.springframework.web.socket.client.standard.EndpointConnectionManager

EndpointConnectionManager(Class<? extends Endpoint>, String, Object...) - Constructor for class org.springframework.web.socket.client.standard.EndpointConnectionManager

entrySet() - Method in class org.springframework.web.socket.WebSocketHttpHeaders

equals(Object) - Method in class org.springframework.web.socket.AbstractWebSocketMessage

equals(Object) - Method in class org.springframework.web.socket.CloseStatus

equals(Object) - Method in class org.springframework.web.socket.sockjs.frame.SockJsFrame

equals(Object) - Method in class org.springframework.web.socket.WebSocketExtension

equals(Object) - Method in class org.springframework.web.socket.WebSocketHttpHeaders

equalsCode(CloseStatus) - Method in class org.springframework.web.socket.CloseStatus

EVENT_SOURCE - Enum constant in enum class org.springframework.web.socket.sockjs.transport.TransportType

EventSourceTransportHandler - Class in org.springframework.web.socket.sockjs.transport.handler

A TransportHandler for sending messages via Server-Sent Events: https://dev.w3.org/html5/eventsource/.

EventSourceTransportHandler() - Constructor for class org.springframework.web.socket.sockjs.transport.handler.EventSourceTransportHandler

ExceptionWebSocketHandlerDecorator - Class in org.springframework.web.socket.handler

An exception handling WebSocketHandlerDecorator.

ExceptionWebSocketHandlerDecorator(WebSocketHandler) - Constructor for class org.springframework.web.socket.handler.ExceptionWebSocketHandlerDecorator

execute(WebSocketHandler, String, Object...) - Method in class org.springframework.web.socket.client.AbstractWebSocketClient

execute(WebSocketHandler, String, Object...) - Method in interface org.springframework.web.socket.client.WebSocketClient

Execute a handshake request to the given url and handle the resulting WebSocket session with the given handler.

execute(WebSocketHandler, String, Object...) - Method in class org.springframework.web.socket.sockjs.client.SockJsClient

execute(WebSocketHandler, WebSocketHttpHeaders, URI) - Method in class org.springframework.web.socket.client.AbstractWebSocketClient

execute(WebSocketHandler, WebSocketHttpHeaders, URI) - Method in interface org.springframework.web.socket.client.WebSocketClient

Execute a handshake request to the given url and handle the resulting WebSocket session with the given handler.

execute(WebSocketHandler, WebSocketHttpHeaders, URI) - Method in class org.springframework.web.socket.sockjs.client.SockJsClient

executeInfoRequest(URI, HttpHeaders) - Method in class org.springframework.web.socket.sockjs.client.AbstractXhrTransport

executeInfoRequest(URI, HttpHeaders) - Method in interface org.springframework.web.socket.sockjs.client.InfoReceiver

Perform an HTTP request to the SockJS "Info" URL.

executeInfoRequestInternal(URI, HttpHeaders) - Method in class org.springframework.web.socket.sockjs.client.AbstractXhrTransport

executeInfoRequestInternal(URI, HttpHeaders) - Method in class org.springframework.web.socket.sockjs.client.JettyXhrTransport

executeInfoRequestInternal(URI, HttpHeaders) - Method in class org.springframework.web.socket.sockjs.client.RestTemplateXhrTransport

executeInfoRequestInternal(URI, HttpHeaders) - Method in class org.springframework.web.socket.sockjs.client.UndertowXhrTransport

executeInternal(WebSocketHandler, HttpHeaders, URI, List<String>, List<WebSocketExtension>, Map<String, Object>) - Method in class org.springframework.web.socket.client.AbstractWebSocketClient

Perform the actual handshake to establish a connection to the server.

executeInternal(WebSocketHandler, HttpHeaders, URI, List<String>, List<WebSocketExtension>, Map<String, Object>) - Method in class org.springframework.web.socket.client.jetty.JettyWebSocketClient

Deprecated.

executeInternal(WebSocketHandler, HttpHeaders, URI, List<String>, List<WebSocketExtension>, Map<String, Object>) - Method in class org.springframework.web.socket.client.standard.StandardWebSocketClient

executeRequest(URI, HttpString, HttpHeaders, String) - Method in class org.springframework.web.socket.sockjs.client.UndertowXhrTransport

executeRequest(URI, HttpMethod, HttpHeaders, String) - Method in class org.springframework.web.socket.sockjs.client.JettyXhrTransport

executeSendRequest(URI, HttpHeaders, TextMessage) - Method in class org.springframework.web.socket.sockjs.client.AbstractXhrTransport

executeSendRequest(URI, HttpHeaders, TextMessage) - Method in interface org.springframework.web.socket.sockjs.client.XhrTransport

Execute a request to send the message to the server.

executeSendRequestInternal(URI, HttpHeaders, TextMessage) - Method in class org.springframework.web.socket.sockjs.client.AbstractXhrTransport

executeSendRequestInternal(URI, HttpHeaders, TextMessage) - Method in class org.springframework.web.socket.sockjs.client.JettyXhrTransport

executeSendRequestInternal(URI, HttpHeaders, TextMessage) - Method in class org.springframework.web.socket.sockjs.client.RestTemplateXhrTransport

executeSendRequestInternal(URI, HttpHeaders, TextMessage) - Method in class org.springframework.web.socket.sockjs.client.UndertowXhrTransport

F

filterRequestedExtensions(ServerHttpRequest, List<WebSocketExtension>, List<WebSocketExtension>) - Method in class org.springframework.web.socket.server.support.AbstractHandshakeHandler

Filter the list of requested WebSocket extensions.

findProtocolHandler(WebSocketSession) - Method in class org.springframework.web.socket.messaging.SubProtocolWebSocketHandler

Find a SubProtocolHandler for the given session.

findSubscriptions(SimpSubscriptionMatcher) - Method in class org.springframework.web.socket.messaging.DefaultSimpUserRegistry

flushCache() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractHttpSockJsSession

Called when the connection is active and ready to write to the response.

flushCache() - Method in class org.springframework.web.socket.sockjs.transport.session.PollingSockJsSession

flushCache() - Method in class org.springframework.web.socket.sockjs.transport.session.StreamingSockJsSession

forEach(BiConsumer<? super String, ? super List<String>>) - Method in class org.springframework.web.socket.WebSocketHttpHeaders

format(SockJsFrame) - Method in class org.springframework.web.socket.sockjs.frame.DefaultSockJsFrameFormat

format(SockJsFrame) - Method in interface org.springframework.web.socket.sockjs.frame.SockJsFrameFormat

fromValue(String) - Static method in enum class org.springframework.web.socket.sockjs.transport.TransportType

G

get(Object) - Method in class org.springframework.web.socket.WebSocketHttpHeaders

getAcceptedProtocol() - Method in class org.springframework.web.socket.adapter.jetty.JettyWebSocketSession

getAcceptedProtocol() - Method in class org.springframework.web.socket.adapter.standard.StandardWebSocketSession

getAcceptedProtocol() - Method in class org.springframework.web.socket.handler.WebSocketSessionDecorator

getAcceptedProtocol() - Method in class org.springframework.web.socket.sockjs.client.WebSocketClientSockJsSession

getAcceptedProtocol() - Method in class org.springframework.web.socket.sockjs.client.XhrClientSockJsSession

getAcceptedProtocol() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractHttpSockJsSession

Return the selected sub-protocol to use.

getAcceptedProtocol() - Method in class org.springframework.web.socket.sockjs.transport.session.WebSocketServerSockJsSession

getAcceptedProtocol() - Method in interface org.springframework.web.socket.WebSocketSession

Return the negotiated sub-protocol.

getAllowedOriginPatterns() - Method in class org.springframework.web.socket.server.support.OriginHandshakeInterceptor

Return the configured allowed origin patterns.

getAllowedOriginPatterns() - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService

Return configured origin patterns.

getAllowedOrigins() - Method in class org.springframework.web.socket.server.support.OriginHandshakeInterceptor

Return the configured allowed origins.

getAllowedOrigins() - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService

Return the configured allowed origins.

getApplicationContext() - Method in class org.springframework.web.socket.adapter.standard.ConvertingEncoderDecoderSupport

Returns the active ApplicationContext.

getAsyncSendTimeout() - Method in class org.springframework.web.socket.client.standard.WebSocketContainerFactoryBean

getAsyncSendTimeout() - Method in class org.springframework.web.socket.server.standard.ServletServerContainerFactoryBean

getAttributeNames() - Method in class org.springframework.web.socket.server.support.HttpSessionHandshakeInterceptor

Return the configured attribute names to copy (read-only).

getAttributes() - Method in class org.springframework.web.socket.adapter.AbstractWebSocketSession

getAttributes() - Method in class org.springframework.web.socket.handler.WebSocketSessionDecorator

getAttributes() - Method in class org.springframework.web.socket.sockjs.client.AbstractClientSockJsSession

getAttributes() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession

getAttributes() - Method in interface org.springframework.web.socket.WebSocketSession

Return the map with attributes associated with the WebSocket session.

getBinaryMessageSizeLimit() - Method in class org.springframework.web.socket.adapter.jetty.JettyWebSocketSession

getBinaryMessageSizeLimit() - Method in class org.springframework.web.socket.adapter.standard.StandardWebSocketSession

getBinaryMessageSizeLimit() - Method in class org.springframework.web.socket.handler.WebSocketSessionDecorator

getBinaryMessageSizeLimit() - Method in class org.springframework.web.socket.sockjs.client.WebSocketClientSockJsSession

getBinaryMessageSizeLimit() - Method in class org.springframework.web.socket.sockjs.client.XhrClientSockJsSession

getBinaryMessageSizeLimit() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractHttpSockJsSession

getBinaryMessageSizeLimit() - Method in class org.springframework.web.socket.sockjs.transport.session.WebSocketServerSockJsSession

getBinaryMessageSizeLimit() - Method in interface org.springframework.web.socket.WebSocketSession

Get the configured maximum size for an incoming binary message.

getBufferSize() - Method in class org.springframework.web.socket.handler.ConcurrentWebSocketSessionDecorator

Return the current buffer size (number of bytes).

getBufferSizeLimit() - Method in class org.springframework.web.socket.handler.ConcurrentWebSocketSessionDecorator

Return the configured buffer-size limit (number of bytes).

getCallbackParam(ServerHttpRequest) - Method in class org.springframework.web.socket.sockjs.transport.handler.AbstractHttpSendingTransportHandler

getClientInboundExecutorStatsInfo() - Method in class org.springframework.web.socket.config.WebSocketMessageBrokerStats

Get stats about the executor processing incoming messages from WebSocket clients.

getClientOutboundExecutorStatsInfo() - Method in class org.springframework.web.socket.config.WebSocketMessageBrokerStats

Get stats about the executor processing outgoing messages to WebSocket clients.

getCloseStatus() - Method in class org.springframework.web.socket.messaging.SessionDisconnectEvent

Return the status with which the session was closed.

getCode() - Method in class org.springframework.web.socket.CloseStatus

Return the status code.

getConfigurator() - Method in class org.springframework.web.socket.server.standard.ServerEndpointRegistration

getContainer(HttpServletRequest) - Method in class org.springframework.web.socket.server.standard.AbstractStandardUpgradeStrategy

getContent() - Method in class org.springframework.web.socket.sockjs.frame.SockJsFrame

Return the SockJS frame content (never null).

getContentBytes() - Method in class org.springframework.web.socket.sockjs.frame.SockJsFrame

Return the SockJS frame content as a byte array.

getContentType() - Method in class org.springframework.web.socket.sockjs.transport.handler.AbstractHttpSendingTransportHandler

getContentType() - Method in class org.springframework.web.socket.sockjs.transport.handler.EventSourceTransportHandler

getContentType() - Method in class org.springframework.web.socket.sockjs.transport.handler.HtmlFileTransportHandler

getContentType() - Method in class org.springframework.web.socket.sockjs.transport.handler.XhrPollingTransportHandler

getContentType() - Method in class org.springframework.web.socket.sockjs.transport.handler.XhrStreamingTransportHandler

getConversionService() - Method in class org.springframework.web.socket.adapter.standard.ConvertingEncoderDecoderSupport

Strategy method used to obtain the ConversionService.

getCorsConfiguration(HttpServletRequest) - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService

getCorsConfiguration(HttpServletRequest) - Method in class org.springframework.web.socket.sockjs.support.SockJsHttpRequestHandler

getDecoders() - Method in class org.springframework.web.socket.server.standard.ServerEndpointRegistration

getDecoratorFactories() - Method in class org.springframework.web.socket.config.annotation.WebSocketTransportRegistration

getDefaultProtocolHandler() - Method in class org.springframework.web.socket.messaging.SubProtocolWebSocketHandler

Return the default sub-protocol handler to use.

getDelegate() - Method in class org.springframework.web.socket.handler.WebSocketHandlerDecorator

getDelegate() - Method in class org.springframework.web.socket.handler.WebSocketSessionDecorator

getDisconnectDelay() - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService

Return the amount of time in milliseconds before a client is considered disconnected.

getEncoders() - Method in class org.springframework.web.socket.server.standard.ServerEndpointRegistration

getEndpoint() - Method in class org.springframework.web.socket.server.standard.ServerEndpointRegistration

getEndpointClass() - Method in class org.springframework.web.socket.server.standard.ServerEndpointRegistration

getEndpointInstance(Class<T>) - Method in class org.springframework.web.socket.server.standard.ServerEndpointRegistration

getEndpointInstance(Class<T>) - Method in class org.springframework.web.socket.server.standard.SpringConfigurator

getErrorHandler() - Method in class org.springframework.web.socket.messaging.StompSubProtocolHandler

Return the configured error handler.

getExtensions() - Method in class org.springframework.web.socket.adapter.jetty.JettyWebSocketSession

getExtensions() - Method in class org.springframework.web.socket.adapter.standard.StandardWebSocketSession

getExtensions() - Method in class org.springframework.web.socket.handler.WebSocketSessionDecorator

getExtensions() - Method in class org.springframework.web.socket.server.standard.ServerEndpointRegistration

getExtensions() - Method in class org.springframework.web.socket.sockjs.client.WebSocketClientSockJsSession

getExtensions() - Method in class org.springframework.web.socket.sockjs.client.XhrClientSockJsSession

getExtensions() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractHttpSockJsSession

getExtensions() - Method in class org.springframework.web.socket.sockjs.transport.session.WebSocketServerSockJsSession

getExtensions() - Method in interface org.springframework.web.socket.WebSocketSession

Determine the negotiated extensions.

getFirst(String) - Method in class org.springframework.web.socket.WebSocketHttpHeaders

Return the first header value for the given header name, if any.

getFrameData() - Method in class org.springframework.web.socket.sockjs.frame.SockJsFrame

Return data contained in a SockJS "message" and "close" frames.

getFrameFormat(ServerHttpRequest) - Method in class org.springframework.web.socket.sockjs.transport.handler.AbstractHttpSendingTransportHandler

getFrameFormat(ServerHttpRequest) - Method in class org.springframework.web.socket.sockjs.transport.handler.EventSourceTransportHandler

getFrameFormat(ServerHttpRequest) - Method in class org.springframework.web.socket.sockjs.transport.handler.HtmlFileTransportHandler

getFrameFormat(ServerHttpRequest) - Method in class org.springframework.web.socket.sockjs.transport.handler.XhrPollingTransportHandler

getFrameFormat(ServerHttpRequest) - Method in class org.springframework.web.socket.sockjs.transport.handler.XhrStreamingTransportHandler

getHandler() - Method in class org.springframework.web.socket.handler.BeanCreatingHandlerProvider

getHandlerInternal(HttpServletRequest) - Method in class org.springframework.web.socket.server.support.WebSocketHandlerMapping

getHandlerMapping() - Method in class org.springframework.web.socket.config.annotation.ServletWebSocketHandlerRegistry

getHandlerMapping() - Method in class org.springframework.web.socket.config.annotation.WebMvcStompEndpointRegistry

Return a handler mapping with the mapped ViewControllers.

getHandlerType() - Method in class org.springframework.web.socket.handler.BeanCreatingHandlerProvider

getHandshakeHandler() - Method in class org.springframework.web.socket.config.annotation.AbstractWebSocketHandlerRegistration

getHandshakeHandler() - Method in class org.springframework.web.socket.server.support.WebSocketHttpRequestHandler

Return the HandshakeHandler.

getHandshakeHandler() - Method in class org.springframework.web.socket.sockjs.transport.handler.WebSocketTransportHandler

getHandshakeHeaders() - Method in class org.springframework.web.socket.adapter.jetty.JettyWebSocketSession

getHandshakeHeaders() - Method in class org.springframework.web.socket.adapter.standard.StandardWebSocketSession

getHandshakeHeaders() - Method in class org.springframework.web.socket.handler.WebSocketSessionDecorator

getHandshakeHeaders() - Method in class org.springframework.web.socket.sockjs.client.AbstractClientSockJsSession

getHandshakeHeaders() - Method in interface org.springframework.web.socket.sockjs.client.TransportRequest

Return the headers to send with the connect request.

getHandshakeHeaders() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractHttpSockJsSession

getHandshakeHeaders() - Method in class org.springframework.web.socket.sockjs.transport.session.WebSocketServerSockJsSession

getHandshakeHeaders() - Method in interface org.springframework.web.socket.WebSocketSession

Return the headers used in the handshake request (never null).

getHandshakeInterceptors() - Method in class org.springframework.web.socket.server.support.WebSocketHttpRequestHandler

Return the configured WebSocket handshake request interceptors.

getHandshakeInterceptors() - Method in class org.springframework.web.socket.sockjs.transport.TransportHandlingSockJsService

Return the configured WebSocket handshake request interceptors.

getHeaderInitializer() - Method in class org.springframework.web.socket.messaging.StompSubProtocolHandler

Return the configured header initializer.

getHeaders() - Method in class org.springframework.web.socket.client.WebSocketConnectionManager

Return the default headers for the WebSocket handshake request.

getHeaders() - Method in class org.springframework.web.socket.sockjs.client.XhrClientSockJsSession

getHeartbeatTime() - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService

Return the amount of time in milliseconds when the server has not sent any messages.

getHeartbeatTime() - Method in interface org.springframework.web.socket.sockjs.transport.SockJsServiceConfig

The amount of time in milliseconds when the server has not sent any messages and after which the server should send a heartbeat frame to the client in order to keep the connection from breaking.

getHttpClient() - Method in class org.springframework.web.socket.sockjs.client.JettyXhrTransport

getHttpClient() - Method in class org.springframework.web.socket.sockjs.client.UndertowXhrTransport

Return Undertow's native HTTP client.

getHttpHeaderNames() - Method in class org.springframework.web.socket.sockjs.client.SockJsClient

The configured HTTP header names to be copied from the handshake headers and also included in other HTTP requests.

getHttpMessageCacheSize() - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService

Return the size of the HTTP message cache.

getHttpMessageCacheSize() - Method in interface org.springframework.web.socket.sockjs.transport.SockJsServiceConfig

The number of server-to-client messages that a session can cache while waiting for the next HTTP polling request from the client.

getHttpMethod() - Method in enum class org.springframework.web.socket.sockjs.transport.TransportType

getHttpPollingSessions() - Method in interface org.springframework.web.socket.messaging.SubProtocolWebSocketHandler.Stats

getHttpRequestHeaders() - Method in interface org.springframework.web.socket.sockjs.client.TransportRequest

Return the headers to add to all other HTTP requests besides the handshake request such as XHR receive and send requests.

getHttpServletRequest(ServerHttpRequest) - Method in class org.springframework.web.socket.server.standard.AbstractStandardUpgradeStrategy

getHttpServletResponse(ServerHttpResponse) - Method in class org.springframework.web.socket.server.standard.AbstractStandardUpgradeStrategy

getHttpStreamingSessions() - Method in interface org.springframework.web.socket.messaging.SubProtocolWebSocketHandler.Stats

getId() - Method in class org.springframework.web.socket.adapter.jetty.JettyWebSocketSession

getId() - Method in class org.springframework.web.socket.adapter.standard.StandardWebSocketSession

getId() - Method in class org.springframework.web.socket.handler.WebSocketSessionDecorator

getId() - Method in class org.springframework.web.socket.sockjs.client.AbstractClientSockJsSession

getId() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession

getId() - Method in interface org.springframework.web.socket.WebSocketSession

Return a unique session identifier.

getInboundMessageSizeLimit() - Method in class org.springframework.web.socket.messaging.WebSocketStompClient

Get the configured inbound message buffer size in bytes.

getInfoReceiver() - Method in class org.springframework.web.socket.sockjs.client.SockJsClient

Return the configured InfoReceiver (never null).

getInfoUrl() - Method in class org.springframework.web.socket.sockjs.client.SockJsUrlInfo

getInstalledExtensions(WebSocketContainer) - Method in class org.springframework.web.socket.server.standard.AbstractStandardUpgradeStrategy

getInstalledExtensions(WebSocketContainer) - Method in class org.springframework.web.socket.server.standard.AbstractTyrusRequestUpgradeStrategy

getInterceptors() - Method in class org.springframework.web.socket.config.annotation.AbstractWebSocketHandlerRegistration

getInterceptors() - Method in class org.springframework.web.socket.config.annotation.WebMvcStompWebSocketEndpointRegistration

getLastHandler() - Method in class org.springframework.web.socket.handler.WebSocketHandlerDecorator

getLastSession() - Method in class org.springframework.web.socket.handler.WebSocketSessionDecorator

getLimitExceededSessions() - Method in interface org.springframework.web.socket.messaging.SubProtocolWebSocketHandler.Stats

getLocalAddress() - Method in class org.springframework.web.socket.adapter.jetty.JettyWebSocketSession

getLocalAddress() - Method in class org.springframework.web.socket.adapter.standard.StandardWebSocketSession

getLocalAddress() - Method in class org.springframework.web.socket.handler.WebSocketSessionDecorator

getLocalAddress() - Method in class org.springframework.web.socket.sockjs.client.WebSocketClientSockJsSession

getLocalAddress() - Method in class org.springframework.web.socket.sockjs.client.XhrClientSockJsSession

getLocalAddress() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractHttpSockJsSession

getLocalAddress() - Method in class org.springframework.web.socket.sockjs.transport.session.WebSocketServerSockJsSession

getLocalAddress() - Method in interface org.springframework.web.socket.WebSocketSession

Return the address on which the request was received.

getLoggingPeriod() - Method in class org.springframework.web.socket.config.WebSocketMessageBrokerStats

Return the configured logging period frequency in milliseconds.

getMappings() - Method in class org.springframework.web.socket.config.annotation.AbstractWebSocketHandlerRegistration

getMappings() - Method in class org.springframework.web.socket.config.annotation.WebMvcStompWebSocketEndpointRegistration

getMaxBinaryMessageBufferSize() - Method in class org.springframework.web.socket.client.standard.WebSocketContainerFactoryBean

getMaxBinaryMessageBufferSize() - Method in class org.springframework.web.socket.server.standard.ServletServerContainerFactoryBean

getMaxSessionIdleTimeout() - Method in class org.springframework.web.socket.client.standard.WebSocketContainerFactoryBean

getMaxSessionIdleTimeout() - Method in class org.springframework.web.socket.server.standard.ServletServerContainerFactoryBean

getMaxTextMessageBufferSize() - Method in class org.springframework.web.socket.client.standard.WebSocketContainerFactoryBean

getMaxTextMessageBufferSize() - Method in class org.springframework.web.socket.server.standard.ServletServerContainerFactoryBean

getMessage() - Method in class org.springframework.web.socket.messaging.AbstractSubProtocolEvent

Return the Message associated with the event.

getMessageCache() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractHttpSockJsSession

Return the SockJS buffer for messages stored transparently between polling requests.

getMessageCodec() - Method in class org.springframework.web.socket.sockjs.client.AbstractClientSockJsSession

getMessageCodec() - Method in class org.springframework.web.socket.sockjs.client.SockJsClient

Return the SockJsMessageCodec to use.

getMessageCodec() - Method in interface org.springframework.web.socket.sockjs.client.TransportRequest

Return the message codec to use for encoding SockJS messages.

getMessageCodec() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession

getMessageCodec() - Method in interface org.springframework.web.socket.sockjs.transport.SockJsServiceConfig

The codec to use for encoding and decoding SockJS messages.

getMessageCodec() - Method in class org.springframework.web.socket.sockjs.transport.TransportHandlingSockJsService

getMessageSizeLimit() - Method in class org.springframework.web.socket.config.annotation.WebSocketTransportRegistration

Protected accessor for internal use.

getMessageSizeLimit() - Method in class org.springframework.web.socket.messaging.StompSubProtocolHandler

Get the configured message buffer size limit in bytes.

getMessageType() - Method in class org.springframework.web.socket.adapter.standard.ConvertingEncoderDecoderSupport

Returns the websocket message type.

getName() - Method in class org.springframework.web.socket.adapter.standard.WebSocketToStandardExtensionAdapter

getName() - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService

Return the unique name associated with this service.

getName() - Method in class org.springframework.web.socket.WebSocketExtension

Return the name of the extension (never null or empty).

getNativeSession() - Method in class org.springframework.web.socket.adapter.AbstractWebSocketSession

getNativeSession() - Method in interface org.springframework.web.socket.adapter.NativeWebSocketSession

Return the underlying native WebSocketSession.

getNativeSession() - Method in class org.springframework.web.socket.sockjs.client.WebSocketClientSockJsSession

getNativeSession() - Method in class org.springframework.web.socket.sockjs.transport.session.WebSocketServerSockJsSession

getNativeSession(Class<R>) - Method in class org.springframework.web.socket.adapter.AbstractWebSocketSession

getNativeSession(Class<T>) - Method in interface org.springframework.web.socket.adapter.NativeWebSocketSession

Return the underlying native WebSocketSession, if available.

getNativeSession(Class<T>) - Method in class org.springframework.web.socket.sockjs.client.WebSocketClientSockJsSession

getNativeSession(Class<T>) - Method in class org.springframework.web.socket.sockjs.transport.session.WebSocketServerSockJsSession

getNoMessagesReceivedSessions() - Method in interface org.springframework.web.socket.messaging.SubProtocolWebSocketHandler.Stats

getObject() - Method in class org.springframework.web.socket.client.standard.WebSocketContainerFactoryBean

getObject() - Method in class org.springframework.web.socket.server.standard.ServletServerContainerFactoryBean

getObjectType() - Method in class org.springframework.web.socket.client.standard.WebSocketContainerFactoryBean

getObjectType() - Method in class org.springframework.web.socket.server.standard.ServletServerContainerFactoryBean

getOrder() - Method in class org.springframework.web.socket.config.annotation.ServletWebSocketHandlerRegistry

getOrder() - Method in class org.springframework.web.socket.config.annotation.WebMvcStompEndpointRegistry

getOrder() - Method in class org.springframework.web.socket.messaging.DefaultSimpUserRegistry

getOrigin() - Method in class org.springframework.web.socket.client.WebSocketConnectionManager

Return the configured origin.

getParameters() - Method in class org.springframework.web.socket.adapter.standard.WebSocketToStandardExtensionAdapter

getParameters() - Method in class org.springframework.web.socket.WebSocketExtension

Return the parameters of the extension (never null).

getPath() - Method in class org.springframework.web.socket.server.standard.ServerEndpointRegistration

getPayload() - Method in class org.springframework.web.socket.AbstractWebSocketMessage

Return the message payload (never null).

getPayload() - Method in interface org.springframework.web.socket.WebSocketMessage

Return the message payload (never null).

getPayloadLength() - Method in class org.springframework.web.socket.BinaryMessage

getPayloadLength() - Method in class org.springframework.web.socket.PingMessage

getPayloadLength() - Method in class org.springframework.web.socket.PongMessage

getPayloadLength() - Method in class org.springframework.web.socket.TextMessage

getPayloadLength() - Method in interface org.springframework.web.socket.WebSocketMessage

Return the number of bytes contained in the message.

getPhase() - Method in class org.springframework.web.socket.client.ConnectionManagerSupport

Return the phase in which this endpoint connection factory will be auto-connected and stopped.

getPhase() - Method in class org.springframework.web.socket.messaging.WebSocketStompClient

Return the configured phase.

getPrelude(ServerHttpRequest) - Method in class org.springframework.web.socket.sockjs.transport.session.StreamingSockJsSession

Get the prelude to write to the response before any other data.

getPrincipal() - Method in class org.springframework.web.socket.adapter.jetty.JettyWebSocketSession

getPrincipal() - Method in class org.springframework.web.socket.adapter.standard.StandardWebSocketSession

getPrincipal() - Method in class org.springframework.web.socket.handler.WebSocketSessionDecorator

getPrincipal() - Method in class org.springframework.web.socket.sockjs.client.AbstractClientSockJsSession

getPrincipal() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractHttpSockJsSession

getPrincipal() - Method in class org.springframework.web.socket.sockjs.transport.session.WebSocketServerSockJsSession

getPrincipal() - Method in interface org.springframework.web.socket.WebSocketSession

Return a Principal instance containing the name of the authenticated user.

getProtocolHandlerMap() - Method in class org.springframework.web.socket.messaging.SubProtocolWebSocketHandler

Return the sub-protocols keyed by protocol name.

getProtocolHandlers() - Method in class org.springframework.web.socket.messaging.SubProtocolWebSocketHandler

getReason() - Method in class org.springframework.web.socket.CloseStatus

Return the reason, or null if none.

getRemoteAddress() - Method in class org.springframework.web.socket.adapter.jetty.JettyWebSocketSession

getRemoteAddress() - Method in class org.springframework.web.socket.adapter.standard.StandardWebSocketSession

getRemoteAddress() - Method in class org.springframework.web.socket.handler.WebSocketSessionDecorator

getRemoteAddress() - Method in class org.springframework.web.socket.sockjs.client.WebSocketClientSockJsSession

getRemoteAddress() - Method in class org.springframework.web.socket.sockjs.client.XhrClientSockJsSession

getRemoteAddress() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractHttpSockJsSession

getRemoteAddress() - Method in class org.springframework.web.socket.sockjs.transport.session.WebSocketServerSockJsSession

getRemoteAddress() - Method in interface org.springframework.web.socket.WebSocketSession

Return the address of the remote client.

getRequestUpgradeStrategy() - Method in class org.springframework.web.socket.server.support.AbstractHandshakeHandler

Return the RequestUpgradeStrategy for WebSocket requests.

getResponseStatus() - Method in class org.springframework.web.socket.sockjs.transport.handler.AbstractHttpReceivingTransportHandler

getResponseStatus() - Method in class org.springframework.web.socket.sockjs.transport.handler.XhrReceivingTransportHandler

getRestTemplate() - Method in class org.springframework.web.socket.sockjs.client.RestTemplateXhrTransport

Return the configured RestTemplate.

getSecWebSocketAccept() - Method in class org.springframework.web.socket.WebSocketHttpHeaders

Returns the value of the Sec-WebSocket-Accept header.

getSecWebSocketExtensions() - Method in class org.springframework.web.socket.WebSocketHttpHeaders

Returns the value of the Sec-WebSocket-Extensions header.

getSecWebSocketKey() - Method in class org.springframework.web.socket.WebSocketHttpHeaders

Returns the value of the Sec-WebSocket-Key header.

getSecWebSocketProtocol() - Method in class org.springframework.web.socket.WebSocketHttpHeaders

Returns the value of the Sec-WebSocket-Key header.

getSecWebSocketVersion() - Method in class org.springframework.web.socket.WebSocketHttpHeaders

Returns the value of the Sec-WebSocket-Version header.

getSendBufferSizeLimit() - Method in class org.springframework.web.socket.config.annotation.WebSocketTransportRegistration

Protected accessor for internal use.

getSendBufferSizeLimit() - Method in class org.springframework.web.socket.messaging.SubProtocolWebSocketHandler

Return the buffer-size limit (number of bytes).

getSendTimeLimit() - Method in class org.springframework.web.socket.config.annotation.WebSocketTransportRegistration

Protected accessor for internal use.

getSendTimeLimit() - Method in class org.springframework.web.socket.handler.ConcurrentWebSocketSessionDecorator

Return the configured send-time limit (milliseconds).

getSendTimeLimit() - Method in class org.springframework.web.socket.messaging.SubProtocolWebSocketHandler

Return the send-time limit (milliseconds).

getServerContainer() - Method in class org.springframework.web.socket.server.standard.ServerEndpointExporter

Return the JSR-356 ServerContainer to use for endpoint registration.

getServerId() - Method in class org.springframework.web.socket.sockjs.client.SockJsUrlInfo

getServiceConfig() - Method in class org.springframework.web.socket.sockjs.transport.handler.AbstractTransportHandler

getSessionId() - Method in class org.springframework.web.socket.messaging.SessionDisconnectEvent

Return the session id.

getSessionId() - Method in class org.springframework.web.socket.sockjs.client.SockJsUrlInfo

getSockJsClientLibraryUrl() - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService

Return he URL to the SockJS JavaScript client library.

getSockJsConfig() - Method in class org.springframework.web.socket.sockjs.transport.handler.SockJsWebSocketHandler

getSockJsService() - Method in class org.springframework.web.socket.config.annotation.SockJsServiceRegistration

getSockJsService() - Method in class org.springframework.web.socket.sockjs.support.SockJsHttpRequestHandler

Return the SockJsService.

getSockJsServiceConfig() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession

getSockJsServiceRegistration() - Method in class org.springframework.web.socket.config.annotation.AbstractWebSocketHandlerRegistration

Expose the SockJsServiceRegistration -- if SockJS is enabled or null otherwise -- so that it can be configured with a TaskScheduler if the application did not provide one.

getSockJsSessionId() - Method in exception org.springframework.web.socket.sockjs.SockJsException

Return the SockJS session id.

getSockJsTaskSchedulerStatsInfo() - Method in class org.springframework.web.socket.config.WebSocketMessageBrokerStats

Get stats about the SockJS task scheduler.

getSockJsUrl() - Method in class org.springframework.web.socket.sockjs.client.SockJsUrlInfo

getSockJsUrlInfo() - Method in interface org.springframework.web.socket.sockjs.client.TransportRequest

Return information about the SockJS URL including server and session ID.

getStats() - Method in class org.springframework.web.socket.messaging.StompSubProtocolHandler

Return a structured object with internal state and counters.

getStats() - Method in class org.springframework.web.socket.messaging.SubProtocolWebSocketHandler

Return a structured object with various session counters.

getStatsInfo() - Method in class org.springframework.web.socket.messaging.StompSubProtocolHandler

Return a String describing internal state and counters.

getStatsInfo() - Method in class org.springframework.web.socket.messaging.SubProtocolWebSocketHandler

Return a String describing internal state and counters.

getStatus() - Method in exception org.springframework.web.socket.handler.SessionLimitExceededException

getStompBrokerRelayStatsInfo() - Method in class org.springframework.web.socket.config.WebSocketMessageBrokerStats

Get stats about STOMP broker relay (when using a full-featured STOMP broker).

getStompSubProtocolStatsInfo() - Method in class org.springframework.web.socket.config.WebSocketMessageBrokerStats

Get stats about STOMP-related WebSocket message processing.

getStreamBytesLimit() - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService

Return the minimum number of bytes that can be sent over a single HTTP streaming request before it will be closed.

getStreamBytesLimit() - Method in interface org.springframework.web.socket.sockjs.transport.SockJsServiceConfig

Streaming transports save responses on the client side and don't free memory used by delivered messages.

getSubprotocols() - Method in class org.springframework.web.socket.server.standard.ServerEndpointRegistration

getSubProtocols() - Method in class org.springframework.web.socket.client.WebSocketConnectionManager

Return the configured sub-protocols to use.

getSubProtocols() - Method in class org.springframework.web.socket.messaging.SubProtocolWebSocketHandler

Return all supported protocols.

getSubProtocols() - Method in class org.springframework.web.socket.sockjs.transport.handler.SockJsWebSocketHandler

getSubProtocols() - Method in interface org.springframework.web.socket.SubProtocolCapable

Return the list of supported sub-protocols.

getSupportedExtensions(ServerHttpRequest) - Method in class org.springframework.web.socket.server.jetty.JettyRequestUpgradeStrategy

getSupportedExtensions(ServerHttpRequest) - Method in interface org.springframework.web.socket.server.RequestUpgradeStrategy

Return the WebSocket protocol extensions supported by the underlying WebSocket server.

getSupportedExtensions(ServerHttpRequest) - Method in class org.springframework.web.socket.server.standard.AbstractStandardUpgradeStrategy

getSupportedProtocols() - Method in class org.springframework.web.socket.messaging.StompSubProtocolHandler

getSupportedProtocols() - Method in interface org.springframework.web.socket.messaging.SubProtocolHandler

Return the list of sub-protocols supported by this handler (never null).

getSupportedProtocols() - Method in class org.springframework.web.socket.server.support.AbstractHandshakeHandler

Return the list of supported sub-protocols.

getSupportedVersions() - Method in class org.springframework.web.socket.server.jetty.JettyRequestUpgradeStrategy

getSupportedVersions() - Method in interface org.springframework.web.socket.server.RequestUpgradeStrategy

Return the supported WebSocket protocol versions.

getSupportedVersions() - Method in class org.springframework.web.socket.server.standard.AbstractTyrusRequestUpgradeStrategy

getSupportedVersions() - Method in class org.springframework.web.socket.server.standard.StandardWebSocketUpgradeStrategy

getSupportedVersions() - Method in class org.springframework.web.socket.server.standard.UndertowRequestUpgradeStrategy

getSupportedVersions() - Method in class org.springframework.web.socket.server.support.AbstractHandshakeHandler

getTaskExecutor() - Method in class org.springframework.web.socket.client.jetty.JettyWebSocketClient

Deprecated.

Return the configured AsyncTaskExecutor.

getTaskExecutor() - Method in class org.springframework.web.socket.client.standard.AnnotatedEndpointConnectionManager

Return the configured TaskExecutor.

getTaskExecutor() - Method in class org.springframework.web.socket.client.standard.EndpointConnectionManager

Return the configured TaskExecutor.

getTaskExecutor() - Method in class org.springframework.web.socket.client.standard.StandardWebSocketClient

Return the configured AsyncTaskExecutor.

getTaskExecutor() - Method in class org.springframework.web.socket.sockjs.client.RestTemplateXhrTransport

Return the configured TaskExecutor.

getTaskScheduler() - Method in class org.springframework.web.socket.config.annotation.SockJsServiceRegistration

Return the TaskScheduler, if configured.

getTaskScheduler() - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService

A scheduler instance to use for scheduling heart-beat messages.

getTaskScheduler() - Method in interface org.springframework.web.socket.sockjs.transport.SockJsServiceConfig

A scheduler instance to use for scheduling heart-beat messages.

getTextMessageSizeLimit() - Method in class org.springframework.web.socket.adapter.jetty.JettyWebSocketSession

getTextMessageSizeLimit() - Method in class org.springframework.web.socket.adapter.standard.StandardWebSocketSession

getTextMessageSizeLimit() - Method in class org.springframework.web.socket.handler.WebSocketSessionDecorator

getTextMessageSizeLimit() - Method in class org.springframework.web.socket.sockjs.client.WebSocketClientSockJsSession

getTextMessageSizeLimit() - Method in class org.springframework.web.socket.sockjs.client.XhrClientSockJsSession

getTextMessageSizeLimit() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractHttpSockJsSession

getTextMessageSizeLimit() - Method in class org.springframework.web.socket.sockjs.transport.session.WebSocketServerSockJsSession

getTextMessageSizeLimit() - Method in interface org.springframework.web.socket.WebSocketSession

Get the configured maximum size for an incoming text message.

getTimeSinceLastActive() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession

getTimeSinceLastActive() - Method in interface org.springframework.web.socket.sockjs.transport.SockJsSession

Return the time (in ms) since the session was last active, or otherwise if the session is new, then the time since the session was created.

getTimeSinceSendStarted() - Method in class org.springframework.web.socket.handler.ConcurrentWebSocketSessionDecorator

Return the time (milliseconds) since the current send started, or 0 if no send is currently in progress.

getTimeToFirstMessage() - Method in class org.springframework.web.socket.config.annotation.WebSocketTransportRegistration

Protected accessor for internal use.

getTimeToFirstMessage() - Method in class org.springframework.web.socket.messaging.SubProtocolWebSocketHandler

Return the maximum time allowed after the WebSocket connection is established and before the first sub-protocol message.

getTotalConnect() - Method in interface org.springframework.web.socket.messaging.StompSubProtocolHandler.Stats

The number of CONNECT frames processed.

getTotalConnected() - Method in interface org.springframework.web.socket.messaging.StompSubProtocolHandler.Stats

The number of CONNECTED frames processed.

getTotalDisconnect() - Method in interface org.springframework.web.socket.messaging.StompSubProtocolHandler.Stats

The number of DISCONNECT frames processed.

getTotalSessions() - Method in interface org.springframework.web.socket.messaging.SubProtocolWebSocketHandler.Stats

getTransportErrorSessions() - Method in interface org.springframework.web.socket.messaging.SubProtocolWebSocketHandler.Stats

getTransportHandlers() - Method in class org.springframework.web.socket.sockjs.transport.TransportHandlingSockJsService

Return the registered handlers per transport type.

getTransportRegistration() - Method in class org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurationSupport

getTransportType() - Method in class org.springframework.web.socket.sockjs.transport.handler.EventSourceTransportHandler

getTransportType() - Method in class org.springframework.web.socket.sockjs.transport.handler.HtmlFileTransportHandler

getTransportType() - Method in class org.springframework.web.socket.sockjs.transport.handler.WebSocketTransportHandler

getTransportType() - Method in class org.springframework.web.socket.sockjs.transport.handler.XhrPollingTransportHandler

getTransportType() - Method in class org.springframework.web.socket.sockjs.transport.handler.XhrReceivingTransportHandler

getTransportType() - Method in class org.springframework.web.socket.sockjs.transport.handler.XhrStreamingTransportHandler

getTransportType() - Method in interface org.springframework.web.socket.sockjs.transport.TransportHandler

Return the transport type supported by this handler.

getTransportTypes() - Method in class org.springframework.web.socket.sockjs.client.AbstractXhrTransport

getTransportTypes() - Method in interface org.springframework.web.socket.sockjs.client.Transport

Get the SockJS transport types that this transport can be used for.

getTransportTypes() - Method in class org.springframework.web.socket.sockjs.client.WebSocketTransport

getTransportUrl() - Method in interface org.springframework.web.socket.sockjs.client.TransportRequest

Return the transport URL for the given transport.

getTransportUrl(TransportType) - Method in class org.springframework.web.socket.sockjs.client.SockJsUrlInfo

getType() - Method in class org.springframework.web.socket.adapter.standard.ConvertingEncoderDecoderSupport

Returns the type being converted.

getType() - Method in class org.springframework.web.socket.sockjs.frame.SockJsFrame

Return the SockJS frame type.

getUndeliveredMessages() - Method in exception org.springframework.web.socket.sockjs.SockJsMessageDeliveryException

getUri() - Method in class org.springframework.web.socket.adapter.jetty.JettyWebSocketSession

getUri() - Method in class org.springframework.web.socket.adapter.standard.StandardWebSocketSession

getUri() - Method in class org.springframework.web.socket.client.ConnectionManagerSupport

getUri() - Method in class org.springframework.web.socket.handler.WebSocketSessionDecorator

getUri() - Method in class org.springframework.web.socket.sockjs.client.AbstractClientSockJsSession

getUri() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractHttpSockJsSession

getUri() - Method in class org.springframework.web.socket.sockjs.transport.session.WebSocketServerSockJsSession

getUri() - Method in interface org.springframework.web.socket.WebSocketSession

Return the URI used to open the WebSocket connection.

getUrlPathHelper() - Method in class org.springframework.web.socket.config.annotation.ServletWebSocketHandlerRegistry

getUrlPathHelper() - Method in class org.springframework.web.socket.config.annotation.WebMvcStompEndpointRegistry

getUser() - Method in class org.springframework.web.socket.client.jetty.JettyWebSocketClient

Deprecated.

Return the user to make available through WebSocketSession.getPrincipal().

getUser() - Method in class org.springframework.web.socket.messaging.AbstractSubProtocolEvent

Return the user for the session associated with the event.

getUser() - Method in class org.springframework.web.socket.sockjs.client.SockJsClient

Return the user to associate with the SockJS session and make available via WebSocketSession.getPrincipal().

getUser() - Method in interface org.springframework.web.socket.sockjs.client.TransportRequest

Return the user associated with the request, if any.

getUser(String) - Method in class org.springframework.web.socket.messaging.DefaultSimpUserRegistry

getUserCount() - Method in class org.springframework.web.socket.messaging.DefaultSimpUserRegistry

getUserProperties() - Method in class org.springframework.web.socket.client.standard.StandardWebSocketClient

The configured user properties.

getUserProperties() - Method in class org.springframework.web.socket.server.standard.ServerEndpointRegistration

getUsers() - Method in class org.springframework.web.socket.messaging.DefaultSimpUserRegistry

getUuid() - Method in class org.springframework.web.socket.sockjs.client.SockJsUrlInfo

getWebSocketClient() - Method in class org.springframework.web.socket.messaging.WebSocketStompClient

Return the configured WebSocketClient.

getWebSocketClient() - Method in class org.springframework.web.socket.sockjs.client.WebSocketTransport

Return the configured WebSocketClient.

getWebSocketContainer() - Method in class org.springframework.web.socket.client.standard.AnnotatedEndpointConnectionManager

getWebSocketContainer() - Method in class org.springframework.web.socket.client.standard.EndpointConnectionManager

getWebSocketHandler() - Method in class org.springframework.web.socket.server.support.WebSocketHttpRequestHandler

Return the WebSocketHandler.

getWebSocketHandler() - Method in class org.springframework.web.socket.sockjs.client.AbstractClientSockJsSession

getWebSocketHandler() - Method in class org.springframework.web.socket.sockjs.support.SockJsHttpRequestHandler

Return the WebSocketHandler.

getWebSocketSessions() - Method in interface org.springframework.web.socket.messaging.SubProtocolWebSocketHandler.Stats

getWebSocketSessionStatsInfo() - Method in class org.springframework.web.socket.config.WebSocketMessageBrokerStats

Get stats about WebSocket sessions.

getWorker() - Method in class org.springframework.web.socket.sockjs.client.UndertowXhrTransport

Return the XnioWorker backing the I/O operations for Undertow's HTTP client.

GlassFishRequestUpgradeStrategy - Class in org.springframework.web.socket.server.standard

A WebSocket RequestUpgradeStrategy for Oracle's GlassFish 4.1 and higher.

GlassFishRequestUpgradeStrategy() - Constructor for class org.springframework.web.socket.server.standard.GlassFishRequestUpgradeStrategy

GOING_AWAY - Static variable in class org.springframework.web.socket.CloseStatus

"1001 indicates that an endpoint is "going away", such as a server going down or a browser having navigated away from a page."

H

handleBinaryMessage(WebSocketSession, BinaryMessage) - Method in class org.springframework.web.socket.handler.AbstractWebSocketHandler

handleBinaryMessage(WebSocketSession, BinaryMessage) - Method in class org.springframework.web.socket.handler.TextWebSocketHandler

handleClientMessageProcessingError(Message<byte[]>, Throwable) - Method in class org.springframework.web.socket.messaging.StompSubProtocolErrorHandler

handleClientMessageProcessingError(Message<P>, Throwable) - Method in interface org.springframework.web.socket.messaging.SubProtocolErrorHandler

Handle errors thrown while processing client messages providing an opportunity to prepare the error message or to prevent one from being sent.

handleErrorMessageToClient(Message<byte[]>) - Method in class org.springframework.web.socket.messaging.StompSubProtocolErrorHandler

handleErrorMessageToClient(Message<P>) - Method in interface org.springframework.web.socket.messaging.SubProtocolErrorHandler

Handle errors sent from the server side to clients, e.g.

handleFrame(String) - Method in class org.springframework.web.socket.sockjs.client.AbstractClientSockJsSession

handleInitialRequest(ServerHttpRequest, ServerHttpResponse, SockJsFrameFormat) - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractHttpSockJsSession

Handle the first request for receiving messages on a SockJS HTTP transport based session.

handleInternal(StompHeaderAccessor, byte[], Throwable, StompHeaderAccessor) - Method in class org.springframework.web.socket.messaging.StompSubProtocolErrorHandler

handleInvalidConnectHeader(ServerHttpRequest, ServerHttpResponse) - Method in class org.springframework.web.socket.server.support.AbstractHandshakeHandler

handleInvalidUpgradeHeader(ServerHttpRequest, ServerHttpResponse) - Method in class org.springframework.web.socket.server.support.AbstractHandshakeHandler

handleMessage(Message<?>) - Method in class org.springframework.web.socket.messaging.SubProtocolWebSocketHandler

Handle an outbound Spring Message to a WebSocket client.

handleMessage(TextMessage, WebSocketSession) - Method in class org.springframework.web.socket.sockjs.transport.session.WebSocketServerSockJsSession

handleMessage(WebSocketSession, WebSocketMessage<?>) - Method in class org.springframework.web.socket.handler.AbstractWebSocketHandler

handleMessage(WebSocketSession, WebSocketMessage<?>) - Method in class org.springframework.web.socket.handler.ExceptionWebSocketHandlerDecorator

handleMessage(WebSocketSession, WebSocketMessage<?>) - Method in class org.springframework.web.socket.handler.LoggingWebSocketHandlerDecorator

handleMessage(WebSocketSession, WebSocketMessage<?>) - Method in class org.springframework.web.socket.handler.PerConnectionWebSocketHandler

handleMessage(WebSocketSession, WebSocketMessage<?>) - Method in class org.springframework.web.socket.handler.WebSocketHandlerDecorator

handleMessage(WebSocketSession, WebSocketMessage<?>) - Method in class org.springframework.web.socket.messaging.SubProtocolWebSocketHandler

Handle an inbound message from a WebSocket client.

handleMessage(WebSocketSession, WebSocketMessage<?>) - Method in interface org.springframework.web.socket.WebSocketHandler

Invoked when a new WebSocket message arrives.

handleMessageFromClient(WebSocketSession, WebSocketMessage<?>, MessageChannel) - Method in class org.springframework.web.socket.messaging.StompSubProtocolHandler

Handle incoming WebSocket messages from clients.

handleMessageFromClient(WebSocketSession, WebSocketMessage<?>, MessageChannel) - Method in interface org.springframework.web.socket.messaging.SubProtocolHandler

Handle the given WebSocketMessage received from a client.

handleMessageToClient(WebSocketSession, Message<?>) - Method in class org.springframework.web.socket.messaging.StompSubProtocolHandler

Handle STOMP messages going back out to WebSocket clients.

handleMessageToClient(WebSocketSession, Message<?>) - Method in interface org.springframework.web.socket.messaging.SubProtocolHandler

Handle the given Message to the client associated with the given WebSocket session.

handlePongMessage(WebSocketSession, PongMessage) - Method in class org.springframework.web.socket.handler.AbstractWebSocketHandler

handleRawWebSocketRequest(ServerHttpRequest, ServerHttpResponse, WebSocketHandler) - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService

Handle request for raw WebSocket communication, i.e.

handleRawWebSocketRequest(ServerHttpRequest, ServerHttpResponse, WebSocketHandler) - Method in class org.springframework.web.socket.sockjs.transport.TransportHandlingSockJsService

handleRequest(HttpServletRequest, HttpServletResponse) - Method in class org.springframework.web.socket.server.support.WebSocketHttpRequestHandler

handleRequest(HttpServletRequest, HttpServletResponse) - Method in class org.springframework.web.socket.sockjs.support.SockJsHttpRequestHandler

handleRequest(ServerHttpRequest, ServerHttpResponse, String, WebSocketHandler) - Method in interface org.springframework.web.socket.sockjs.SockJsService

Process a SockJS HTTP request.

handleRequest(ServerHttpRequest, ServerHttpResponse, String, WebSocketHandler) - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService

This method determines the SockJS path and handles SockJS static URLs.

handleRequest(ServerHttpRequest, ServerHttpResponse, WebSocketHandler, SockJsSession) - Method in class org.springframework.web.socket.sockjs.transport.handler.AbstractHttpReceivingTransportHandler

handleRequest(ServerHttpRequest, ServerHttpResponse, WebSocketHandler, SockJsSession) - Method in class org.springframework.web.socket.sockjs.transport.handler.AbstractHttpSendingTransportHandler

handleRequest(ServerHttpRequest, ServerHttpResponse, WebSocketHandler, SockJsSession) - Method in class org.springframework.web.socket.sockjs.transport.handler.WebSocketTransportHandler

handleRequest(ServerHttpRequest, ServerHttpResponse, WebSocketHandler, SockJsSession) - Method in interface org.springframework.web.socket.sockjs.transport.TransportHandler

Handle the given request and delegate messages to the provided WebSocketHandler.

handleRequestInternal(ServerHttpRequest, ServerHttpResponse, boolean) - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractHttpSockJsSession

Invoked when a SockJS transport request is received.

handleRequestInternal(ServerHttpRequest, ServerHttpResponse, boolean) - Method in class org.springframework.web.socket.sockjs.transport.session.PollingSockJsSession

handleRequestInternal(ServerHttpRequest, ServerHttpResponse, boolean) - Method in class org.springframework.web.socket.sockjs.transport.session.StreamingSockJsSession

handleRequestInternal(ServerHttpRequest, ServerHttpResponse, AbstractHttpSockJsSession) - Method in class org.springframework.web.socket.sockjs.transport.handler.AbstractHttpSendingTransportHandler

handleRequestInternal(ServerHttpRequest, ServerHttpResponse, AbstractHttpSockJsSession) - Method in class org.springframework.web.socket.sockjs.transport.handler.HtmlFileTransportHandler

handleRequestInternal(ServerHttpRequest, ServerHttpResponse, WebSocketHandler, AbstractHttpSockJsSession) - Method in class org.springframework.web.socket.sockjs.transport.handler.AbstractHttpReceivingTransportHandler

handleSuccess(HttpServletRequest, HttpServletResponse, WebSocketEngine.UpgradeInfo, TyrusUpgradeResponse) - Method in class org.springframework.web.socket.server.standard.AbstractTyrusRequestUpgradeStrategy

handleSuccess(HttpServletRequest, HttpServletResponse, WebSocketEngine.UpgradeInfo, TyrusUpgradeResponse) - Method in class org.springframework.web.socket.server.standard.GlassFishRequestUpgradeStrategy

handleSuccess(HttpServletRequest, HttpServletResponse, WebSocketEngine.UpgradeInfo, TyrusUpgradeResponse) - Method in class org.springframework.web.socket.server.standard.WebLogicRequestUpgradeStrategy

handleSuccessiveRequest(ServerHttpRequest, ServerHttpResponse, SockJsFrameFormat) - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractHttpSockJsSession

Handle all requests, except the first one, to receive messages on a SockJS HTTP transport based session.

handleTextMessage(WebSocketSession, TextMessage) - Method in class org.springframework.web.socket.handler.AbstractWebSocketHandler

handleTextMessage(WebSocketSession, TextMessage) - Method in class org.springframework.web.socket.handler.BinaryWebSocketHandler

handleTextMessage(WebSocketSession, TextMessage) - Method in class org.springframework.web.socket.sockjs.transport.handler.SockJsWebSocketHandler

handleTransportError(Throwable) - Method in class org.springframework.web.socket.sockjs.client.AbstractClientSockJsSession

handleTransportError(WebSocketSession, Throwable) - Method in class org.springframework.web.socket.handler.AbstractWebSocketHandler

handleTransportError(WebSocketSession, Throwable) - Method in class org.springframework.web.socket.handler.ExceptionWebSocketHandlerDecorator

handleTransportError(WebSocketSession, Throwable) - Method in class org.springframework.web.socket.handler.LoggingWebSocketHandlerDecorator

handleTransportError(WebSocketSession, Throwable) - Method in class org.springframework.web.socket.handler.PerConnectionWebSocketHandler

handleTransportError(WebSocketSession, Throwable) - Method in class org.springframework.web.socket.handler.WebSocketHandlerDecorator

handleTransportError(WebSocketSession, Throwable) - Method in class org.springframework.web.socket.messaging.SubProtocolWebSocketHandler

handleTransportError(WebSocketSession, Throwable) - Method in class org.springframework.web.socket.sockjs.transport.handler.SockJsWebSocketHandler

handleTransportError(WebSocketSession, Throwable) - Method in interface org.springframework.web.socket.WebSocketHandler

Handle an error from the underlying WebSocket message transport.

handleTransportRequest(ServerHttpRequest, ServerHttpResponse, WebSocketHandler, String, String) - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService

Handle a SockJS session URL (i.e.

handleTransportRequest(ServerHttpRequest, ServerHttpResponse, WebSocketHandler, String, String) - Method in class org.springframework.web.socket.sockjs.transport.TransportHandlingSockJsService

handleWebSocketVersionNotSupported(ServerHttpRequest, ServerHttpResponse) - Method in class org.springframework.web.socket.server.support.AbstractHandshakeHandler

HandshakeFailureException - Exception in org.springframework.web.socket.server

Thrown when handshake processing failed to complete due to an internal, unrecoverable error.

HandshakeFailureException(String) - Constructor for exception org.springframework.web.socket.server.HandshakeFailureException

HandshakeFailureException(String, Throwable) - Constructor for exception org.springframework.web.socket.server.HandshakeFailureException

HandshakeHandler - Interface in org.springframework.web.socket.server

Contract for processing a WebSocket handshake request.

HandshakeInterceptor - Interface in org.springframework.web.socket.server

Interceptor for WebSocket handshake requests.

HandshakeInterceptorChain - Class in org.springframework.web.socket.server.support

A helper class that assists with invoking a list of handshake interceptors.

HandshakeInterceptorChain(List<HandshakeInterceptor>, WebSocketHandler) - Constructor for class org.springframework.web.socket.server.support.HandshakeInterceptorChain

hashCode() - Method in class org.springframework.web.socket.AbstractWebSocketMessage

hashCode() - Method in class org.springframework.web.socket.CloseStatus

hashCode() - Method in class org.springframework.web.socket.sockjs.frame.SockJsFrame

hashCode() - Method in class org.springframework.web.socket.WebSocketExtension

hashCode() - Method in class org.springframework.web.socket.WebSocketHttpHeaders

HEARTBEAT - Enum constant in enum class org.springframework.web.socket.sockjs.frame.SockJsFrameType

heartbeatFrame() - Static method in class org.springframework.web.socket.sockjs.frame.SockJsFrame

HTML_FILE - Enum constant in enum class org.springframework.web.socket.sockjs.transport.TransportType

HtmlFileTransportHandler - Class in org.springframework.web.socket.sockjs.transport.handler

An HTTP TransportHandler that uses a famous browser document.domain technique.

HtmlFileTransportHandler() - Constructor for class org.springframework.web.socket.sockjs.transport.handler.HtmlFileTransportHandler

HTTP_SESSION_ID_ATTR_NAME - Static variable in class org.springframework.web.socket.server.support.HttpSessionHandshakeInterceptor

The name of the attribute under which the HTTP session id is exposed when copyHttpSessionId is "true".

HttpSessionHandshakeInterceptor - Class in org.springframework.web.socket.server.support

An interceptor to copy information from the HTTP session to the "handshake attributes" map to be made available via WebSocketSession.getAttributes().

HttpSessionHandshakeInterceptor() - Constructor for class org.springframework.web.socket.server.support.HttpSessionHandshakeInterceptor

Default constructor for copying all HTTP session attributes and the HTTP session id.

HttpSessionHandshakeInterceptor(Collection<String>) - Constructor for class org.springframework.web.socket.server.support.HttpSessionHandshakeInterceptor

Constructor for copying specific HTTP session attributes and the HTTP session id.

I

idGenerator - Static variable in class org.springframework.web.socket.adapter.AbstractWebSocketSession

InfoReceiver - Interface in org.springframework.web.socket.sockjs.client

A component that can execute the SockJS "Info" request that needs to be performed before the SockJS session starts in order to check server endpoint capabilities such as whether the endpoint permits use of WebSocket.

init() - Method in class org.springframework.web.socket.config.WebSocketNamespaceHandler

init(EndpointConfig) - Method in class org.springframework.web.socket.adapter.standard.ConvertingEncoderDecoderSupport

Called to initialize the encoder/decoder.

initialize(SockJsServiceConfig) - Method in class org.springframework.web.socket.sockjs.transport.handler.AbstractTransportHandler

initialize(SockJsServiceConfig) - Method in interface org.springframework.web.socket.sockjs.transport.TransportHandler

Initialize this handler with the given configuration.

initializeDelegateSession(WebSocketSession) - Method in class org.springframework.web.socket.sockjs.client.WebSocketClientSockJsSession

initializeDelegateSession(WebSocketSession) - Method in class org.springframework.web.socket.sockjs.transport.session.WebSocketServerSockJsSession

initializeNativeSession(Session) - Method in class org.springframework.web.socket.adapter.standard.StandardWebSocketSession

initializeNativeSession(Session) - Method in class org.springframework.web.socket.adapter.jetty.JettyWebSocketSession

initializeNativeSession(T) - Method in class org.springframework.web.socket.adapter.AbstractWebSocketSession

initServletContext(ServletContext) - Method in class org.springframework.web.socket.server.standard.ServerEndpointExporter

initServletContext(ServletContext) - Method in class org.springframework.web.socket.server.support.WebSocketHandlerMapping

isActive() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractHttpSockJsSession

isActive() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession

Polling and Streaming sessions periodically close the current HTTP request and wait for the next request to come through.

isActive() - Method in class org.springframework.web.socket.sockjs.transport.session.WebSocketServerSockJsSession

isAutoStartup() - Method in class org.springframework.web.socket.client.ConnectionManagerSupport

Return the value for the 'autoStartup' property.

isAutoStartup() - Method in class org.springframework.web.socket.messaging.WebSocketStompClient

Return the value for the 'autoStartup' property.

isClosed() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession

isConnected() - Method in class org.springframework.web.socket.client.ConnectionManagerSupport

Whether the connection is open/true or closed/false.

isConnected() - Method in class org.springframework.web.socket.client.standard.AnnotatedEndpointConnectionManager

isConnected() - Method in class org.springframework.web.socket.client.standard.EndpointConnectionManager

isConnected() - Method in class org.springframework.web.socket.client.WebSocketConnectionManager

isContextRequired() - Method in class org.springframework.web.socket.server.standard.ServerEndpointExporter

isCopyAllAttributes() - Method in class org.springframework.web.socket.server.support.HttpSessionHandshakeInterceptor

Whether to copy all HTTP session attributes.

isCopyHttpSessionId() - Method in class org.springframework.web.socket.server.support.HttpSessionHandshakeInterceptor

Whether to copy the HTTP session id to the handshake attributes.

isCreateSession() - Method in class org.springframework.web.socket.server.support.HttpSessionHandshakeInterceptor

Whether the HTTP session is allowed to be created.

isDisconnected() - Method in class org.springframework.web.socket.sockjs.client.AbstractClientSockJsSession

isEmpty() - Method in class org.springframework.web.socket.WebSocketHttpHeaders

isLast() - Method in class org.springframework.web.socket.AbstractWebSocketMessage

Whether this is the last part of a message sent as a series of partial messages.

isLast() - Method in interface org.springframework.web.socket.WebSocketMessage

When partial message support is available and requested via WebSocketHandler.supportsPartialMessages(), this method returns true if the current message is the last part of the complete WebSocket message sent by the client.

isNew() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession

isOpen() - Method in class org.springframework.web.socket.adapter.jetty.JettyWebSocketSession

isOpen() - Method in class org.springframework.web.socket.adapter.standard.StandardWebSocketSession

isOpen() - Method in class org.springframework.web.socket.handler.WebSocketSessionDecorator

isOpen() - Method in class org.springframework.web.socket.sockjs.client.AbstractClientSockJsSession

isOpen() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession

isOpen() - Method in interface org.springframework.web.socket.WebSocketSession

Whether the underlying connection is open.

isRunning() - Method in class org.springframework.web.socket.client.ConnectionManagerSupport

Return whether this ConnectionManager has been started.

isRunning() - Method in class org.springframework.web.socket.client.jetty.JettyWebSocketClient

Deprecated.

isRunning() - Method in class org.springframework.web.socket.messaging.SubProtocolWebSocketHandler

isRunning() - Method in class org.springframework.web.socket.messaging.WebSocketStompClient

isRunning() - Method in class org.springframework.web.socket.server.support.AbstractHandshakeHandler

isRunning() - Method in class org.springframework.web.socket.server.support.WebSocketHandlerMapping

isRunning() - Method in class org.springframework.web.socket.server.support.WebSocketHttpRequestHandler

isRunning() - Method in class org.springframework.web.socket.sockjs.client.JettyXhrTransport

isRunning() - Method in class org.springframework.web.socket.sockjs.client.SockJsClient

isRunning() - Method in class org.springframework.web.socket.sockjs.client.WebSocketTransport

isRunning() - Method in class org.springframework.web.socket.sockjs.support.SockJsHttpRequestHandler

isRunning() - Method in class org.springframework.web.socket.sockjs.transport.handler.WebSocketTransportHandler

isRunning() - Method in class org.springframework.web.socket.sockjs.transport.TransportHandlingSockJsService

isSessionCookieNeeded() - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService

Return whether the JSESSIONID cookie is required for the application to function.

isSingleton() - Method in class org.springframework.web.socket.client.standard.WebSocketContainerFactoryBean

isSingleton() - Method in class org.springframework.web.socket.server.standard.ServletServerContainerFactoryBean

isValidOrigin(ServerHttpRequest) - Method in class org.springframework.web.socket.server.support.AbstractHandshakeHandler

Return whether the request Origin header value is valid or not.

isWebSocketEnabled() - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService

Return whether WebSocket transport is enabled.

isWebSocketVersionSupported(WebSocketHttpHeaders) - Method in class org.springframework.web.socket.server.support.AbstractHandshakeHandler

isXhrStreamingDisabled() - Method in class org.springframework.web.socket.sockjs.client.AbstractXhrTransport

Whether XHR streaming is disabled or not.

isXhrStreamingDisabled() - Method in interface org.springframework.web.socket.sockjs.client.XhrTransport

An XhrTransport supports both the "xhr_streaming" and "xhr" SockJS server transports.

J

Jackson2SockJsMessageCodec - Class in org.springframework.web.socket.sockjs.frame

A Jackson 2.x codec for encoding and decoding SockJS messages.

Jackson2SockJsMessageCodec() - Constructor for class org.springframework.web.socket.sockjs.frame.Jackson2SockJsMessageCodec

Jackson2SockJsMessageCodec(ObjectMapper) - Constructor for class org.springframework.web.socket.sockjs.frame.Jackson2SockJsMessageCodec

JettyRequestUpgradeStrategy - Class in org.springframework.web.socket.server.jetty

A RequestUpgradeStrategy for Jetty 11.

JettyRequestUpgradeStrategy() - Constructor for class org.springframework.web.socket.server.jetty.JettyRequestUpgradeStrategy

JettyWebSocketClient - Class in org.springframework.web.socket.client.jetty

Deprecated, for removal: This API element is subject to removal in a future version.

as of 6.0.3, in favor of StandardWebSocketClient

JettyWebSocketClient() - Constructor for class org.springframework.web.socket.client.jetty.JettyWebSocketClient

Deprecated.

Default constructor that creates an instance of WebSocketClient.

JettyWebSocketClient(WebSocketClient) - Constructor for class org.springframework.web.socket.client.jetty.JettyWebSocketClient

Deprecated.

Constructor that accepts an existing WebSocketClient instance.

JettyWebSocketHandlerAdapter - Class in org.springframework.web.socket.adapter.jetty

Adapts WebSocketHandler to the Jetty 9 WebSocket API.

JettyWebSocketHandlerAdapter(WebSocketHandler, JettyWebSocketSession) - Constructor for class org.springframework.web.socket.adapter.jetty.JettyWebSocketHandlerAdapter

JettyWebSocketSession - Class in org.springframework.web.socket.adapter.jetty

A WebSocketSession for use with the Jetty 9.4 WebSocket API.

JettyWebSocketSession(Map<String, Object>) - Constructor for class org.springframework.web.socket.adapter.jetty.JettyWebSocketSession

Create a new JettyWebSocketSession instance.

JettyWebSocketSession(Map<String, Object>, Principal) - Constructor for class org.springframework.web.socket.adapter.jetty.JettyWebSocketSession

Create a new JettyWebSocketSession instance associated with the given user.

JettyXhrTransport - Class in org.springframework.web.socket.sockjs.client

An XHR transport based on Jetty's HttpClient.

JettyXhrTransport(HttpClient) - Constructor for class org.springframework.web.socket.sockjs.client.JettyXhrTransport

K

keySet() - Method in class org.springframework.web.socket.WebSocketHttpHeaders

L

logger - Static variable in class org.springframework.web.socket.adapter.AbstractWebSocketSession

logger - Variable in class org.springframework.web.socket.client.AbstractWebSocketClient

logger - Variable in class org.springframework.web.socket.client.ConnectionManagerSupport

logger - Variable in class org.springframework.web.socket.server.standard.AbstractStandardUpgradeStrategy

logger - Variable in class org.springframework.web.socket.server.support.AbstractHandshakeHandler

logger - Variable in class org.springframework.web.socket.server.support.OriginHandshakeInterceptor

logger - Variable in class org.springframework.web.socket.sockjs.client.AbstractClientSockJsSession

logger - Variable in class org.springframework.web.socket.sockjs.client.AbstractXhrTransport

logger - Variable in class org.springframework.web.socket.sockjs.support.AbstractSockJsService

logger - Variable in class org.springframework.web.socket.sockjs.transport.handler.AbstractTransportHandler

logger - Variable in class org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession

LoggingWebSocketHandlerDecorator - Class in org.springframework.web.socket.handler

A WebSocketHandlerDecorator that adds logging to WebSocket lifecycle events.

LoggingWebSocketHandlerDecorator(WebSocketHandler) - Constructor for class org.springframework.web.socket.handler.LoggingWebSocketHandlerDecorator

M

MESSAGE - Enum constant in enum class org.springframework.web.socket.sockjs.frame.SockJsFrameType

messageFrame(SockJsMessageCodec, String...) - Static method in class org.springframework.web.socket.sockjs.frame.SockJsFrame

MINIMUM_WEBSOCKET_MESSAGE_SIZE - Static variable in class org.springframework.web.socket.messaging.StompSubProtocolHandler

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.

modifyHandshake(ServerEndpointConfig, HandshakeRequest, HandshakeResponse) - Method in class org.springframework.web.socket.server.standard.ServerEndpointRegistration

N

NativeWebSocketSession - Interface in org.springframework.web.socket.adapter

A WebSocketSession that exposes the underlying, native WebSocketSession through a getter.

NO_CLOSE_FRAME - Static variable in class org.springframework.web.socket.CloseStatus

"1006 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint.

NO_STATUS_CODE - Static variable in class org.springframework.web.socket.CloseStatus

"1005 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint.

NORMAL - Static variable in class org.springframework.web.socket.CloseStatus

"1000 indicates a normal closure, meaning that the purpose for which the connection was established has been fulfilled."

NOT_ACCEPTABLE - Static variable in class org.springframework.web.socket.CloseStatus

"1003 indicates that an endpoint is terminating the connection because it has received a type of data it cannot accept (e.g., an endpoint that understands only text data MAY send this if it receives a binary message)."

O

onApplicationEvent(ApplicationEvent) - Method in class org.springframework.web.socket.messaging.DefaultSimpUserRegistry

onClose(Session, CloseReason) - Method in class org.springframework.web.socket.adapter.standard.StandardWebSocketHandlerAdapter

onError(Session, Throwable) - Method in class org.springframework.web.socket.adapter.standard.StandardWebSocketHandlerAdapter

onOpen(Session, EndpointConfig) - Method in class org.springframework.web.socket.adapter.standard.StandardWebSocketHandlerAdapter

onWebSocketBinary(byte[], int, int) - Method in class org.springframework.web.socket.adapter.jetty.JettyWebSocketHandlerAdapter

onWebSocketClose(int, String) - Method in class org.springframework.web.socket.adapter.jetty.JettyWebSocketHandlerAdapter

onWebSocketConnect(Session) - Method in class org.springframework.web.socket.adapter.jetty.JettyWebSocketHandlerAdapter

onWebSocketError(Throwable) - Method in class org.springframework.web.socket.adapter.jetty.JettyWebSocketHandlerAdapter

onWebSocketFrame(Frame) - Method in class org.springframework.web.socket.adapter.jetty.JettyWebSocketHandlerAdapter

onWebSocketText(String) - Method in class org.springframework.web.socket.adapter.jetty.JettyWebSocketHandlerAdapter

OPEN - Enum constant in enum class org.springframework.web.socket.sockjs.frame.SockJsFrameType

openConnection() - Method in class org.springframework.web.socket.client.ConnectionManagerSupport

Subclasses implement this to actually establish the connection.

openConnection() - Method in class org.springframework.web.socket.client.standard.AnnotatedEndpointConnectionManager

openConnection() - Method in class org.springframework.web.socket.client.standard.EndpointConnectionManager

openConnection() - Method in class org.springframework.web.socket.client.WebSocketConnectionManager

openFrame() - Static method in class org.springframework.web.socket.sockjs.frame.SockJsFrame

org.springframework.web.socket - package org.springframework.web.socket

Common abstractions and Spring configuration support for WebSocket applications.

org.springframework.web.socket.adapter - package org.springframework.web.socket.adapter

Classes adapting Spring's WebSocket API to and from WebSocket providers.

org.springframework.web.socket.adapter.jetty - package org.springframework.web.socket.adapter.jetty

Adapter classes for the Jetty WebSocket API.

org.springframework.web.socket.adapter.standard - package org.springframework.web.socket.adapter.standard

Adapter classes for the standard Jakarta WebSocket API.

org.springframework.web.socket.client - package org.springframework.web.socket.client

Client-side abstractions for WebSocket applications.

org.springframework.web.socket.client.jetty - package org.springframework.web.socket.client.jetty

Client-side support for the Jetty WebSocket API.

org.springframework.web.socket.client.standard - package org.springframework.web.socket.client.standard

Client-side classes for use with standard Jakarta WebSocket endpoints.

org.springframework.web.socket.config - package org.springframework.web.socket.config

Configuration support for WebSocket request handling.

org.springframework.web.socket.config.annotation - package org.springframework.web.socket.config.annotation

Support for annotation-based WebSocket setup in configuration classes.

org.springframework.web.socket.handler - package org.springframework.web.socket.handler

Convenient WebSocketHandler implementations and decorators.

org.springframework.web.socket.messaging - package org.springframework.web.socket.messaging

WebSocket integration for Spring's messaging module.

org.springframework.web.socket.server - package org.springframework.web.socket.server

Server-side abstractions for WebSocket interactions.

org.springframework.web.socket.server.jetty - package org.springframework.web.socket.server.jetty

Server-side support for the Jetty 9+ WebSocket API.

org.springframework.web.socket.server.standard - package org.springframework.web.socket.server.standard

Server-side classes for use with standard JSR-356 WebSocket endpoints.

org.springframework.web.socket.server.support - package org.springframework.web.socket.server.support

Server-side support classes including container-specific strategies for upgrading a request.

org.springframework.web.socket.sockjs - package org.springframework.web.socket.sockjs

Top-level SockJS types.

org.springframework.web.socket.sockjs.client - package org.springframework.web.socket.sockjs.client

SockJS client implementation of WebSocketClient.

org.springframework.web.socket.sockjs.frame - package org.springframework.web.socket.sockjs.frame

Support classes for creating SockJS frames including the encoding and decoding of SockJS message frames.

org.springframework.web.socket.sockjs.support - package org.springframework.web.socket.sockjs.support

Support classes for SockJS including an AbstractSockJsService implementation.

org.springframework.web.socket.sockjs.transport - package org.springframework.web.socket.sockjs.transport

Server-side support for SockJS transports including TransportHandler implementations for processing incoming requests, their session counterparts for sending messages over the various transports, and DefaultSockJsService.

org.springframework.web.socket.sockjs.transport.handler - package org.springframework.web.socket.sockjs.transport.handler

TransportHandler implementation classes as well as a concrete SockJsService.

org.springframework.web.socket.sockjs.transport.session - package org.springframework.web.socket.sockjs.transport.session

SockJS specific implementations of WebSocketSession.

OriginHandshakeInterceptor - Class in org.springframework.web.socket.server.support

An interceptor to check request Origin header value against a collection of allowed origins.

OriginHandshakeInterceptor() - Constructor for class org.springframework.web.socket.server.support.OriginHandshakeInterceptor

Default constructor with only same origin requests allowed.

OriginHandshakeInterceptor(Collection<String>) - Constructor for class org.springframework.web.socket.server.support.OriginHandshakeInterceptor

Constructor using the specified allowed origin values.

P

parseExtensions(String) - Static method in class org.springframework.web.socket.WebSocketExtension

Parse the given, comma-separated string into a list of WebSocketExtension objects.

PerConnectionWebSocketHandler - Class in org.springframework.web.socket.handler

A WebSocketHandler that initializes and destroys a WebSocketHandler instance for each WebSocket connection and delegates all other methods to it.

PerConnectionWebSocketHandler(Class<? extends WebSocketHandler>) - Constructor for class org.springframework.web.socket.handler.PerConnectionWebSocketHandler

PerConnectionWebSocketHandler(Class<? extends WebSocketHandler>, boolean) - Constructor for class org.springframework.web.socket.handler.PerConnectionWebSocketHandler

PingMessage - Class in org.springframework.web.socket

A WebSocket ping message.

PingMessage() - Constructor for class org.springframework.web.socket.PingMessage

Create a new ping message with an empty payload.

PingMessage(ByteBuffer) - Constructor for class org.springframework.web.socket.PingMessage

Create a new ping message with the given ByteBuffer payload.

POLICY_VIOLATION - Static variable in class org.springframework.web.socket.CloseStatus

"1008 indicates that an endpoint is terminating the connection because it has received a message that violates its policy.

PollingSockJsSession - Class in org.springframework.web.socket.sockjs.transport.session

A SockJS session for use with polling HTTP transports.

PollingSockJsSession(String, SockJsServiceConfig, WebSocketHandler, Map<String, Object>) - Constructor for class org.springframework.web.socket.sockjs.transport.session.PollingSockJsSession

PongMessage - Class in org.springframework.web.socket

A WebSocket pong message.

PongMessage() - Constructor for class org.springframework.web.socket.PongMessage

Create a new pong message with an empty payload.

PongMessage(ByteBuffer) - Constructor for class org.springframework.web.socket.PongMessage

Create a new pong message with the given ByteBuffer payload.

PRELUDE - Static variable in class org.springframework.web.socket.sockjs.client.AbstractXhrTransport

preProcessContent(String) - Method in class org.springframework.web.socket.sockjs.frame.DefaultSockJsFrameFormat

processConnectHeaders(StompHeaders) - Method in class org.springframework.web.socket.messaging.WebSocketStompClient

PROTOCOL_ERROR - Static variable in class org.springframework.web.socket.CloseStatus

"1002 indicates that an endpoint is terminating the connection due to a protocol error."

put(String, List<String>) - Method in class org.springframework.web.socket.WebSocketHttpHeaders

putAll(Map<? extends String, ? extends List<String>>) - Method in class org.springframework.web.socket.WebSocketHttpHeaders

putIfAbsent(String, List<String>) - Method in class org.springframework.web.socket.WebSocketHttpHeaders

R

readMessages(ServerHttpRequest) - Method in class org.springframework.web.socket.sockjs.transport.handler.AbstractHttpReceivingTransportHandler

readMessages(ServerHttpRequest) - Method in class org.springframework.web.socket.sockjs.transport.handler.XhrReceivingTransportHandler

registerEndpoints() - Method in class org.springframework.web.socket.server.standard.ServerEndpointExporter

Actually register the endpoints.

registerStompEndpoints(StompEndpointRegistry) - Method in class org.springframework.web.socket.config.annotation.DelegatingWebSocketMessageBrokerConfiguration

registerStompEndpoints(StompEndpointRegistry) - Method in class org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurationSupport

registerStompEndpoints(StompEndpointRegistry) - Method in interface org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurer

Register STOMP endpoints mapping each to a specific URL and (optionally) enabling and configuring SockJS fallback options.

registerWebSocketHandlers(WebSocketHandlerRegistry) - Method in class org.springframework.web.socket.config.annotation.DelegatingWebSocketConfiguration

registerWebSocketHandlers(WebSocketHandlerRegistry) - Method in class org.springframework.web.socket.config.annotation.WebSocketConfigurationSupport

registerWebSocketHandlers(WebSocketHandlerRegistry) - Method in interface org.springframework.web.socket.config.annotation.WebSocketConfigurer

Register WebSocketHandlers including SockJS fallback options if desired.

remove(Object) - Method in class org.springframework.web.socket.WebSocketHttpHeaders

RequestUpgradeStrategy - Interface in org.springframework.web.socket.server

A server-specific strategy for performing the actual upgrade to a WebSocket exchange.

REQUIRED_EXTENSION - Static variable in class org.springframework.web.socket.CloseStatus

"1010 indicates that an endpoint (client) is terminating the connection because it has expected the server to negotiate one or more extension, but the server didn't return them in the response message of the WebSocket handshake.

requiresTaskScheduler() - Method in class org.springframework.web.socket.config.annotation.ServletWebSocketHandlerRegistry

Whether there are any endpoint SockJS registrations without a TaskScheduler.

resetRequest() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractHttpSockJsSession

resolveSessionId(Message<?>) - Method in class org.springframework.web.socket.messaging.StompSubProtocolHandler

resolveSessionId(Message<?>) - Method in interface org.springframework.web.socket.messaging.SubProtocolHandler

Resolve the session id from the given message or return null.

responseLock - Variable in class org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession

RestTemplateXhrTransport - Class in org.springframework.web.socket.sockjs.client

An XhrTransport implementation that uses a RestTemplate.

RestTemplateXhrTransport() - Constructor for class org.springframework.web.socket.sockjs.client.RestTemplateXhrTransport

RestTemplateXhrTransport(RestOperations) - Constructor for class org.springframework.web.socket.sockjs.client.RestTemplateXhrTransport

S

scheduleHeartbeat() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession

SEC_WEBSOCKET_ACCEPT - Static variable in class org.springframework.web.socket.WebSocketHttpHeaders

SEC_WEBSOCKET_EXTENSIONS - Static variable in class org.springframework.web.socket.WebSocketHttpHeaders

SEC_WEBSOCKET_KEY - Static variable in class org.springframework.web.socket.WebSocketHttpHeaders

SEC_WEBSOCKET_PROTOCOL - Static variable in class org.springframework.web.socket.WebSocketHttpHeaders

SEC_WEBSOCKET_VERSION - Static variable in class org.springframework.web.socket.WebSocketHttpHeaders

selectProtocol(List<String>, WebSocketHandler) - Method in class org.springframework.web.socket.server.support.AbstractHandshakeHandler

Perform the sub-protocol negotiation based on requested and supported sub-protocols.

sendBinaryMessage(BinaryMessage) - Method in class org.springframework.web.socket.adapter.AbstractWebSocketSession

sendBinaryMessage(BinaryMessage) - Method in class org.springframework.web.socket.adapter.jetty.JettyWebSocketSession

sendBinaryMessage(BinaryMessage) - Method in class org.springframework.web.socket.adapter.standard.StandardWebSocketSession

sendHeartbeat() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession

sendInternal(TextMessage) - Method in class org.springframework.web.socket.sockjs.client.AbstractClientSockJsSession

sendInternal(TextMessage) - Method in class org.springframework.web.socket.sockjs.client.WebSocketClientSockJsSession

sendInternal(TextMessage) - Method in class org.springframework.web.socket.sockjs.client.XhrClientSockJsSession

sendMessage(WebSocketMessage<?>) - Method in class org.springframework.web.socket.adapter.AbstractWebSocketSession

sendMessage(WebSocketMessage<?>) - Method in class org.springframework.web.socket.handler.ConcurrentWebSocketSessionDecorator

sendMessage(WebSocketMessage<?>) - Method in class org.springframework.web.socket.handler.WebSocketSessionDecorator

sendMessage(WebSocketMessage<?>) - Method in class org.springframework.web.socket.sockjs.client.AbstractClientSockJsSession

sendMessage(WebSocketMessage<?>) - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession

sendMessage(WebSocketMessage<?>) - Method in interface org.springframework.web.socket.WebSocketSession

Send a WebSocket message: either TextMessage or BinaryMessage.

sendMessageInternal(String) - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractHttpSockJsSession

sendMessageInternal(String) - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession

sendMessageInternal(String) - Method in class org.springframework.web.socket.sockjs.transport.session.WebSocketServerSockJsSession

sendMethodNotAllowed(ServerHttpResponse, HttpMethod...) - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService

sendPingMessage(PingMessage) - Method in class org.springframework.web.socket.adapter.AbstractWebSocketSession

sendPingMessage(PingMessage) - Method in class org.springframework.web.socket.adapter.jetty.JettyWebSocketSession

sendPingMessage(PingMessage) - Method in class org.springframework.web.socket.adapter.standard.StandardWebSocketSession

sendPongMessage(PongMessage) - Method in class org.springframework.web.socket.adapter.AbstractWebSocketSession

sendPongMessage(PongMessage) - Method in class org.springframework.web.socket.adapter.jetty.JettyWebSocketSession

sendPongMessage(PongMessage) - Method in class org.springframework.web.socket.adapter.standard.StandardWebSocketSession

sendsNoCacheInstruction() - Method in enum class org.springframework.web.socket.sockjs.transport.TransportType

sendsSessionCookie() - Method in enum class org.springframework.web.socket.sockjs.transport.TransportType

sendTextMessage(TextMessage) - Method in class org.springframework.web.socket.adapter.AbstractWebSocketSession

sendTextMessage(TextMessage) - Method in class org.springframework.web.socket.adapter.jetty.JettyWebSocketSession

sendTextMessage(TextMessage) - Method in class org.springframework.web.socket.adapter.standard.StandardWebSocketSession

SERVER_ERROR - Static variable in class org.springframework.web.socket.CloseStatus

"1011 indicates that a server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request."

ServerEndpointExporter - Class in org.springframework.web.socket.server.standard

Detects beans of type ServerEndpointConfig and registers with the standard Jakarta WebSocket runtime.

ServerEndpointExporter() - Constructor for class org.springframework.web.socket.server.standard.ServerEndpointExporter

ServerEndpointRegistration - Class in org.springframework.web.socket.server.standard

An implementation of ServerEndpointConfig for use in Spring-based applications.

ServerEndpointRegistration(String, Endpoint) - Constructor for class org.springframework.web.socket.server.standard.ServerEndpointRegistration

Create a new ServerEndpointRegistration instance from an jakarta.websocket.Endpoint instance.

ServerEndpointRegistration(String, Class<? extends Endpoint>) - Constructor for class org.springframework.web.socket.server.standard.ServerEndpointRegistration

Create a new ServerEndpointRegistration instance from an jakarta.websocket.Endpoint class.

SERVICE_OVERLOAD - Static variable in class org.springframework.web.socket.CloseStatus

"1013 indicates that the service is experiencing overload.

SERVICE_RESTARTED - Static variable in class org.springframework.web.socket.CloseStatus

"1012 indicates that the service is restarted.

ServletServerContainerFactoryBean - Class in org.springframework.web.socket.server.standard

A FactoryBean for configuring ServerContainer.

ServletServerContainerFactoryBean() - Constructor for class org.springframework.web.socket.server.standard.ServletServerContainerFactoryBean

ServletWebSocketHandlerRegistration - Class in org.springframework.web.socket.config.annotation

A helper class for configuring WebSocketHandler request handling including SockJS fallback options.

ServletWebSocketHandlerRegistration() - Constructor for class org.springframework.web.socket.config.annotation.ServletWebSocketHandlerRegistration

ServletWebSocketHandlerRegistry - Class in org.springframework.web.socket.config.annotation

WebSocketHandlerRegistry with Spring MVC handler mappings for the handshake requests.

ServletWebSocketHandlerRegistry() - Constructor for class org.springframework.web.socket.config.annotation.ServletWebSocketHandlerRegistry

SESSION_NOT_RELIABLE - Static variable in class org.springframework.web.socket.CloseStatus

A status code for use within the framework that indicates a session has become unreliable (e.g.

SessionConnectedEvent - Class in org.springframework.web.socket.messaging

A connected event represents the server response to a client's connect request.

SessionConnectedEvent(Object, Message<byte[]>) - Constructor for class org.springframework.web.socket.messaging.SessionConnectedEvent

Create a new SessionConnectedEvent.

SessionConnectedEvent(Object, Message<byte[]>, Principal) - Constructor for class org.springframework.web.socket.messaging.SessionConnectedEvent

SessionConnectEvent - Class in org.springframework.web.socket.messaging

Event raised when a new WebSocket client using a Simple Messaging Protocol (e.g.

SessionConnectEvent(Object, Message<byte[]>) - Constructor for class org.springframework.web.socket.messaging.SessionConnectEvent

Create a new SessionConnectEvent.

SessionConnectEvent(Object, Message<byte[]>, Principal) - Constructor for class org.springframework.web.socket.messaging.SessionConnectEvent

SessionDisconnectEvent - Class in org.springframework.web.socket.messaging

Event raised when the session of a WebSocket client using a Simple Messaging Protocol (e.g.

SessionDisconnectEvent(Object, Message<byte[]>, String, CloseStatus) - Constructor for class org.springframework.web.socket.messaging.SessionDisconnectEvent

Create a new SessionDisconnectEvent.

SessionDisconnectEvent(Object, Message<byte[]>, String, CloseStatus, Principal) - Constructor for class org.springframework.web.socket.messaging.SessionDisconnectEvent

Create a new SessionDisconnectEvent.

SessionLimitExceededException - Exception in org.springframework.web.socket.handler

Raised when a WebSocket session has exceeded limits it has been configured for, e.g.

SessionLimitExceededException(String, CloseStatus) - Constructor for exception org.springframework.web.socket.handler.SessionLimitExceededException

SessionSubscribeEvent - Class in org.springframework.web.socket.messaging

Event raised when a new WebSocket client using a Simple Messaging Protocol (e.g.

SessionSubscribeEvent(Object, Message<byte[]>) - Constructor for class org.springframework.web.socket.messaging.SessionSubscribeEvent

SessionSubscribeEvent(Object, Message<byte[]>, Principal) - Constructor for class org.springframework.web.socket.messaging.SessionSubscribeEvent

SessionUnsubscribeEvent - Class in org.springframework.web.socket.messaging

Event raised when a new WebSocket client using a Simple Messaging Protocol (e.g.

SessionUnsubscribeEvent(Object, Message<byte[]>) - Constructor for class org.springframework.web.socket.messaging.SessionUnsubscribeEvent

SessionUnsubscribeEvent(Object, Message<byte[]>, Principal) - Constructor for class org.springframework.web.socket.messaging.SessionUnsubscribeEvent

set(String, String) - Method in class org.springframework.web.socket.WebSocketHttpHeaders

Set the given, single header value under the given name.

setAcceptedProtocol(String) - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractHttpSockJsSession

Unlike WebSocket where sub-protocol negotiation is part of the initial handshake, in HTTP transports the same negotiation must be emulated and the selected protocol set through this setter.

setAll(Map<String, String>) - Method in class org.springframework.web.socket.WebSocketHttpHeaders

setAllowedOriginPatterns(String...) - Method in class org.springframework.web.socket.config.annotation.AbstractWebSocketHandlerRegistration

setAllowedOriginPatterns(String...) - Method in class org.springframework.web.socket.config.annotation.SockJsServiceRegistration

Configure allowed Origin pattern header values.

setAllowedOriginPatterns(String...) - Method in interface org.springframework.web.socket.config.annotation.StompWebSocketEndpointRegistration

Alternative to StompWebSocketEndpointRegistration.setAllowedOrigins(String...) that supports more flexible patterns for specifying the origins for which cross-origin requests are allowed from a browser.

setAllowedOriginPatterns(String...) - Method in class org.springframework.web.socket.config.annotation.WebMvcStompWebSocketEndpointRegistration

setAllowedOriginPatterns(String...) - Method in interface org.springframework.web.socket.config.annotation.WebSocketHandlerRegistration

Alternative to WebSocketHandlerRegistration.setAllowedOrigins(String...) that supports more flexible patterns for specifying the origins for which cross-origin requests are allowed from a browser.

setAllowedOriginPatterns(Collection<String>) - Method in class org.springframework.web.socket.server.support.OriginHandshakeInterceptor

Alternative to OriginHandshakeInterceptor.setAllowedOrigins(Collection) that supports more flexible patterns for specifying the origins for which cross-origin requests are allowed from a browser.

setAllowedOriginPatterns(Collection<String>) - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService

Alternative to AbstractSockJsService.setAllowedOrigins(Collection) that supports more flexible patterns for specifying the origins for which cross-origin requests are allowed from a browser.

setAllowedOrigins(String...) - Method in class org.springframework.web.socket.config.annotation.AbstractWebSocketHandlerRegistration

setAllowedOrigins(String...) - Method in class org.springframework.web.socket.config.annotation.SockJsServiceRegistration

Configure allowed Origin header values.

setAllowedOrigins(String...) - Method in interface org.springframework.web.socket.config.annotation.StompWebSocketEndpointRegistration

Set the origins for which cross-origin requests are allowed from a browser.

setAllowedOrigins(String...) - Method in class org.springframework.web.socket.config.annotation.WebMvcStompWebSocketEndpointRegistration

setAllowedOrigins(String...) - Method in interface org.springframework.web.socket.config.annotation.WebSocketHandlerRegistration

Set the origins for which cross-origin requests are allowed from a browser.

setAllowedOrigins(Collection<String>) - Method in class org.springframework.web.socket.server.support.OriginHandshakeInterceptor

Set the origins for which cross-origin requests are allowed from a browser.

setAllowedOrigins(Collection<String>) - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService

Set the origins for which cross-origin requests are allowed from a browser.

setAnnotatedEndpointClasses(Class<?>...) - Method in class org.springframework.web.socket.server.standard.ServerEndpointExporter

Explicitly list annotated endpoint types that should be registered on startup.

setApplicationContext(ApplicationContext) - Method in class org.springframework.web.socket.config.annotation.WebMvcStompEndpointRegistry

setApplicationEventPublisher(ApplicationEventPublisher) - Method in class org.springframework.web.socket.messaging.StompSubProtocolHandler

setAsyncSendTimeout(long) - Method in class org.springframework.web.socket.client.standard.WebSocketContainerFactoryBean

setAsyncSendTimeout(Long) - Method in class org.springframework.web.socket.server.standard.ServletServerContainerFactoryBean

setAutoStartup(boolean) - Method in class org.springframework.web.socket.client.ConnectionManagerSupport

Set whether to auto-connect to the remote endpoint after this connection manager has been initialized and the Spring context has been refreshed.

setAutoStartup(boolean) - Method in class org.springframework.web.socket.messaging.WebSocketStompClient

Set whether to auto-start the contained WebSocketClient when the Spring context has been refreshed.

setBeanFactory(BeanFactory) - Method in class org.springframework.web.socket.client.standard.AnnotatedEndpointConnectionManager

setBeanFactory(BeanFactory) - Method in class org.springframework.web.socket.client.standard.EndpointConnectionManager

setBeanFactory(BeanFactory) - Method in class org.springframework.web.socket.handler.BeanCreatingHandlerProvider

setBeanFactory(BeanFactory) - Method in class org.springframework.web.socket.handler.PerConnectionWebSocketHandler

setBeanFactory(BeanFactory) - Method in class org.springframework.web.socket.server.standard.ServerEndpointRegistration

setBinaryMessageSizeLimit(int) - Method in class org.springframework.web.socket.adapter.jetty.JettyWebSocketSession

This method is a no-op for Jetty.

setBinaryMessageSizeLimit(int) - Method in class org.springframework.web.socket.adapter.standard.StandardWebSocketSession

setBinaryMessageSizeLimit(int) - Method in class org.springframework.web.socket.handler.WebSocketSessionDecorator

setBinaryMessageSizeLimit(int) - Method in class org.springframework.web.socket.sockjs.client.WebSocketClientSockJsSession

setBinaryMessageSizeLimit(int) - Method in class org.springframework.web.socket.sockjs.client.XhrClientSockJsSession

setBinaryMessageSizeLimit(int) - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractHttpSockJsSession

setBinaryMessageSizeLimit(int) - Method in class org.springframework.web.socket.sockjs.transport.session.WebSocketServerSockJsSession

setBinaryMessageSizeLimit(int) - Method in interface org.springframework.web.socket.WebSocketSession

Configure the maximum size for an incoming binary message.

setClientLibraryUrl(String) - Method in class org.springframework.web.socket.config.annotation.SockJsServiceRegistration

Transports with no native cross-domain communication (e.g.

setConfigurator(ClientEndpointConfig.Configurator) - Method in class org.springframework.web.socket.client.standard.EndpointConnectionManager

setConfigurers(List<WebSocketConfigurer>) - Method in class org.springframework.web.socket.config.annotation.DelegatingWebSocketConfiguration

setConfigurers(List<WebSocketMessageBrokerConfigurer>) - Method in class org.springframework.web.socket.config.annotation.DelegatingWebSocketMessageBrokerConfiguration

setConnectTimeoutScheduler(TaskScheduler) - Method in class org.springframework.web.socket.sockjs.client.SockJsClient

Configure a TaskScheduler for scheduling a connect timeout task where the timeout value is calculated based on the duration of the initial SockJS "Info" request.

setCopyAllAttributes(boolean) - Method in class org.springframework.web.socket.server.support.HttpSessionHandshakeInterceptor

Whether to copy all attributes from the HTTP session.

setCopyHttpSessionId(boolean) - Method in class org.springframework.web.socket.server.support.HttpSessionHandshakeInterceptor

Whether the HTTP session id should be copied to the handshake attributes under the key HttpSessionHandshakeInterceptor.HTTP_SESSION_ID_ATTR_NAME.

setCreateSession(boolean) - Method in class org.springframework.web.socket.server.support.HttpSessionHandshakeInterceptor

Whether to allow the HTTP session to be created while accessing it.

setDecoder(StompDecoder) - Method in class org.springframework.web.socket.messaging.StompSubProtocolHandler

Configure a StompDecoder for decoding STOMP frames.

setDecoders(List<Class<? extends Decoder>>) - Method in class org.springframework.web.socket.client.standard.EndpointConnectionManager

setDecoders(List<Class<? extends Decoder>>) - Method in class org.springframework.web.socket.server.standard.ServerEndpointRegistration

setDecoratorFactories(WebSocketHandlerDecoratorFactory...) - Method in class org.springframework.web.socket.config.annotation.WebSocketTransportRegistration

Configure one or more factories to decorate the handler used to process WebSocket messages.

setDefaultProtocolHandler(SubProtocolHandler) - Method in class org.springframework.web.socket.messaging.SubProtocolWebSocketHandler

Set the SubProtocolHandler to use when the client did not request a sub-protocol.

setDisconnectDelay(long) - Method in class org.springframework.web.socket.config.annotation.SockJsServiceRegistration

The amount of time in milliseconds before a client is considered disconnected after not having a receiving connection, i.e.

setDisconnectDelay(long) - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService

The amount of time in milliseconds before a client is considered disconnected after not having a receiving connection, i.e.

setEncoder(StompEncoder) - Method in class org.springframework.web.socket.messaging.StompSubProtocolHandler

Configure a StompEncoder for encoding STOMP frames.

setEncoders(List<Class<? extends Encoder>>) - Method in class org.springframework.web.socket.client.standard.EndpointConnectionManager

setEncoders(List<Class<? extends Encoder>>) - Method in class org.springframework.web.socket.server.standard.ServerEndpointRegistration

setErrorHandler(StompSubProtocolErrorHandler) - Method in interface org.springframework.web.socket.config.annotation.StompEndpointRegistry

Configure a handler for customizing or handling STOMP ERROR frames to clients.

setErrorHandler(StompSubProtocolErrorHandler) - Method in class org.springframework.web.socket.config.annotation.WebMvcStompEndpointRegistry

setErrorHandler(StompSubProtocolErrorHandler) - Method in class org.springframework.web.socket.messaging.StompSubProtocolHandler

Configure a handler for error messages sent to clients which allows customizing the error messages or preventing them from being sent.

setExtensions(Extension...) - Method in class org.springframework.web.socket.client.standard.EndpointConnectionManager

setExtensions(List<Extension>) - Method in class org.springframework.web.socket.server.standard.ServerEndpointRegistration

setHandshakeHandler(HandshakeHandler) - Method in class org.springframework.web.socket.config.annotation.AbstractWebSocketHandlerRegistration

setHandshakeHandler(HandshakeHandler) - Method in interface org.springframework.web.socket.config.annotation.StompWebSocketEndpointRegistration

Configure the HandshakeHandler to use.

setHandshakeHandler(HandshakeHandler) - Method in class org.springframework.web.socket.config.annotation.WebMvcStompWebSocketEndpointRegistration

setHandshakeHandler(HandshakeHandler) - Method in interface org.springframework.web.socket.config.annotation.WebSocketHandlerRegistration

Configure the HandshakeHandler to use.

setHandshakeInterceptors(List<HandshakeInterceptor>) - Method in class org.springframework.web.socket.server.support.WebSocketHttpRequestHandler

Configure one or more WebSocket handshake request interceptors.

setHandshakeInterceptors(List<HandshakeInterceptor>) - Method in class org.springframework.web.socket.sockjs.transport.TransportHandlingSockJsService

Configure one or more WebSocket handshake request interceptors.

setHeaderInitializer(MessageHeaderInitializer) - Method in class org.springframework.web.socket.messaging.StompSubProtocolHandler

Configure a MessageHeaderInitializer to apply to the headers of all messages created from decoded STOMP frames and other messages sent to the client inbound channel.

setHeaders(HttpHeaders) - Method in class org.springframework.web.socket.client.WebSocketConnectionManager

Provide default headers to add to the WebSocket handshake request.

setHeartbeatTime(long) - Method in class org.springframework.web.socket.config.annotation.SockJsServiceRegistration

The amount of time in milliseconds when the server has not sent any messages and after which the server should send a heartbeat frame to the client in order to keep the connection from breaking.

setHeartbeatTime(long) - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService

Specify the amount of time in milliseconds when the server has not sent any messages and after which the server should send a heartbeat frame to the client in order to keep the connection from breaking.

setHttpHeaderNames(String...) - Method in class org.springframework.web.socket.sockjs.client.SockJsClient

The names of HTTP headers that should be copied from the handshake headers of each call to WebSocketClient.doHandshake(WebSocketHandler, WebSocketHttpHeaders, URI) and also used with other HTTP requests issued as part of that SockJS connection, e.g.

setHttpMessageCacheSize(int) - Method in class org.springframework.web.socket.config.annotation.SockJsServiceRegistration

The number of server-to-client messages that a session can cache while waiting for the next HTTP polling request from the client.

setHttpMessageCacheSize(int) - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService

The number of server-to-client messages that a session can cache while waiting for the next HTTP polling request from the client.

setInboundChannelExecutor(TaskExecutor) - Method in class org.springframework.web.socket.config.WebSocketMessageBrokerStats

setInboundMessageSizeLimit(int) - Method in class org.springframework.web.socket.messaging.WebSocketStompClient

Configure the maximum size allowed for inbound STOMP message.

setInfoReceiver(InfoReceiver) - Method in class org.springframework.web.socket.sockjs.client.SockJsClient

Configure the InfoReceiver to use to perform the SockJS "Info" request before the SockJS session starts.

setInterceptors(HandshakeInterceptor...) - Method in class org.springframework.web.socket.config.annotation.SockJsServiceRegistration

setLoggingPeriod(long) - Method in class org.springframework.web.socket.config.WebSocketMessageBrokerStats

Set the frequency for logging information at INFO level in milliseconds.

setMaxBinaryMessageBufferSize(int) - Method in class org.springframework.web.socket.client.standard.WebSocketContainerFactoryBean

setMaxBinaryMessageBufferSize(Integer) - Method in class org.springframework.web.socket.server.standard.ServletServerContainerFactoryBean

setMaxSessionIdleTimeout(long) - Method in class org.springframework.web.socket.client.standard.WebSocketContainerFactoryBean

setMaxSessionIdleTimeout(Long) - Method in class org.springframework.web.socket.server.standard.ServletServerContainerFactoryBean

setMaxTextMessageBufferSize(int) - Method in class org.springframework.web.socket.client.standard.WebSocketContainerFactoryBean

setMaxTextMessageBufferSize(Integer) - Method in class org.springframework.web.socket.server.standard.ServletServerContainerFactoryBean

setMessageCallback(Consumer<WebSocketMessage<?>>) - Method in class org.springframework.web.socket.handler.ConcurrentWebSocketSessionDecorator

Set a callback invoked after a message is added to the send buffer.

setMessageCodec(SockJsMessageCodec) - Method in class org.springframework.web.socket.config.annotation.SockJsServiceRegistration

The codec to use for encoding and decoding SockJS messages.

setMessageCodec(SockJsMessageCodec) - Method in class org.springframework.web.socket.sockjs.client.SockJsClient

Set the SockJsMessageCodec to use.

setMessageCodec(SockJsMessageCodec) - Method in class org.springframework.web.socket.sockjs.transport.TransportHandlingSockJsService

The codec to use for encoding and decoding SockJS messages.

setMessageSizeLimit(int) - Method in class org.springframework.web.socket.config.annotation.WebSocketTransportRegistration

Configure the maximum size of an inbound sub-protocol message, such as a STOMP frame which may be aggregated from multiple WebSocket messages.

setMessageSizeLimit(int) - Method in class org.springframework.web.socket.messaging.StompSubProtocolHandler

Configure the maximum size allowed for an incoming STOMP message.

setName(String) - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService

Set a unique name for this service (mainly for logging purposes).

setOrder(int) - Method in class org.springframework.web.socket.config.annotation.ServletWebSocketHandlerRegistry

Set the order for the resulting SimpleUrlHandlerMapping relative to other handler mappings configured in Spring MVC.

setOrder(int) - Method in interface org.springframework.web.socket.config.annotation.StompEndpointRegistry

Set the order of the HandlerMapping used for STOMP endpoints relative to other Spring MVC handler mappings.

setOrder(int) - Method in class org.springframework.web.socket.config.annotation.WebMvcStompEndpointRegistry

Set the order for the resulting HandlerMapping relative to other handler mappings configured in Spring MVC.

setOrder(int) - Method in class org.springframework.web.socket.messaging.DefaultSimpUserRegistry

Specify the order value for this registry.

setOrigin(String) - Method in class org.springframework.web.socket.client.WebSocketConnectionManager

Set the origin to use.

setOutboundChannelExecutor(TaskExecutor) - Method in class org.springframework.web.socket.config.WebSocketMessageBrokerStats

setPhase(int) - Method in class org.springframework.web.socket.client.ConnectionManagerSupport

Specify the phase in which a connection should be established to the remote endpoint and subsequently closed.

setPhase(int) - Method in class org.springframework.web.socket.messaging.WebSocketStompClient

Specify the phase in which the WebSocket client should be started and subsequently closed.

setProtocolHandlers(List<SubProtocolHandler>) - Method in class org.springframework.web.socket.messaging.SubProtocolWebSocketHandler

Configure one or more handlers to use depending on the sub-protocol requested by the client in the WebSocket handshake request.

setSecWebSocketAccept(String) - Method in class org.springframework.web.socket.WebSocketHttpHeaders

Sets the (new) value of the Sec-WebSocket-Accept header.

setSecWebSocketExtensions(List<WebSocketExtension>) - Method in class org.springframework.web.socket.WebSocketHttpHeaders

Sets the (new) value(s) of the Sec-WebSocket-Extensions header.

setSecWebSocketKey(String) - Method in class org.springframework.web.socket.WebSocketHttpHeaders

Sets the (new) value of the Sec-WebSocket-Key header.

setSecWebSocketProtocol(String) - Method in class org.springframework.web.socket.WebSocketHttpHeaders

Sets the (new) value of the Sec-WebSocket-Protocol header.

setSecWebSocketProtocol(List<String>) - Method in class org.springframework.web.socket.WebSocketHttpHeaders

Sets the (new) value of the Sec-WebSocket-Protocol header.

setSecWebSocketVersion(String) - Method in class org.springframework.web.socket.WebSocketHttpHeaders

Sets the (new) value of the Sec-WebSocket-Version header.

setSendBufferSizeLimit(int) - Method in class org.springframework.web.socket.config.annotation.WebSocketTransportRegistration

Configure the maximum amount of data to buffer when sending messages to a WebSocket session, or an HTTP response when SockJS fallback option are in use.

setSendBufferSizeLimit(int) - Method in class org.springframework.web.socket.messaging.SubProtocolWebSocketHandler

Specify the buffer-size limit (number of bytes).

setSendTimeLimit(int) - Method in class org.springframework.web.socket.config.annotation.WebSocketTransportRegistration

Configure a time limit (in milliseconds) for the maximum amount of a time allowed when sending messages to a WebSocket session or writing to an HTTP response when SockJS fallback option are in use.

setSendTimeLimit(int) - Method in class org.springframework.web.socket.messaging.SubProtocolWebSocketHandler

Specify the send-time limit (milliseconds).

setServerContainer(ServerContainer) - Method in class org.springframework.web.socket.server.standard.ServerEndpointExporter

Set the JSR-356 ServerContainer to use for endpoint registration.

setServletContext(ServletContext) - Method in class org.springframework.web.socket.server.standard.ServletServerContainerFactoryBean

setServletContext(ServletContext) - Method in class org.springframework.web.socket.server.support.DefaultHandshakeHandler

setServletContext(ServletContext) - Method in class org.springframework.web.socket.server.support.WebSocketHttpRequestHandler

setServletContext(ServletContext) - Method in class org.springframework.web.socket.sockjs.support.SockJsHttpRequestHandler

setServletContext(ServletContext) - Method in class org.springframework.web.socket.sockjs.transport.handler.DefaultSockJsService

setServletContext(ServletContext) - Method in class org.springframework.web.socket.sockjs.transport.handler.WebSocketTransportHandler

setSessionCookieNeeded(boolean) - Method in class org.springframework.web.socket.config.annotation.SockJsServiceRegistration

The SockJS protocol requires a server to respond to the initial "/info" request from clients with a "cookie_needed" boolean property that indicates whether the use of a JSESSIONID cookie is required for the application to function correctly, e.g.

setSessionCookieNeeded(boolean) - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService

The SockJS protocol requires a server to respond to an initial "/info" request from clients with a "cookie_needed" boolean property that indicates whether the use of a JSESSIONID cookie is required for the application to function correctly, e.g.

setSockJsClientLibraryUrl(String) - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService

Transports with no native cross-domain communication (e.g.

setSockJsTaskScheduler(TaskScheduler) - Method in class org.springframework.web.socket.config.WebSocketMessageBrokerStats

setStompBrokerRelay(StompBrokerRelayMessageHandler) - Method in class org.springframework.web.socket.config.WebSocketMessageBrokerStats

setStreamBytesLimit(int) - Method in class org.springframework.web.socket.config.annotation.SockJsServiceRegistration

Streaming transports save responses on the client side and don't free memory used by delivered messages.

setStreamBytesLimit(int) - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService

Streaming transports save responses on the client side and don't free memory used by delivered messages.

setSubprotocols(List<String>) - Method in class org.springframework.web.socket.server.standard.ServerEndpointRegistration

setSubProtocols(List<String>) - Method in class org.springframework.web.socket.client.WebSocketConnectionManager

Set the sub-protocols to use.

setSubProtocolWebSocketHandler(SubProtocolWebSocketHandler) - Method in class org.springframework.web.socket.config.WebSocketMessageBrokerStats

setSupportedProtocols(String...) - Method in class org.springframework.web.socket.client.standard.EndpointConnectionManager

setSupportedProtocols(String...) - Method in class org.springframework.web.socket.server.support.AbstractHandshakeHandler

Use this property to configure the list of supported sub-protocols.

setSuppressCors(boolean) - Method in class org.springframework.web.socket.config.annotation.SockJsServiceRegistration

This option can be used to disable automatic addition of CORS headers for SockJS requests.

setSuppressCors(boolean) - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService

This option can be used to disable automatic addition of CORS headers for SockJS requests.

setTaskExecutor(AsyncTaskExecutor) - Method in class org.springframework.web.socket.client.jetty.JettyWebSocketClient

Deprecated.

Set an AsyncTaskExecutor to use when opening connections.

setTaskExecutor(AsyncTaskExecutor) - Method in class org.springframework.web.socket.client.standard.StandardWebSocketClient

Set an AsyncTaskExecutor to use when opening connections.

setTaskExecutor(TaskExecutor) - Method in class org.springframework.web.socket.client.standard.AnnotatedEndpointConnectionManager

Set a TaskExecutor to use to open the connection.

setTaskExecutor(TaskExecutor) - Method in class org.springframework.web.socket.client.standard.EndpointConnectionManager

Set a TaskExecutor to use to open connections.

setTaskExecutor(TaskExecutor) - Method in class org.springframework.web.socket.sockjs.client.RestTemplateXhrTransport

Configure the TaskExecutor to use to execute XHR receive requests.

setTaskScheduler(TaskScheduler) - Method in class org.springframework.web.socket.config.annotation.ServletWebSocketHandlerRegistry

Provide the TaskScheduler to use for SockJS endpoints for which a task scheduler has not been explicitly registered.

setTaskScheduler(TaskScheduler) - Method in class org.springframework.web.socket.config.annotation.SockJsServiceRegistration

A scheduler instance to use for scheduling SockJS heart-beats.

setTaskScheduler(TaskScheduler) - Method in class org.springframework.web.socket.messaging.WebSocketStompClient

setTextMessageSizeLimit(int) - Method in class org.springframework.web.socket.adapter.jetty.JettyWebSocketSession

This method is a no-op for Jetty.

setTextMessageSizeLimit(int) - Method in class org.springframework.web.socket.adapter.standard.StandardWebSocketSession

setTextMessageSizeLimit(int) - Method in class org.springframework.web.socket.handler.WebSocketSessionDecorator

setTextMessageSizeLimit(int) - Method in class org.springframework.web.socket.sockjs.client.WebSocketClientSockJsSession

setTextMessageSizeLimit(int) - Method in class org.springframework.web.socket.sockjs.client.XhrClientSockJsSession

setTextMessageSizeLimit(int) - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractHttpSockJsSession

setTextMessageSizeLimit(int) - Method in class org.springframework.web.socket.sockjs.transport.session.WebSocketServerSockJsSession

setTextMessageSizeLimit(int) - Method in interface org.springframework.web.socket.WebSocketSession

Configure the maximum size for an incoming text message.

setTimeToFirstMessage(int) - Method in class org.springframework.web.socket.config.annotation.WebSocketTransportRegistration

Set the maximum time allowed in milliseconds after the WebSocket connection is established and before the first sub-protocol message is received.

setTimeToFirstMessage(int) - Method in class org.springframework.web.socket.messaging.SubProtocolWebSocketHandler

Set the maximum time allowed in milliseconds after the WebSocket connection is established and before the first sub-protocol message is received.

setTransportHandlerOverrides(TransportHandler...) - Method in class org.springframework.web.socket.config.annotation.SockJsServiceRegistration

setTransportHandlers(TransportHandler...) - Method in class org.springframework.web.socket.config.annotation.SockJsServiceRegistration

setUrlPathHelper(UrlPathHelper) - Method in class org.springframework.web.socket.config.annotation.ServletWebSocketHandlerRegistry

Set the UrlPathHelper to configure on the SimpleUrlHandlerMapping used to map handshake requests.

setUrlPathHelper(UrlPathHelper) - Method in interface org.springframework.web.socket.config.annotation.StompEndpointRegistry

Configure a customized UrlPathHelper for the STOMP endpoint HandlerMapping.

setUrlPathHelper(UrlPathHelper) - Method in class org.springframework.web.socket.config.annotation.WebMvcStompEndpointRegistry

Set the UrlPathHelper to configure on the HandlerMapping used to map handshake requests.

setUserProperties(Map<String, Object>) - Method in class org.springframework.web.socket.client.standard.StandardWebSocketClient

The standard Jakarta WebSocket API allows passing "user properties" to the server via userProperties.

setUserProperties(Map<String, Object>) - Method in class org.springframework.web.socket.server.standard.ServerEndpointRegistration

setWebSocketContainer(WebSocketContainer) - Method in class org.springframework.web.socket.client.standard.AnnotatedEndpointConnectionManager

setWebSocketContainer(WebSocketContainer) - Method in class org.springframework.web.socket.client.standard.EndpointConnectionManager

setWebSocketEnabled(boolean) - Method in class org.springframework.web.socket.config.annotation.SockJsServiceRegistration

Some load balancers don't support WebSocket.

setWebSocketEnabled(boolean) - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService

Some load balancers do not support WebSocket.

setWebSocketUpgradeMatch(boolean) - Method in class org.springframework.web.socket.server.support.WebSocketHandlerMapping

When this is set, if the matched handler is WebSocketHttpRequestHandler, ensure the request is a WebSocket handshake, i.e.

setXhrStreamingDisabled(boolean) - Method in class org.springframework.web.socket.sockjs.client.AbstractXhrTransport

An XhrTransport can support both the "xhr_streaming" and "xhr" SockJS server transports.

shouldSuppressCors() - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService

Return if automatic addition of CORS headers has been disabled.

size() - Method in class org.springframework.web.socket.WebSocketHttpHeaders

SockJsClient - Class in org.springframework.web.socket.sockjs.client

A SockJS implementation of WebSocketClient with fallback alternatives that simulate a WebSocket interaction through plain HTTP streaming and long polling techniques.

SockJsClient(List<Transport>) - Constructor for class org.springframework.web.socket.sockjs.client.SockJsClient

Create a SockJsClient with the given transports.

SockJsException - Exception in org.springframework.web.socket.sockjs

Base class for exceptions raised while processing SockJS HTTP requests.

SockJsException(String, String, Throwable) - Constructor for exception org.springframework.web.socket.sockjs.SockJsException

Constructor for SockJsException.

SockJsException(String, Throwable) - Constructor for exception org.springframework.web.socket.sockjs.SockJsException

Constructor for SockJsException.

SockJsFrame - Class in org.springframework.web.socket.sockjs.frame

Represents a SockJS frame.

SockJsFrame(String) - Constructor for class org.springframework.web.socket.sockjs.frame.SockJsFrame

Create a new instance frame with the given frame content.

SockJsFrameFormat - Interface in org.springframework.web.socket.sockjs.frame

Applies a transport-specific format to the content of a SockJS frame resulting in a content that can be written out.

SockJsFrameType - Enum Class in org.springframework.web.socket.sockjs.frame

SockJS frame types.

SockJsHttpRequestHandler - Class in org.springframework.web.socket.sockjs.support

An HttpRequestHandler that allows mapping a SockJsService to requests in a Servlet container.

SockJsHttpRequestHandler(SockJsService, WebSocketHandler) - Constructor for class org.springframework.web.socket.sockjs.support.SockJsHttpRequestHandler

Create a new SockJsHttpRequestHandler.

SockJsMessageCodec - Interface in org.springframework.web.socket.sockjs.frame

Encode and decode messages to and from a SockJS message frame, essentially an array of JSON-encoded messages.

SockJsMessageDeliveryException - Exception in org.springframework.web.socket.sockjs

An exception thrown when a message frame was successfully received over an HTTP POST and parsed but one or more of the messages it contained could not be delivered to the WebSocketHandler either because the handler failed or because the connection got closed.

SockJsMessageDeliveryException(String, List<String>, String) - Constructor for exception org.springframework.web.socket.sockjs.SockJsMessageDeliveryException

SockJsMessageDeliveryException(String, List<String>, Throwable) - Constructor for exception org.springframework.web.socket.sockjs.SockJsMessageDeliveryException

SockJsService - Interface in org.springframework.web.socket.sockjs

The main entry point for processing HTTP requests from SockJS clients.

SockJsServiceConfig - Interface in org.springframework.web.socket.sockjs.transport

Provides transport handling code with access to the SockJsService configuration options they need to have access to.

SockJsServiceRegistration - Class in org.springframework.web.socket.config.annotation

A helper class for configuring SockJS fallback options for use with an EnableWebSocket and WebSocketConfigurer setup.

SockJsServiceRegistration() - Constructor for class org.springframework.web.socket.config.annotation.SockJsServiceRegistration

SockJsSession - Interface in org.springframework.web.socket.sockjs.transport

SockJS extension of Spring's standard WebSocketSession.

SockJsSessionFactory - Interface in org.springframework.web.socket.sockjs.transport

A factory for creating a SockJS session.

SockJsTransportFailureException - Exception in org.springframework.web.socket.sockjs

Indicates a serious failure that occurred in the SockJS implementation as opposed to in user code (e.g.

SockJsTransportFailureException(String, String, Throwable) - Constructor for exception org.springframework.web.socket.sockjs.SockJsTransportFailureException

Constructor for SockJsTransportFailureException.

SockJsTransportFailureException(String, Throwable) - Constructor for exception org.springframework.web.socket.sockjs.SockJsTransportFailureException

Constructor for SockJsTransportFailureException.

SockJsUrlInfo - Class in org.springframework.web.socket.sockjs.client

Container for the base URL of a SockJS endpoint with additional helper methods to derive related SockJS URLs: specifically, the info and transport URLs.

SockJsUrlInfo(URI) - Constructor for class org.springframework.web.socket.sockjs.client.SockJsUrlInfo

SockJsWebSocketHandler - Class in org.springframework.web.socket.sockjs.transport.handler

An implementation of WebSocketHandler that adds SockJS messages frames, sends SockJS heartbeat messages, and delegates lifecycle events and messages to a target WebSocketHandler.

SockJsWebSocketHandler(SockJsServiceConfig, WebSocketHandler, WebSocketServerSockJsSession) - Constructor for class org.springframework.web.socket.sockjs.transport.handler.SockJsWebSocketHandler

SpringConfigurator - Class in org.springframework.web.socket.server.standard

A ServerEndpointConfig.Configurator for initializing ServerEndpoint-annotated classes through Spring.

SpringConfigurator() - Constructor for class org.springframework.web.socket.server.standard.SpringConfigurator

StandardToWebSocketExtensionAdapter - Class in org.springframework.web.socket.adapter.standard

A subclass of WebSocketExtension that can be constructed from a Extension.

StandardToWebSocketExtensionAdapter(Extension) - Constructor for class org.springframework.web.socket.adapter.standard.StandardToWebSocketExtensionAdapter

StandardWebSocketClient - Class in org.springframework.web.socket.client.standard

A WebSocketClient based on the standard Jakarta WebSocket API.

StandardWebSocketClient() - Constructor for class org.springframework.web.socket.client.standard.StandardWebSocketClient

Default constructor that calls ContainerProvider.getWebSocketContainer() to obtain a (new) WebSocketContainer instance.

StandardWebSocketClient(WebSocketContainer) - Constructor for class org.springframework.web.socket.client.standard.StandardWebSocketClient

Constructor accepting an existing WebSocketContainer instance.

StandardWebSocketHandlerAdapter - Class in org.springframework.web.socket.adapter.standard

Adapts a WebSocketHandler to the standard WebSocket for Java API.

StandardWebSocketHandlerAdapter(WebSocketHandler, StandardWebSocketSession) - Constructor for class org.springframework.web.socket.adapter.standard.StandardWebSocketHandlerAdapter

StandardWebSocketSession - Class in org.springframework.web.socket.adapter.standard

A WebSocketSession for use with the standard WebSocket for Java API.

StandardWebSocketSession(HttpHeaders, Map<String, Object>, InetSocketAddress, InetSocketAddress) - Constructor for class org.springframework.web.socket.adapter.standard.StandardWebSocketSession

Constructor for a standard WebSocket session.

StandardWebSocketSession(HttpHeaders, Map<String, Object>, InetSocketAddress, InetSocketAddress, Principal) - Constructor for class org.springframework.web.socket.adapter.standard.StandardWebSocketSession

Constructor that associates a user with the WebSocket session.

StandardWebSocketUpgradeStrategy - Class in org.springframework.web.socket.server.standard

A WebSocket RequestUpgradeStrategy for the Jakarta WebSocket API 2.1+.

StandardWebSocketUpgradeStrategy() - Constructor for class org.springframework.web.socket.server.standard.StandardWebSocketUpgradeStrategy

start() - Method in class org.springframework.web.socket.client.ConnectionManagerSupport

Start the WebSocket connection.

start() - Method in class org.springframework.web.socket.client.jetty.JettyWebSocketClient

Deprecated.

start() - Method in class org.springframework.web.socket.messaging.SubProtocolWebSocketHandler

start() - Method in class org.springframework.web.socket.messaging.WebSocketStompClient

start() - Method in class org.springframework.web.socket.server.support.AbstractHandshakeHandler

start() - Method in class org.springframework.web.socket.server.support.WebSocketHandlerMapping

start() - Method in class org.springframework.web.socket.server.support.WebSocketHttpRequestHandler

start() - Method in class org.springframework.web.socket.sockjs.client.JettyXhrTransport

start() - Method in class org.springframework.web.socket.sockjs.client.SockJsClient

start() - Method in class org.springframework.web.socket.sockjs.client.WebSocketTransport

start() - Method in class org.springframework.web.socket.sockjs.support.SockJsHttpRequestHandler

start() - Method in class org.springframework.web.socket.sockjs.transport.handler.WebSocketTransportHandler

start() - Method in class org.springframework.web.socket.sockjs.transport.TransportHandlingSockJsService

startInternal() - Method in class org.springframework.web.socket.client.ConnectionManagerSupport

startInternal() - Method in class org.springframework.web.socket.client.WebSocketConnectionManager

StompEndpointRegistry - Interface in org.springframework.web.socket.config.annotation

A contract for registering STOMP over WebSocket endpoints.

StompSubProtocolErrorHandler - Class in org.springframework.web.socket.messaging

A SubProtocolErrorHandler for use with STOMP.

StompSubProtocolErrorHandler() - Constructor for class org.springframework.web.socket.messaging.StompSubProtocolErrorHandler

StompSubProtocolHandler - Class in org.springframework.web.socket.messaging

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

StompSubProtocolHandler() - Constructor for class org.springframework.web.socket.messaging.StompSubProtocolHandler

StompSubProtocolHandler.Stats - Interface in org.springframework.web.socket.messaging

Contract for access to session counters.

StompWebSocketEndpointRegistration - Interface in org.springframework.web.socket.config.annotation

A contract for configuring a STOMP over WebSocket endpoint.

stompWebSocketHandlerMapping(WebSocketHandler, TaskScheduler) - Method in class org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurationSupport

stop() - Method in class org.springframework.web.socket.client.ConnectionManagerSupport

stop() - Method in class org.springframework.web.socket.client.jetty.JettyWebSocketClient

Deprecated.

stop() - Method in class org.springframework.web.socket.messaging.SubProtocolWebSocketHandler

stop() - Method in class org.springframework.web.socket.messaging.WebSocketStompClient

stop() - Method in class org.springframework.web.socket.server.support.AbstractHandshakeHandler

stop() - Method in class org.springframework.web.socket.server.support.WebSocketHandlerMapping

stop() - Method in class org.springframework.web.socket.server.support.WebSocketHttpRequestHandler

stop() - Method in class org.springframework.web.socket.sockjs.client.JettyXhrTransport

stop() - Method in class org.springframework.web.socket.sockjs.client.SockJsClient

stop() - Method in class org.springframework.web.socket.sockjs.client.WebSocketTransport

stop() - Method in class org.springframework.web.socket.sockjs.support.SockJsHttpRequestHandler

stop() - Method in class org.springframework.web.socket.sockjs.transport.handler.WebSocketTransportHandler

stop() - Method in class org.springframework.web.socket.sockjs.transport.TransportHandlingSockJsService

stop(Runnable) - Method in class org.springframework.web.socket.client.ConnectionManagerSupport

stop(Runnable) - Method in class org.springframework.web.socket.messaging.SubProtocolWebSocketHandler

stopInternal() - Method in class org.springframework.web.socket.client.ConnectionManagerSupport

stopInternal() - Method in class org.springframework.web.socket.client.WebSocketConnectionManager

StreamingSockJsSession - Class in org.springframework.web.socket.sockjs.transport.session

A SockJS session for use with streaming HTTP transports.

StreamingSockJsSession(String, SockJsServiceConfig, WebSocketHandler, Map<String, Object>) - Constructor for class org.springframework.web.socket.sockjs.transport.session.StreamingSockJsSession

SubProtocolCapable - Interface in org.springframework.web.socket

An interface for WebSocket handlers that support sub-protocols as defined in RFC 6455.

SubProtocolErrorHandler<P> - Interface in org.springframework.web.socket.messaging

A contract for handling sub-protocol errors sent to clients.

SubProtocolHandler - Interface in org.springframework.web.socket.messaging

A contract for handling WebSocket messages as part of a higher level protocol, referred to as "sub-protocol" in the WebSocket RFC specification.

subProtocolWebSocketHandler(AbstractSubscribableChannel, AbstractSubscribableChannel) - Method in class org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurationSupport

SubProtocolWebSocketHandler - Class in org.springframework.web.socket.messaging

An implementation of WebSocketHandler that delegates incoming WebSocket messages to a SubProtocolHandler along with a MessageChannel to which the sub-protocol handler can send messages from WebSocket clients to the application.

SubProtocolWebSocketHandler(MessageChannel, SubscribableChannel) - Constructor for class org.springframework.web.socket.messaging.SubProtocolWebSocketHandler

Create a new SubProtocolWebSocketHandler for the given inbound and outbound channels.

SubProtocolWebSocketHandler.Stats - Interface in org.springframework.web.socket.messaging

Contract for access to session counters.

supportsCors() - Method in enum class org.springframework.web.socket.sockjs.transport.TransportType

supportsEventType(Class<? extends ApplicationEvent>) - Method in class org.springframework.web.socket.messaging.DefaultSimpUserRegistry

supportsOrigin() - Method in enum class org.springframework.web.socket.sockjs.transport.TransportType

supportsPartialMessages() - Method in class org.springframework.web.socket.handler.AbstractWebSocketHandler

supportsPartialMessages() - Method in class org.springframework.web.socket.handler.PerConnectionWebSocketHandler

supportsPartialMessages() - Method in class org.springframework.web.socket.handler.WebSocketHandlerDecorator

supportsPartialMessages() - Method in class org.springframework.web.socket.messaging.SubProtocolWebSocketHandler

supportsPartialMessages() - Method in interface org.springframework.web.socket.WebSocketHandler

Whether the WebSocketHandler handles partial messages.

supportsSourceType(Class<?>) - Method in class org.springframework.web.socket.messaging.DefaultSimpUserRegistry

T

TERMINATE - Enum constant in enum class org.springframework.web.socket.handler.ConcurrentWebSocketSessionDecorator.OverflowStrategy

Throw SessionLimitExceededException that will result in the session being terminated.

TextDecoder() - Constructor for class org.springframework.web.socket.adapter.standard.ConvertingEncoderDecoderSupport.TextDecoder

TextEncoder() - Constructor for class org.springframework.web.socket.adapter.standard.ConvertingEncoderDecoderSupport.TextEncoder

TextMessage - Class in org.springframework.web.socket

A text WebSocket message.

TextMessage(byte[]) - Constructor for class org.springframework.web.socket.TextMessage

Create a new text WebSocket message from the given byte[].

TextMessage(CharSequence) - Constructor for class org.springframework.web.socket.TextMessage

Create a new text WebSocket message from the given CharSequence payload.

TextMessage(CharSequence, boolean) - Constructor for class org.springframework.web.socket.TextMessage

Create a new text WebSocket message with the given payload representing the full or partial message content.

TextWebSocketHandler - Class in org.springframework.web.socket.handler

A convenient base class for WebSocketHandler implementations that process text messages only.

TextWebSocketHandler() - Constructor for class org.springframework.web.socket.handler.TextWebSocketHandler

TLS_HANDSHAKE_FAILURE - Static variable in class org.springframework.web.socket.CloseStatus

"1015 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint.

TomcatRequestUpgradeStrategy - Class in org.springframework.web.socket.server.standard

A WebSocket RequestUpgradeStrategy for Apache Tomcat.

TomcatRequestUpgradeStrategy() - Constructor for class org.springframework.web.socket.server.standard.TomcatRequestUpgradeStrategy

toMutableAccessor(StompHeaderAccessor, Message<?>) - Method in class org.springframework.web.socket.messaging.StompSubProtocolHandler

TOO_BIG_TO_PROCESS - Static variable in class org.springframework.web.socket.CloseStatus

"1009 indicates that an endpoint is terminating the connection because it has received a message that is too big for it to process."

toSingleValueMap() - Method in class org.springframework.web.socket.WebSocketHttpHeaders

toString() - Method in class org.springframework.web.socket.AbstractWebSocketMessage

toString() - Method in class org.springframework.web.socket.adapter.AbstractWebSocketSession

toString() - Method in class org.springframework.web.socket.CloseStatus

toString() - Method in class org.springframework.web.socket.config.WebSocketMessageBrokerStats

toString() - Method in class org.springframework.web.socket.handler.BeanCreatingHandlerProvider

toString() - Method in class org.springframework.web.socket.handler.ConcurrentWebSocketSessionDecorator

toString() - Method in class org.springframework.web.socket.handler.PerConnectionWebSocketHandler

toString() - Method in class org.springframework.web.socket.handler.WebSocketHandlerDecorator

toString() - Method in class org.springframework.web.socket.handler.WebSocketSessionDecorator

toString() - Method in class org.springframework.web.socket.messaging.AbstractSubProtocolEvent

toString() - Method in class org.springframework.web.socket.messaging.DefaultSimpUserRegistry

toString() - Method in class org.springframework.web.socket.messaging.SessionDisconnectEvent

toString() - Method in class org.springframework.web.socket.messaging.StompSubProtocolHandler

toString() - Method in class org.springframework.web.socket.messaging.SubProtocolWebSocketHandler

toString() - Method in class org.springframework.web.socket.server.standard.ServerEndpointRegistration

toString() - Method in class org.springframework.web.socket.sockjs.client.AbstractClientSockJsSession

toString() - Method in class org.springframework.web.socket.sockjs.client.SockJsUrlInfo

toString() - Method in class org.springframework.web.socket.sockjs.client.WebSocketTransport

toString() - Method in class org.springframework.web.socket.sockjs.frame.SockJsFrame

toString() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession

toString() - Method in enum class org.springframework.web.socket.sockjs.transport.TransportType

toString() - Method in class org.springframework.web.socket.WebSocketExtension

toString() - Method in class org.springframework.web.socket.WebSocketHttpHeaders

toStringPayload() - Method in class org.springframework.web.socket.AbstractWebSocketMessage

toStringPayload() - Method in class org.springframework.web.socket.BinaryMessage

toStringPayload() - Method in class org.springframework.web.socket.PingMessage

toStringPayload() - Method in class org.springframework.web.socket.PongMessage

toStringPayload() - Method in class org.springframework.web.socket.TextMessage

Transport - Interface in org.springframework.web.socket.sockjs.client

A client-side implementation for a SockJS transport.

TransportHandler - Interface in org.springframework.web.socket.sockjs.transport

Handle a SockJS session URL, i.e.

TransportHandlingSockJsService - Class in org.springframework.web.socket.sockjs.transport

A basic implementation of SockJsService with support for SPI-based transport handling and session management.

TransportHandlingSockJsService(TaskScheduler, Collection<TransportHandler>) - Constructor for class org.springframework.web.socket.sockjs.transport.TransportHandlingSockJsService

Create a TransportHandlingSockJsService with given handler types.

TransportHandlingSockJsService(TaskScheduler, TransportHandler...) - Constructor for class org.springframework.web.socket.sockjs.transport.TransportHandlingSockJsService

Create a TransportHandlingSockJsService with given handler types.

TransportRequest - Interface in org.springframework.web.socket.sockjs.client

Exposes information, typically to Transport and session implementations, about a request to connect to a SockJS server endpoint over a given transport.

TransportType - Enum Class in org.springframework.web.socket.sockjs.transport

SockJS transport types.

tryCloseWithError(WebSocketSession, Throwable, Log) - Static method in class org.springframework.web.socket.handler.ExceptionWebSocketHandlerDecorator

tryCloseWithSockJsTransportError(Throwable, CloseStatus) - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession

Close due to error arising from SockJS transport handling.

U

UndertowRequestUpgradeStrategy - Class in org.springframework.web.socket.server.standard

A WebSocket RequestUpgradeStrategy for WildFly and its underlying Undertow web server.

UndertowRequestUpgradeStrategy() - Constructor for class org.springframework.web.socket.server.standard.UndertowRequestUpgradeStrategy

UndertowXhrTransport - Class in org.springframework.web.socket.sockjs.client

An XHR transport based on Undertow's UndertowClient.

UndertowXhrTransport() - Constructor for class org.springframework.web.socket.sockjs.client.UndertowXhrTransport

UndertowXhrTransport(OptionMap) - Constructor for class org.springframework.web.socket.sockjs.client.UndertowXhrTransport

unwrap(WebSocketHandler) - Static method in class org.springframework.web.socket.handler.WebSocketHandlerDecorator

unwrap(WebSocketSession) - Static method in class org.springframework.web.socket.handler.WebSocketSessionDecorator

updateLastActiveTime() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession

Should be invoked whenever the session becomes inactive.

upgrade(ServerHttpRequest, ServerHttpResponse, String, List<WebSocketExtension>, Principal, WebSocketHandler, Map<String, Object>) - Method in class org.springframework.web.socket.server.jetty.JettyRequestUpgradeStrategy

upgrade(ServerHttpRequest, ServerHttpResponse, String, List<WebSocketExtension>, Principal, WebSocketHandler, Map<String, Object>) - Method in interface org.springframework.web.socket.server.RequestUpgradeStrategy

Perform runtime specific steps to complete the upgrade.

upgrade(ServerHttpRequest, ServerHttpResponse, String, List<WebSocketExtension>, Principal, WebSocketHandler, Map<String, Object>) - Method in class org.springframework.web.socket.server.standard.AbstractStandardUpgradeStrategy

upgradeHttpToWebSocket(HttpServletRequest, HttpServletResponse, ServerEndpointConfig, Map<String, String>) - Method in class org.springframework.web.socket.server.standard.StandardWebSocketUpgradeStrategy

upgradeHttpToWebSocket(HttpServletRequest, HttpServletResponse, ServerEndpointConfig, Map<String, String>) - Method in class org.springframework.web.socket.server.standard.TomcatRequestUpgradeStrategy

upgradeHttpToWebSocket(HttpServletRequest, HttpServletResponse, ServerEndpointConfig, Map<String, String>) - Method in class org.springframework.web.socket.server.standard.UndertowRequestUpgradeStrategy

upgradeHttpToWebSocket(HttpServletRequest, HttpServletResponse, ServerEndpointConfig, Map<String, String>) - Method in class org.springframework.web.socket.server.standard.WebSphereRequestUpgradeStrategy

upgradeInternal(ServerHttpRequest, ServerHttpResponse, String, List<Extension>, Endpoint) - Method in class org.springframework.web.socket.server.standard.AbstractStandardUpgradeStrategy

upgradeInternal(ServerHttpRequest, ServerHttpResponse, String, List<Extension>, Endpoint) - Method in class org.springframework.web.socket.server.standard.AbstractTyrusRequestUpgradeStrategy

upgradeInternal(ServerHttpRequest, ServerHttpResponse, String, List<Extension>, Endpoint) - Method in class org.springframework.web.socket.server.standard.StandardWebSocketUpgradeStrategy

V

validateRequest(String, String, String) - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService

validateRequest(String, String, String) - Method in class org.springframework.web.socket.sockjs.transport.TransportHandlingSockJsService

value() - Method in enum class org.springframework.web.socket.sockjs.transport.TransportType

valueOf(String) - Static method in enum class org.springframework.web.socket.handler.ConcurrentWebSocketSessionDecorator.OverflowStrategy

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.web.socket.sockjs.frame.SockJsFrameType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.springframework.web.socket.sockjs.transport.TransportType

Returns the enum constant of this class with the specified name.

values() - Static method in enum class org.springframework.web.socket.handler.ConcurrentWebSocketSessionDecorator.OverflowStrategy

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.springframework.web.socket.sockjs.frame.SockJsFrameType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.springframework.web.socket.sockjs.transport.TransportType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Method in class org.springframework.web.socket.WebSocketHttpHeaders

W

WebLogicRequestUpgradeStrategy - Class in org.springframework.web.socket.server.standard

A WebSocket RequestUpgradeStrategy for Oracle's WebLogic.

WebLogicRequestUpgradeStrategy() - Constructor for class org.springframework.web.socket.server.standard.WebLogicRequestUpgradeStrategy

WebMvcStompEndpointRegistry - Class in org.springframework.web.socket.config.annotation

A registry for STOMP over WebSocket endpoints that maps the endpoints with a HandlerMapping for use in Spring MVC.

WebMvcStompEndpointRegistry(WebSocketHandler, WebSocketTransportRegistration, TaskScheduler) - Constructor for class org.springframework.web.socket.config.annotation.WebMvcStompEndpointRegistry

WebMvcStompWebSocketEndpointRegistration - Class in org.springframework.web.socket.config.annotation

An abstract base class for configuring STOMP over WebSocket/SockJS endpoints.

WebMvcStompWebSocketEndpointRegistration(String[], WebSocketHandler, TaskScheduler) - Constructor for class org.springframework.web.socket.config.annotation.WebMvcStompWebSocketEndpointRegistration

WEBSOCKET - Enum constant in enum class org.springframework.web.socket.sockjs.transport.TransportType

WebSocketAnnotationMethodMessageHandler - Class in org.springframework.web.socket.messaging

A subclass of SimpAnnotationMethodMessageHandler to provide support for ControllerAdvice with global @MessageExceptionHandler methods.

WebSocketAnnotationMethodMessageHandler(SubscribableChannel, MessageChannel, SimpMessageSendingOperations) - Constructor for class org.springframework.web.socket.messaging.WebSocketAnnotationMethodMessageHandler

WebSocketClient - Interface in org.springframework.web.socket.client

Contract for initiating a WebSocket request.

WebSocketClientSockJsSession - Class in org.springframework.web.socket.sockjs.client

An extension of AbstractClientSockJsSession wrapping and delegating to an actual WebSocket session.

WebSocketClientSockJsSession(TransportRequest, WebSocketHandler, CompletableFuture<WebSocketSession>) - Constructor for class org.springframework.web.socket.sockjs.client.WebSocketClientSockJsSession

WebSocketClientSockJsSession(TransportRequest, WebSocketHandler, SettableListenableFuture<WebSocketSession>) - Constructor for class org.springframework.web.socket.sockjs.client.WebSocketClientSockJsSession

Deprecated.

as of 6.0, in favor of WebSocketClientSockJsSession(TransportRequest, WebSocketHandler, CompletableFuture)

WebSocketConfigurationSupport - Class in org.springframework.web.socket.config.annotation

Configuration support for WebSocket request handling.

WebSocketConfigurationSupport() - Constructor for class org.springframework.web.socket.config.annotation.WebSocketConfigurationSupport

WebSocketConfigurer - Interface in org.springframework.web.socket.config.annotation

Defines callback methods to configure the WebSocket request handling via @EnableWebSocket.

WebSocketConnectionManager - Class in org.springframework.web.socket.client

WebSocket connection manager that connects to the server via WebSocketClient and handles the session with a WebSocketHandler.

WebSocketConnectionManager(WebSocketClient, WebSocketHandler, String, Object...) - Constructor for class org.springframework.web.socket.client.WebSocketConnectionManager

Constructor with the client to use and a handler to handle messages with.

WebSocketConnectionManager(WebSocketClient, WebSocketHandler, URI) - Constructor for class org.springframework.web.socket.client.WebSocketConnectionManager

Variant of WebSocketConnectionManager(WebSocketClient, WebSocketHandler, String, Object...) with a prepared URI.

WebSocketContainerFactoryBean - Class in org.springframework.web.socket.client.standard

A FactoryBean for creating and configuring a WebSocketContainer through Spring XML configuration.

WebSocketContainerFactoryBean() - Constructor for class org.springframework.web.socket.client.standard.WebSocketContainerFactoryBean

WebSocketExtension - Class in org.springframework.web.socket

Represents a WebSocket extension as defined in the RFC 6455.

WebSocketExtension(String) - Constructor for class org.springframework.web.socket.WebSocketExtension

Create a WebSocketExtension with the given name.

WebSocketExtension(String, Map<String, String>) - Constructor for class org.springframework.web.socket.WebSocketExtension

Create a WebSocketExtension with the given name and parameters.

WebSocketHandler - Interface in org.springframework.web.socket

A handler for WebSocket messages and lifecycle events.

WebSocketHandlerDecorator - Class in org.springframework.web.socket.handler

Wraps another WebSocketHandler instance and delegates to it.

WebSocketHandlerDecorator(WebSocketHandler) - Constructor for class org.springframework.web.socket.handler.WebSocketHandlerDecorator

WebSocketHandlerDecoratorFactory - Interface in org.springframework.web.socket.handler

A factory for applying decorators to a WebSocketHandler.

webSocketHandlerMapping(WebSocketConfigurationSupport.DefaultSockJsSchedulerContainer) - Method in class org.springframework.web.socket.config.annotation.WebSocketConfigurationSupport

WebSocketHandlerMapping - Class in org.springframework.web.socket.server.support

Extension of SimpleUrlHandlerMapping with support for more precise mapping of WebSocket handshake requests to handlers of type WebSocketHttpRequestHandler.

WebSocketHandlerMapping() - Constructor for class org.springframework.web.socket.server.support.WebSocketHandlerMapping

WebSocketHandlerRegistration - Interface in org.springframework.web.socket.config.annotation

Provides methods for configuring a WebSocket handler.

WebSocketHandlerRegistry - Interface in org.springframework.web.socket.config.annotation

Provides methods for configuring WebSocketHandler request mappings.

WebSocketHttpHeaders - Class in org.springframework.web.socket

An HttpHeaders variant that adds support for the HTTP headers defined by the WebSocket specification RFC 6455.

WebSocketHttpHeaders() - Constructor for class org.springframework.web.socket.WebSocketHttpHeaders

Create a new instance.

WebSocketHttpHeaders(HttpHeaders) - Constructor for class org.springframework.web.socket.WebSocketHttpHeaders

Create an instance that wraps the given pre-existing HttpHeaders and also propagate all changes to it.

WebSocketHttpRequestHandler - Class in org.springframework.web.socket.server.support

A HttpRequestHandler for processing WebSocket handshake requests.

WebSocketHttpRequestHandler(WebSocketHandler) - Constructor for class org.springframework.web.socket.server.support.WebSocketHttpRequestHandler

WebSocketHttpRequestHandler(WebSocketHandler, HandshakeHandler) - Constructor for class org.springframework.web.socket.server.support.WebSocketHttpRequestHandler

WebSocketMessage<T> - Interface in org.springframework.web.socket

A message that can be handled or sent on a WebSocket connection.

WebSocketMessageBrokerConfigurationSupport - Class in org.springframework.web.socket.config.annotation

Extends AbstractMessageBrokerConfiguration and adds configuration for receiving and responding to STOMP messages from WebSocket clients.

WebSocketMessageBrokerConfigurationSupport() - Constructor for class org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurationSupport

WebSocketMessageBrokerConfigurer - Interface in org.springframework.web.socket.config.annotation

Defines methods for configuring message handling with simple messaging protocols (e.g.

webSocketMessageBrokerStats(AbstractBrokerMessageHandler, WebSocketHandler, TaskExecutor, TaskExecutor, TaskScheduler) - Method in class org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurationSupport

WebSocketMessageBrokerStats - Class in org.springframework.web.socket.config

A central class for aggregating information about internal state and counters from key infrastructure components of the setup that comes with @EnableWebSocketMessageBroker for Java config and <websocket:message-broker> for XML.

WebSocketMessageBrokerStats() - Constructor for class org.springframework.web.socket.config.WebSocketMessageBrokerStats

WebSocketNamespaceHandler - Class in org.springframework.web.socket.config

NamespaceHandler for Spring WebSocket configuration namespace.

WebSocketNamespaceHandler() - Constructor for class org.springframework.web.socket.config.WebSocketNamespaceHandler

webSocketScopeConfigurer() - Static method in class org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurationSupport

WebSocketServerSockJsSession - Class in org.springframework.web.socket.sockjs.transport.session

A SockJS session for use with the WebSocket transport.

WebSocketServerSockJsSession(String, SockJsServiceConfig, WebSocketHandler, Map<String, Object>) - Constructor for class org.springframework.web.socket.sockjs.transport.session.WebSocketServerSockJsSession

WebSocketSession - Interface in org.springframework.web.socket

A WebSocket session abstraction.

WebSocketSessionDecorator - Class in org.springframework.web.socket.handler

Wraps another WebSocketSession instance and delegates to it.

WebSocketSessionDecorator(WebSocketSession) - Constructor for class org.springframework.web.socket.handler.WebSocketSessionDecorator

WebSocketStompClient - Class in org.springframework.web.socket.messaging

A STOMP over WebSocket client that connects using an implementation of WebSocketClient including SockJsClient.

WebSocketStompClient(WebSocketClient) - Constructor for class org.springframework.web.socket.messaging.WebSocketStompClient

Class constructor.

WebSocketToJettyExtensionConfigAdapter - Class in org.springframework.web.socket.adapter.jetty

Adapter class to convert a WebSocketExtension to a Jetty ExtensionConfig.

WebSocketToJettyExtensionConfigAdapter(WebSocketExtension) - Constructor for class org.springframework.web.socket.adapter.jetty.WebSocketToJettyExtensionConfigAdapter

WebSocketToStandardExtensionAdapter - Class in org.springframework.web.socket.adapter.standard

Adapt an instance of WebSocketExtension to the Extension interface.

WebSocketToStandardExtensionAdapter(WebSocketExtension) - Constructor for class org.springframework.web.socket.adapter.standard.WebSocketToStandardExtensionAdapter

WebSocketTransport - Class in org.springframework.web.socket.sockjs.client

A SockJS Transport that uses a WebSocketClient.

WebSocketTransport(WebSocketClient) - Constructor for class org.springframework.web.socket.sockjs.client.WebSocketTransport

WebSocketTransportHandler - Class in org.springframework.web.socket.sockjs.transport.handler

WebSocket-based TransportHandler.

WebSocketTransportHandler(HandshakeHandler) - Constructor for class org.springframework.web.socket.sockjs.transport.handler.WebSocketTransportHandler

WebSocketTransportRegistration - Class in org.springframework.web.socket.config.annotation

Configure the processing of messages received from and sent to WebSocket clients.

WebSocketTransportRegistration() - Constructor for class org.springframework.web.socket.config.annotation.WebSocketTransportRegistration

WebSphereRequestUpgradeStrategy - Class in org.springframework.web.socket.server.standard

WebSphere support for upgrading an HttpServletRequest during a WebSocket handshake.

WebSphereRequestUpgradeStrategy() - Constructor for class org.springframework.web.socket.server.standard.WebSphereRequestUpgradeStrategy

willDecode(M) - Method in class org.springframework.web.socket.adapter.standard.ConvertingEncoderDecoderSupport

Determine if a given message can be decoded.

withReason(String) - Method in class org.springframework.web.socket.CloseStatus

Create a new CloseStatus from this one with the specified reason.

withSockJS() - Method in class org.springframework.web.socket.config.annotation.AbstractWebSocketHandlerRegistration

withSockJS() - Method in interface org.springframework.web.socket.config.annotation.StompWebSocketEndpointRegistration

Enable SockJS fallback options.

withSockJS() - Method in class org.springframework.web.socket.config.annotation.WebMvcStompWebSocketEndpointRegistration

withSockJS() - Method in interface org.springframework.web.socket.config.annotation.WebSocketHandlerRegistration

Enable SockJS fallback options.

writeFrame(SockJsFrame) - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession

For internal use within a TransportHandler and the (TransportHandler-specific) session class.

writeFrame(SockJsFrame) - Method in class org.springframework.web.socket.sockjs.transport.session.PollingSockJsSession

writeFrameInternal(SockJsFrame) - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractHttpSockJsSession

writeFrameInternal(SockJsFrame) - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession

writeFrameInternal(SockJsFrame) - Method in class org.springframework.web.socket.sockjs.transport.session.WebSocketServerSockJsSession

X

XHR - Enum constant in enum class org.springframework.web.socket.sockjs.transport.TransportType

XHR_SEND - Enum constant in enum class org.springframework.web.socket.sockjs.transport.TransportType

XHR_STREAMING - Enum constant in enum class org.springframework.web.socket.sockjs.transport.TransportType

XhrClientSockJsSession - Class in org.springframework.web.socket.sockjs.client

An extension of AbstractClientSockJsSession for use with HTTP transports simulating a WebSocket session.

XhrClientSockJsSession(TransportRequest, WebSocketHandler, XhrTransport, CompletableFuture<WebSocketSession>) - Constructor for class org.springframework.web.socket.sockjs.client.XhrClientSockJsSession

Create a new XhrClientSockJsSession.

XhrClientSockJsSession(TransportRequest, WebSocketHandler, XhrTransport, SettableListenableFuture<WebSocketSession>) - Constructor for class org.springframework.web.socket.sockjs.client.XhrClientSockJsSession

Deprecated.

as of 6.0, in favor of XhrClientSockJsSession(TransportRequest, WebSocketHandler, XhrTransport, CompletableFuture)

XhrPollingTransportHandler - Class in org.springframework.web.socket.sockjs.transport.handler

A TransportHandler based on XHR (long) polling.

XhrPollingTransportHandler() - Constructor for class org.springframework.web.socket.sockjs.transport.handler.XhrPollingTransportHandler

XhrReceivingTransportHandler - Class in org.springframework.web.socket.sockjs.transport.handler

A TransportHandler that receives messages over HTTP.

XhrReceivingTransportHandler() - Constructor for class org.springframework.web.socket.sockjs.transport.handler.XhrReceivingTransportHandler

XhrStreamingTransportHandler - Class in org.springframework.web.socket.sockjs.transport.handler

A TransportHandler that sends messages over an HTTP streaming request.

XhrStreamingTransportHandler() - Constructor for class org.springframework.web.socket.sockjs.transport.handler.XhrStreamingTransportHandler

XhrTransport - Interface in org.springframework.web.socket.sockjs.client

A SockJS Transport that uses HTTP requests to simulate a WebSocket interaction.

A B C D E F G H I J K L M N O P R S T U V W X
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form