A B C D E F G H I J K L M N O P R S T U V W X

A

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 based 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

An 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 SockJS sessions implementing SockJsSession.

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

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

A base class for RequestUpgradeStrategy implementations that build on the standard WebSocket API for Java.

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

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

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

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 sub-classes to put together the actual HTTP request mappings.

AbstractWebSocketHandlerRegistration(TaskScheduler) - 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

Class constructor

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

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

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

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

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.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.

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

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

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

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

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

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.

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

A WebSocket connection manager that is given a URI, a ServerEndpoint-annotated endpoint, connects to a WebSocket server through the ConnectionManagerSupport.start() and ConnectionManagerSupport.stop() methods.

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

AnnotatedEndpointConnectionManager(Class<?>, 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 http://www.json.org/).

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

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

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(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.

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.

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

A convenient base class for WebSocketHandler implementation 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

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

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

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

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

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

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

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

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

Close the WebSocket connection with the given close status.

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

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

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

Close the WebSocket connection with the given close status.

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

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

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.

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 incoming messages from 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.

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.

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

A base class for WebSocket connection managers.

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

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 javax.websocket.Encoder that delegates to Spring's conversion service.

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

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

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

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

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

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

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.JsonpPollingTransportHandler

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.

createTyrusEndpoint(EndpointWrapper) - Method in class org.springframework.web.socket.server.standard.GlassFishRequestUpgradeStrategy

D

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

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.

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.

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

Decorate the WebSocketHandler provided to the class constructor.

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

A default HandshakeHandler implementation.

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

Default constructor that autodetects and instantiates a RequestUpgradeStrategy suitable for the runtime container.

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

A constructor that accepts a runtime-specific RequestUpgradeStrategy.

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

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, 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, 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.

defaultSockJsTaskScheduler() - Method in class org.springframework.web.socket.config.annotation.WebSocketConfigurationSupport

The default TaskScheduler to use if none is configured via SockJsServiceRegistration.setTaskScheduler(org.springframework.scheduling.TaskScheduler), i.e.

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

Invoked in reaction to the underlying connection being closed by the remote side (or the WebSocket container) in order to perform cleanup and notify the WebSocketHandler.

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

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

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

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

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

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

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

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

doHandshake(WebSocketHandler, String, Object...) - Method in class org.springframework.web.socket.client.jetty.JettyWebSocketClient

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

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

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.DefaultHandshakeHandler

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

doHandshakeInternal(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.

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

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

E

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

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

 @Configuration
 @EnableWebSocket
 public class MyWebSocketConfig {

 }

EnableWebSocketMessageBroker - Annotation Type 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(T) - Method in class org.springframework.web.socket.adapter.standard.ConvertingEncoderDecoderSupport

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.

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

A WebSocket connection manager that is given a URI, an Endpoint, connects to a WebSocket server through the ConnectionManagerSupport.start() and ConnectionManagerSupport.stop() methods.

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

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

A TransportHandler for sending messages via Server-Sent events: http://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

F

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

Filter the list of requested WebSocket extensions.

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

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

Only called if the connection is currently active

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

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

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 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.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 or null if none was specified or negotiated successfully.

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

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

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

Returns 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

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

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

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

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.JsonpPollingTransportHandler

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.

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

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

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

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

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.server.standard.ServerEndpointRegistration

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

Return the negotiated extensions or null if none was specified or negotiated successfully.

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

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

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.JsonpPollingTransportHandler

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

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

Return a HandlerMapping with mapped HttpRequestHandlers.

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

Return a handler mapping with the mapped ViewControllers; or null in case of no registrations.

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

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

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

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

Handshake request specific attributes.

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.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.

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.

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

Return the default headers for the WebSocket handshake request.

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

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.

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 org.springframework.web.socket.sockjs.transport.TransportType

The HTTP method for this transport.

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.sockjs.transport.session.AbstractSockJsSession

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

Return a unique session identifier.

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

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

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

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

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.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.

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

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

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

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

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

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

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

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

Return the underlying native WebSocketSession, if available.

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

Return the underlying native WebSocketSession, if available.

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

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

getNegotiatedExtensions(List<Extension>, List<Extension>) - Method in class org.springframework.web.socket.server.standard.ServerEndpointRegistration

getNegotiatedSubprotocol(List<String>, List<String>) - Method in class org.springframework.web.socket.server.standard.ServerEndpointRegistration

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.WebMvcStompEndpointRegistry

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

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

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

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 be null.

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

Returns the message payload.

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

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

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

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

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

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.client.jetty.JettyWebSocketClient

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

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.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

Returns the reason or null.

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.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.

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

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

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

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

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

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.

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

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

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

The 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

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

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

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.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.server.standard.ServerEndpointRegistration

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

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.DefaultHandshakeHandler

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.GlassFishRequestUpgradeStrategy

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

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

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

Return the configured TaskExecutor.

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 TaskExecutor.

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.

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.

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

Return the registered handlers per transport type.

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.JsonpPollingTransportHandler

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

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.

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

Returns the type being converted.

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.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.

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

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

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

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.support.SockJsHttpRequestHandler

Return the WebSocketHandler.

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

RequestUpgradeStrategy that provides support for GlassFish 4 and beyond.

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

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

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

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

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

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

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

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

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(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

Process a SockJS HTTP request.

handleRequest(HttpServletRequest, HttpServletResponse) - Method in class org.springframework.web.socket.sockjs.support.SockJsHttpRequestHandler

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, WebSocketHandler, AbstractHttpSockJsSession) - Method in class org.springframework.web.socket.sockjs.transport.handler.AbstractHttpReceivingTransportHandler

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, AbstractHttpSockJsSession) - Method in class org.springframework.web.socket.sockjs.transport.handler.JsonpPollingTransportHandler

handleRequestInternal(ServerHttpRequest, ServerHttpResponse, WebSocketHandler, AbstractHttpSockJsSession) - Method in class org.springframework.web.socket.sockjs.transport.handler.JsonpReceivingTransportHandler

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(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.DefaultHandshakeHandler

HandshakeFailureException - Exception in org.springframework.web.socket.server

Thrown when handshake processing failed to complete due to an internal, unrecoverable error.

HandshakeFailureException(String, Throwable) - Constructor for exception org.springframework.web.socket.server.HandshakeFailureException

Constructor with message and root cause.

HandshakeFailureException(String) - Constructor for exception org.springframework.web.socket.server.HandshakeFailureException

Constructor without a message.

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

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

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

An HTTP TransportHandler that uses a famous browsder document.domain technique: http://stackoverflow.com/questions/1481251/what-does-document-domain-document-domain-do

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

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

An interceptor to copy HTTP session attributes into the map of "handshake attributes" made available through WebSocketSession.getHandshakeAttributes().

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

A constructor for copying all available HTTP session attributes.

HttpSessionHandshakeInterceptor(Collection<String>) - Constructor for class org.springframework.web.socket.server.support.HttpSessionHandshakeInterceptor

A constructor for copying a subset of HTTP session attributes.

I

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

init() - Method in class org.springframework.web.socket.config.WebSocketNamespaceHandler

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.transport.session.WebSocketServerSockJsSession

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

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.client.jetty.JettyWebSocketClient

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

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

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

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

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.sockjs.transport.session.AbstractSockJsSession

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

Return whether the connection is still 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

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

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

Whether 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.DefaultHandshakeHandler

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

Whether WebSocket transport is enabled.

isWebSocketVersionSupported(WebSocketHttpHeaders) - Method in class org.springframework.web.socket.server.support.DefaultHandshakeHandler

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

RequestUpgradeStrategy for use with Jetty 9.

JettyRequestUpgradeStrategy() - Constructor for class org.springframework.web.socket.server.jetty.JettyRequestUpgradeStrategy

Default constructor that creates WebSocketServerFactory through its default constructor thus using a default WebSocketPolicy.

JettyRequestUpgradeStrategy(WebSocketServerFactory) - Constructor for class org.springframework.web.socket.server.jetty.JettyRequestUpgradeStrategy

A constructor accepting a WebSocketServerFactory.

JettyWebSocketClient - Class in org.springframework.web.socket.client.jetty

Initiates WebSocket requests to a WebSocket server programmatically through the Jetty WebSocket API.

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

Default constructor that creates an instance of WebSocketClient with default settings.

JettyWebSocketClient(WebSocketClient) - Constructor for class org.springframework.web.socket.client.jetty.JettyWebSocketClient

Constructor that accepts a pre-configured WebSocketClient.

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 WebSocket API.

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

Create a new JettyWebSocketSession instance.

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

A TransportHandler that sends messages via JSONP polling.

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

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

A TransportHandler that receives messages over HTTP.

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

K

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

L

logger - 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.DefaultHandshakeHandler

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

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

The default TaskScheduler to use if none is configured via SockJsServiceRegistration.setTaskScheduler(org.springframework.scheduling.TaskScheduler), i.e.

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

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

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

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

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 Java 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 Java 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 WebSocket API.

org.springframework.web.socket.server.standard - package org.springframework.web.socket.server.standard

Server-side classes for use with standard Java 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.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.

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.

postProcessAfterInitialization(Object, String) - Method in class org.springframework.web.socket.server.standard.ServerEndpointExporter

postProcessBeforeInitialization(Object, String) - Method in class org.springframework.web.socket.server.standard.ServerEndpointExporter

preProcessContent(String) - Method in class org.springframework.web.socket.sockjs.frame.DefaultSockJsFrameFormat

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

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.JsonpReceivingTransportHandler

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

readOnlyWebSocketHttpHeaders(WebSocketHttpHeaders) - Static method in class org.springframework.web.socket.WebSocketHttpHeaders

Returns WebSocketHttpHeaders object that can only be read, not written to.

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

Configure STOMP over WebSocket endpoints.

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.

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

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

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.

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.DefaultHandshakeHandler

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

sendErrorMessage(WebSocketSession, Throwable) - Method in class org.springframework.web.socket.messaging.StompSubProtocolHandler

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

sendMessage(WebSocketMessage<?>) - Method in class org.springframework.web.socket.adapter.AbstractWebSocketSession

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 org.springframework.web.socket.sockjs.transport.TransportType

sendsSessionCookie() - Method in enum 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 Java 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 applications.

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

Create a new ServerEndpointRegistration instance from an javax.webscoket.Endpoint class.

ServerEndpointRegistration(String, Endpoint) - Constructor for class org.springframework.web.socket.server.standard.ServerEndpointRegistration

Create a new ServerEndpointRegistration instance from an javax.websocket.Endpoint instance.

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(TaskScheduler) - Constructor for class org.springframework.web.socket.config.annotation.ServletWebSocketHandlerRegistration

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

A WebSocketHandlerRegistry that maps WebSocketHandlers to URLs for use in a Servlet container.

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

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

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.server.standard.ServerEndpointExporter

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.client.jetty.JettyWebSocketClient

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

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

Transports which don't support cross-domain communication natively (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

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

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.

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

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

Provide a custom or pre-configured HandshakeHandler.

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.

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

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.

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.

setInterceptors(HandshakeInterceptor[]) - Method in class org.springframework.web.socket.config.annotation.AbstractWebSocketHandlerRegistration

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

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

setMaxBinaryMessageBufferSize(int) - 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(int) - Method in class org.springframework.web.socket.server.standard.ServletServerContainerFactoryBean

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

The codec to use for encoding and decoding SockJS messages.

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

A unique name for the service mainly for logging purposes.

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

Set the order for the resulting SimpleUrlHandlerMapping relative to other handler mappings configured in Spring MVC.

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

Set the origin to use.

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.client.jetty.JettyWebSocketClient

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.

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

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 which don't support cross-domain communication natively (e.g.

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.client.WebSocketConnectionManager

Set the sub-protocols to use.

setSubprotocols(List<String>) - Method in class org.springframework.web.socket.server.standard.ServerEndpointRegistration

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

setSupportedProtocols(String...) - Method in class org.springframework.web.socket.server.support.DefaultHandshakeHandler

Use this property to configure the list of supported sub-protocols.

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

Set a TaskExecutor to use to open the connection.

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(AsyncListenableTaskExecutor) - Method in class org.springframework.web.socket.client.standard.StandardWebSocketClient

Set a TaskExecutor to use to open the connection.

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

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

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

setUserProperties(Map<String, Object>) - Method in class org.springframework.web.socket.server.standard.ServerEndpointRegistration

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

Provide a registry with which to register active user session ids.

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 don't support WebSocket.

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

SockJsException - Exception in org.springframework.web.socket.sockjs

Base class for exceptions raised while processing SockJS HTTP requests.

SockJsException(String, Throwable) - Constructor for exception org.springframework.web.socket.sockjs.SockJsException

SockJsException(String, String, Throwable) - Constructor for exception org.springframework.web.socket.sockjs.SockJsException

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

Represents a SockJS frame and provides factory methods for creating SockJS frames.

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

SockJsFrameFormat - Interface in org.springframework.web.socket.sockjs.frame

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>, 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, typically used indirectly, in conjunction with @EnableWebSocket and WebSocketConfigurer.

SockJsServiceRegistration(TaskScheduler) - 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

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

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

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

Initiates WebSocket requests to a WebSocket server programatically through the standard Java WebSocket API.

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

Default constructor that calls ContainerProvider.getWebSocketContainer() to obtain a WebSocketContainer instance.

StandardWebSocketClient(WebSocketContainer) - Constructor for class org.springframework.web.socket.client.standard.StandardWebSocketClient

Constructor that accepts a pre-configured 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

Class constructor.

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

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

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

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

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

StompEndpointRegistry - Interface in org.springframework.web.socket.config.annotation

A contract for registering STOMP over WebSocket endpoints.

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

StompWebSocketEndpointRegistration - Interface in org.springframework.web.socket.config.annotation

A contract for configuring a STOMP over WebSocket endpoint.

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

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

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

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

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

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

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.

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() - 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

supportsCors() - Method in enum 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.

T

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(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 implementation 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

Tomcat support for upgrading an HttpServletRequest during a WebSocket handshake.

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

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.handler.BeanCreatingHandlerProvider

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.sockjs.frame.SockJsFrame

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

toString() - Method in enum 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

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, TransportHandler...) - Constructor for class org.springframework.web.socket.sockjs.transport.TransportHandlingSockJsService

Create a TransportHandlingSockJsService with given handler types.

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

Create a TransportHandlingSockJsService with given handler types.

TransportType - Enum 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

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>, WebSocketHandler, Map<String, Object>) - Method in class org.springframework.web.socket.server.jetty.JettyRequestUpgradeStrategy

upgrade(ServerHttpRequest, ServerHttpResponse, String, List<WebSocketExtension>, 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>, WebSocketHandler, Map<String, Object>) - 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.AbstractStandardUpgradeStrategy

upgradeInternal(ServerHttpRequest, ServerHttpResponse, String, List<Extension>, Endpoint) - Method in class org.springframework.web.socket.server.standard.GlassFishRequestUpgradeStrategy

upgradeInternal(ServerHttpRequest, ServerHttpResponse, String, List<Extension>, Endpoint) - Method in class org.springframework.web.socket.server.standard.TomcatRequestUpgradeStrategy

UTF8_CHARSET - Static variable in class org.springframework.web.socket.sockjs.transport.handler.AbstractTransportHandler

V

validateRequest(String, String, String) - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService

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

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

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.springframework.web.socket.sockjs.transport.TransportType

Returns an array containing the constants of this enum type, in the order they are declared.

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

W

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

A registry for STOMP over WebSocket endpoints that maps the endpoints with a SimpleUrlHandlerMapping for use in Spring MVC.

WebMvcStompEndpointRegistry(WebSocketHandler, UserSessionRegistry, TaskScheduler) - Constructor for class org.springframework.web.socket.config.annotation.WebMvcStompEndpointRegistry

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

An abstract base class class for configuring STOMP over WebSocket/SockJS endpoints.

WebMvcStompWebSocketEndpointRegistration(String[], WebSocketHandler, TaskScheduler) - Constructor for class org.springframework.web.socket.config.annotation.WebMvcStompWebSocketEndpointRegistration

WebSocketClient - Interface in org.springframework.web.socket.client

Contract for initiating a WebSocket request.

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

A WebSocket connection manager that is given a URI, a WebSocketClient, and a WebSocketHandler, connects to a WebSocket server through ConnectionManagerSupport.start() and ConnectionManagerSupport.stop() methods.

WebSocketConnectionManager(WebSocketClient, WebSocketHandler, String, Object...) - Constructor for class org.springframework.web.socket.client.WebSocketConnectionManager

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

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

webSocketHandlerMapping() - Method in class org.springframework.web.socket.config.annotation.WebSocketConfigurationSupport

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.

WebSocketNamespaceHandler - Class in org.springframework.web.socket.config

NamespaceHandler for Spring WebSocket configuration namespace.

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

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.

WebSocketToJettyExtensionConfigAdapter - Class in org.springframework.web.socket.adapter.jetty

WebSocketToJettyExtensionConfigAdapter(WebSocketExtension) - Constructor for class org.springframework.web.socket.adapter.jetty.WebSocketToJettyExtensionConfigAdapter

WebSocketToStandardExtensionAdapter - Class in org.springframework.web.socket.adapter.standard

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

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

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

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

Crate 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

Enable SockJS fallback options.

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.StreamingSockJsSession

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

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

X

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

A B C D E F G H I J K L M N O P R S T U V W X