- get(Object) - Method in class org.springframework.web.socket.WebSocketHttpHeaders
-
- getAcceptedProtocol() - Method in class org.springframework.web.socket.adapter.jetty.JettyWebSocketSession
-
- getAcceptedProtocol() - Method in class org.springframework.web.socket.adapter.standard.StandardWebSocketSession
-
- getAcceptedProtocol() - Method in class org.springframework.web.socket.handler.WebSocketSessionDecorator
-
- getAcceptedProtocol() - Method in class org.springframework.web.socket.sockjs.client.WebSocketClientSockJsSession
-
- getAcceptedProtocol() - Method in class org.springframework.web.socket.sockjs.client.XhrClientSockJsSession
-
- getAcceptedProtocol() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractHttpSockJsSession
-
Return the selected sub-protocol to use.
- getAcceptedProtocol() - Method in class org.springframework.web.socket.sockjs.transport.session.WebSocketServerSockJsSession
-
- getAcceptedProtocol() - Method in interface org.springframework.web.socket.WebSocketSession
-
Return the negotiated sub-protocol.
- getAllowedOriginPatterns() - Method in class org.springframework.web.socket.server.support.OriginHandshakeInterceptor
-
Return the allowed Origin
pattern header values.
- getAllowedOriginPatterns() - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService
-
- getAllowedOrigins() - Method in class org.springframework.web.socket.server.support.OriginHandshakeInterceptor
-
Return the allowed Origin
header values.
- getAllowedOrigins() - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService
-
Return configure allowed Origin
header values.
- getApplicationContext() - Method in class org.springframework.web.socket.adapter.standard.ConvertingEncoderDecoderSupport
-
Returns the active ApplicationContext
.
- getAsyncSendTimeout() - Method in class org.springframework.web.socket.client.standard.WebSocketContainerFactoryBean
-
- getAsyncSendTimeout() - Method in class org.springframework.web.socket.server.standard.ServletServerContainerFactoryBean
-
- getAttributeNames() - Method in class org.springframework.web.socket.server.support.HttpSessionHandshakeInterceptor
-
Return the configured attribute names to copy (read-only).
- getAttributes() - Method in class org.springframework.web.socket.adapter.AbstractWebSocketSession
-
- getAttributes() - Method in class org.springframework.web.socket.handler.WebSocketSessionDecorator
-
- getAttributes() - Method in class org.springframework.web.socket.sockjs.client.AbstractClientSockJsSession
-
- getAttributes() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession
-
- getAttributes() - Method in interface org.springframework.web.socket.WebSocketSession
-
Return the map with attributes associated with the WebSocket session.
- getBinaryMessageSizeLimit() - Method in class org.springframework.web.socket.adapter.jetty.JettyWebSocketSession
-
- getBinaryMessageSizeLimit() - Method in class org.springframework.web.socket.adapter.standard.StandardWebSocketSession
-
- getBinaryMessageSizeLimit() - Method in class org.springframework.web.socket.handler.WebSocketSessionDecorator
-
- getBinaryMessageSizeLimit() - Method in class org.springframework.web.socket.sockjs.client.WebSocketClientSockJsSession
-
- getBinaryMessageSizeLimit() - Method in class org.springframework.web.socket.sockjs.client.XhrClientSockJsSession
-
- getBinaryMessageSizeLimit() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractHttpSockJsSession
-
- getBinaryMessageSizeLimit() - Method in class org.springframework.web.socket.sockjs.transport.session.WebSocketServerSockJsSession
-
- getBinaryMessageSizeLimit() - Method in interface org.springframework.web.socket.WebSocketSession
-
Get the configured maximum size for an incoming binary message.
- getBufferSize() - Method in class org.springframework.web.socket.handler.ConcurrentWebSocketSessionDecorator
-
Return the current buffer size (number of bytes).
- getBufferSizeLimit() - Method in class org.springframework.web.socket.handler.ConcurrentWebSocketSessionDecorator
-
Return the configured buffer-size limit (number of bytes).
- getCallbackParam(ServerHttpRequest) - Method in class org.springframework.web.socket.sockjs.transport.handler.AbstractHttpSendingTransportHandler
-
- getClientInboundExecutorStatsInfo() - Method in class org.springframework.web.socket.config.WebSocketMessageBrokerStats
-
Get stats about the executor processing incoming messages from WebSocket clients.
- getClientOutboundExecutorStatsInfo() - Method in class org.springframework.web.socket.config.WebSocketMessageBrokerStats
-
Get stats about the executor processing outgoing messages to WebSocket clients.
- getCloseStatus() - Method in class org.springframework.web.socket.messaging.SessionDisconnectEvent
-
Return the status with which the session was closed.
- getCode() - Method in class org.springframework.web.socket.CloseStatus
-
Return the status code.
- getConfigurator() - Method in class org.springframework.web.socket.server.standard.ServerEndpointRegistration
-
- getContainer(HttpServletRequest) - Method in class org.springframework.web.socket.server.standard.AbstractStandardUpgradeStrategy
-
- getContainer(HttpServletRequest) - Method in class org.springframework.web.socket.server.standard.TomcatRequestUpgradeStrategy
-
- getContainer(HttpServletRequest) - Method in class org.springframework.web.socket.server.standard.UndertowRequestUpgradeStrategy
-
- getContent() - Method in class org.springframework.web.socket.sockjs.frame.SockJsFrame
-
Return the SockJS frame content (never null
).
- getContentBytes() - Method in class org.springframework.web.socket.sockjs.frame.SockJsFrame
-
Return the SockJS frame content as a byte array.
- getContentType() - Method in class org.springframework.web.socket.sockjs.transport.handler.AbstractHttpSendingTransportHandler
-
- getContentType() - Method in class org.springframework.web.socket.sockjs.transport.handler.EventSourceTransportHandler
-
- getContentType() - Method in class org.springframework.web.socket.sockjs.transport.handler.HtmlFileTransportHandler
-
- getContentType() - Method in class org.springframework.web.socket.sockjs.transport.handler.XhrPollingTransportHandler
-
- getContentType() - Method in class org.springframework.web.socket.sockjs.transport.handler.XhrStreamingTransportHandler
-
- getConversionService() - Method in class org.springframework.web.socket.adapter.standard.ConvertingEncoderDecoderSupport
-
Strategy method used to obtain the ConversionService
.
- getCorsConfiguration(HttpServletRequest) - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService
-
- getCorsConfiguration(HttpServletRequest) - Method in class org.springframework.web.socket.sockjs.support.SockJsHttpRequestHandler
-
- getDecoders() - Method in class org.springframework.web.socket.server.standard.ServerEndpointRegistration
-
- getDecoratorFactories() - Method in class org.springframework.web.socket.config.annotation.WebSocketTransportRegistration
-
- getDefaultProtocolHandler() - Method in class org.springframework.web.socket.messaging.SubProtocolWebSocketHandler
-
Return the default sub-protocol handler to use.
- getDelegate() - Method in class org.springframework.web.socket.handler.WebSocketHandlerDecorator
-
- getDelegate() - Method in class org.springframework.web.socket.handler.WebSocketSessionDecorator
-
- getDisconnectDelay() - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService
-
Return the amount of time in milliseconds before a client is considered disconnected.
- getEncoders() - Method in class org.springframework.web.socket.server.standard.ServerEndpointRegistration
-
- getEndpoint() - Method in class org.springframework.web.socket.server.standard.ServerEndpointRegistration
-
- getEndpointClass() - Method in class org.springframework.web.socket.server.standard.ServerEndpointRegistration
-
- getEndpointInstance(Class<T>) - Method in class org.springframework.web.socket.server.standard.ServerEndpointRegistration
-
- getEndpointInstance(Class<T>) - Method in class org.springframework.web.socket.server.standard.SpringConfigurator
-
- getErrorHandler() - Method in class org.springframework.web.socket.messaging.StompSubProtocolHandler
-
Return the configured error handler.
- getExtensions() - Method in class org.springframework.web.socket.adapter.jetty.JettyWebSocketSession
-
- getExtensions() - Method in class org.springframework.web.socket.adapter.standard.StandardWebSocketSession
-
- getExtensions() - Method in class org.springframework.web.socket.handler.WebSocketSessionDecorator
-
- getExtensions() - Method in class org.springframework.web.socket.server.standard.ServerEndpointRegistration
-
- getExtensions() - Method in class org.springframework.web.socket.sockjs.client.WebSocketClientSockJsSession
-
- getExtensions() - Method in class org.springframework.web.socket.sockjs.client.XhrClientSockJsSession
-
- getExtensions() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractHttpSockJsSession
-
- getExtensions() - Method in class org.springframework.web.socket.sockjs.transport.session.WebSocketServerSockJsSession
-
- getExtensions() - Method in interface org.springframework.web.socket.WebSocketSession
-
Determine the negotiated extensions.
- getFirst(String) - Method in class org.springframework.web.socket.WebSocketHttpHeaders
-
Return the first header value for the given header name, if any.
- getFrameData() - Method in class org.springframework.web.socket.sockjs.frame.SockJsFrame
-
Return data contained in a SockJS "message" and "close" frames.
- getFrameFormat(ServerHttpRequest) - Method in class org.springframework.web.socket.sockjs.transport.handler.AbstractHttpSendingTransportHandler
-
- getFrameFormat(ServerHttpRequest) - Method in class org.springframework.web.socket.sockjs.transport.handler.EventSourceTransportHandler
-
- getFrameFormat(ServerHttpRequest) - Method in class org.springframework.web.socket.sockjs.transport.handler.HtmlFileTransportHandler
-
- getFrameFormat(ServerHttpRequest) - Method in class org.springframework.web.socket.sockjs.transport.handler.XhrPollingTransportHandler
-
- getFrameFormat(ServerHttpRequest) - Method in class org.springframework.web.socket.sockjs.transport.handler.XhrStreamingTransportHandler
-
- getHandler() - Method in class org.springframework.web.socket.handler.BeanCreatingHandlerProvider
-
- getHandlerInternal(HttpServletRequest) - Method in class org.springframework.web.socket.server.support.WebSocketHandlerMapping
-
- getHandlerMapping() - Method in class org.springframework.web.socket.config.annotation.ServletWebSocketHandlerRegistry
-
- getHandlerMapping() - Method in class org.springframework.web.socket.config.annotation.WebMvcStompEndpointRegistry
-
Return a handler mapping with the mapped ViewControllers.
- getHandlerType() - Method in class org.springframework.web.socket.handler.BeanCreatingHandlerProvider
-
- getHandshakeHandler() - Method in class org.springframework.web.socket.config.annotation.AbstractWebSocketHandlerRegistration
-
- getHandshakeHandler() - Method in class org.springframework.web.socket.server.support.WebSocketHttpRequestHandler
-
Return the HandshakeHandler.
- getHandshakeHandler() - Method in class org.springframework.web.socket.sockjs.transport.handler.WebSocketTransportHandler
-
- getHandshakeHeaders() - Method in class org.springframework.web.socket.adapter.jetty.JettyWebSocketSession
-
- getHandshakeHeaders() - Method in class org.springframework.web.socket.adapter.standard.StandardWebSocketSession
-
- getHandshakeHeaders() - Method in class org.springframework.web.socket.handler.WebSocketSessionDecorator
-
- getHandshakeHeaders() - Method in class org.springframework.web.socket.sockjs.client.AbstractClientSockJsSession
-
- getHandshakeHeaders() - Method in interface org.springframework.web.socket.sockjs.client.TransportRequest
-
Return the headers to send with the connect request.
- getHandshakeHeaders() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractHttpSockJsSession
-
- getHandshakeHeaders() - Method in class org.springframework.web.socket.sockjs.transport.session.WebSocketServerSockJsSession
-
- getHandshakeHeaders() - Method in interface org.springframework.web.socket.WebSocketSession
-
Return the headers used in the handshake request (never null
).
- getHandshakeInterceptors() - Method in class org.springframework.web.socket.server.support.WebSocketHttpRequestHandler
-
Return the configured WebSocket handshake request interceptors.
- getHandshakeInterceptors() - Method in class org.springframework.web.socket.sockjs.transport.TransportHandlingSockJsService
-
Return the configured WebSocket handshake request interceptors.
- getHeaderInitializer() - Method in class org.springframework.web.socket.messaging.StompSubProtocolHandler
-
Return the configured header initializer.
- getHeaders() - Method in class org.springframework.web.socket.client.WebSocketConnectionManager
-
Return the default headers for the WebSocket handshake request.
- getHeaders() - Method in class org.springframework.web.socket.sockjs.client.XhrClientSockJsSession
-
- getHeartbeatTime() - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService
-
Return the amount of time in milliseconds when the server has not sent
any messages.
- getHeartbeatTime() - Method in interface org.springframework.web.socket.sockjs.transport.SockJsServiceConfig
-
The amount of time in milliseconds when the server has not sent any
messages and after which the server should send a heartbeat frame to the
client in order to keep the connection from breaking.
- getHttpClient() - Method in class org.springframework.web.socket.sockjs.client.JettyXhrTransport
-
- getHttpClient() - Method in class org.springframework.web.socket.sockjs.client.UndertowXhrTransport
-
Return Undertow's native HTTP client.
- getHttpHeaderNames() - Method in class org.springframework.web.socket.sockjs.client.SockJsClient
-
The configured HTTP header names to be copied from the handshake
headers and also included in other HTTP requests.
- getHttpMessageCacheSize() - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService
-
Return the size of the HTTP message cache.
- getHttpMessageCacheSize() - Method in interface org.springframework.web.socket.sockjs.transport.SockJsServiceConfig
-
The number of server-to-client messages that a session can cache while waiting for
the next HTTP polling request from the client.
- getHttpMethod() - Method in enum org.springframework.web.socket.sockjs.transport.TransportType
-
- getHttpPollingSessions() - Method in interface org.springframework.web.socket.messaging.SubProtocolWebSocketHandler.Stats
-
- getHttpRequestHeaders() - Method in interface org.springframework.web.socket.sockjs.client.TransportRequest
-
Return the headers to add to all other HTTP requests besides the handshake
request such as XHR receive and send requests.
- getHttpServletRequest(ServerHttpRequest) - Method in class org.springframework.web.socket.server.standard.AbstractStandardUpgradeStrategy
-
- getHttpServletResponse(ServerHttpResponse) - Method in class org.springframework.web.socket.server.standard.AbstractStandardUpgradeStrategy
-
- getHttpStreamingSessions() - Method in interface org.springframework.web.socket.messaging.SubProtocolWebSocketHandler.Stats
-
- getId() - Method in class org.springframework.web.socket.adapter.jetty.JettyWebSocketSession
-
- getId() - Method in class org.springframework.web.socket.adapter.standard.StandardWebSocketSession
-
- getId() - Method in class org.springframework.web.socket.handler.WebSocketSessionDecorator
-
- getId() - Method in class org.springframework.web.socket.sockjs.client.AbstractClientSockJsSession
-
- getId() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession
-
- getId() - Method in interface org.springframework.web.socket.WebSocketSession
-
Return a unique session identifier.
- getInboundMessageSizeLimit() - Method in class org.springframework.web.socket.messaging.WebSocketStompClient
-
Get the configured inbound message buffer size in bytes.
- getInfoReceiver() - Method in class org.springframework.web.socket.sockjs.client.SockJsClient
-
Return the configured InfoReceiver
(never null
).
- getInfoUrl() - Method in class org.springframework.web.socket.sockjs.client.SockJsUrlInfo
-
- getInstalledExtensions(WebSocketContainer) - Method in class org.springframework.web.socket.server.standard.AbstractStandardUpgradeStrategy
-
- getInstalledExtensions(WebSocketContainer) - Method in class org.springframework.web.socket.server.standard.AbstractTyrusRequestUpgradeStrategy
-
- getInterceptors() - Method in class org.springframework.web.socket.config.annotation.AbstractWebSocketHandlerRegistration
-
- getInterceptors() - Method in class org.springframework.web.socket.config.annotation.WebMvcStompWebSocketEndpointRegistration
-
- getLastHandler() - Method in class org.springframework.web.socket.handler.WebSocketHandlerDecorator
-
- getLastSession() - Method in class org.springframework.web.socket.handler.WebSocketSessionDecorator
-
- getLimitExceededSessions() - Method in interface org.springframework.web.socket.messaging.SubProtocolWebSocketHandler.Stats
-
- getLocalAddress() - Method in class org.springframework.web.socket.adapter.jetty.JettyWebSocketSession
-
- getLocalAddress() - Method in class org.springframework.web.socket.adapter.standard.StandardWebSocketSession
-
- getLocalAddress() - Method in class org.springframework.web.socket.handler.WebSocketSessionDecorator
-
- getLocalAddress() - Method in class org.springframework.web.socket.sockjs.client.WebSocketClientSockJsSession
-
- getLocalAddress() - Method in class org.springframework.web.socket.sockjs.client.XhrClientSockJsSession
-
- getLocalAddress() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractHttpSockJsSession
-
- getLocalAddress() - Method in class org.springframework.web.socket.sockjs.transport.session.WebSocketServerSockJsSession
-
- getLocalAddress() - Method in interface org.springframework.web.socket.WebSocketSession
-
Return the address on which the request was received.
- getLoggingPeriod() - Method in class org.springframework.web.socket.config.WebSocketMessageBrokerStats
-
Return the configured logging period frequency in milliseconds.
- getMappings() - Method in class org.springframework.web.socket.config.annotation.AbstractWebSocketHandlerRegistration
-
- getMappings() - Method in class org.springframework.web.socket.config.annotation.WebMvcStompWebSocketEndpointRegistration
-
- getMaxBinaryMessageBufferSize() - Method in class org.springframework.web.socket.client.standard.WebSocketContainerFactoryBean
-
- getMaxBinaryMessageBufferSize() - Method in class org.springframework.web.socket.server.standard.ServletServerContainerFactoryBean
-
- getMaxSessionIdleTimeout() - Method in class org.springframework.web.socket.client.standard.WebSocketContainerFactoryBean
-
- getMaxSessionIdleTimeout() - Method in class org.springframework.web.socket.server.standard.ServletServerContainerFactoryBean
-
- getMaxTextMessageBufferSize() - Method in class org.springframework.web.socket.client.standard.WebSocketContainerFactoryBean
-
- getMaxTextMessageBufferSize() - Method in class org.springframework.web.socket.server.standard.ServletServerContainerFactoryBean
-
- getMessage() - Method in class org.springframework.web.socket.messaging.AbstractSubProtocolEvent
-
Return the Message associated with the event.
- getMessageCache() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractHttpSockJsSession
-
Return the SockJS buffer for messages stored transparently between polling
requests.
- getMessageCodec() - Method in class org.springframework.web.socket.sockjs.client.AbstractClientSockJsSession
-
- getMessageCodec() - Method in class org.springframework.web.socket.sockjs.client.SockJsClient
-
Return the SockJsMessageCodec to use.
- getMessageCodec() - Method in interface org.springframework.web.socket.sockjs.client.TransportRequest
-
Return the message codec to use for encoding SockJS messages.
- getMessageCodec() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession
-
- getMessageCodec() - Method in interface org.springframework.web.socket.sockjs.transport.SockJsServiceConfig
-
The codec to use for encoding and decoding SockJS messages.
- getMessageCodec() - Method in class org.springframework.web.socket.sockjs.transport.TransportHandlingSockJsService
-
- getMessageSizeLimit() - Method in class org.springframework.web.socket.config.annotation.WebSocketTransportRegistration
-
Protected accessor for internal use.
- getMessageSizeLimit() - Method in class org.springframework.web.socket.messaging.StompSubProtocolHandler
-
Get the configured message buffer size limit in bytes.
- getMessageType() - Method in class org.springframework.web.socket.adapter.standard.ConvertingEncoderDecoderSupport
-
Returns the websocket message type.
- getName() - Method in class org.springframework.web.socket.adapter.standard.WebSocketToStandardExtensionAdapter
-
- getName() - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService
-
Return the unique name associated with this service.
- getName() - Method in class org.springframework.web.socket.WebSocketExtension
-
Return the name of the extension (never null) or empty
.
- getNativeSession() - Method in class org.springframework.web.socket.adapter.AbstractWebSocketSession
-
- getNativeSession(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.
- 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.client.WebSocketClientSockJsSession
-
- getNativeSession(Class<T>) - Method in class org.springframework.web.socket.sockjs.client.WebSocketClientSockJsSession
-
- 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
-
- getNoMessagesReceivedSessions() - Method in interface org.springframework.web.socket.messaging.SubProtocolWebSocketHandler.Stats
-
- getObject() - Method in class org.springframework.web.socket.client.standard.WebSocketContainerFactoryBean
-
- getObject() - Method in class org.springframework.web.socket.server.standard.ServletServerContainerFactoryBean
-
- getObjectType() - Method in class org.springframework.web.socket.client.standard.WebSocketContainerFactoryBean
-
- getObjectType() - Method in class org.springframework.web.socket.server.standard.ServletServerContainerFactoryBean
-
- getOrder() - Method in class org.springframework.web.socket.config.annotation.ServletWebSocketHandlerRegistry
-
- getOrder() - Method in class org.springframework.web.socket.config.annotation.WebMvcStompEndpointRegistry
-
- getOrder() - Method in class org.springframework.web.socket.messaging.DefaultSimpUserRegistry
-
- getOrigin() - Method in class org.springframework.web.socket.client.WebSocketConnectionManager
-
Return the configured origin.
- getParameters() - Method in class org.springframework.web.socket.adapter.standard.WebSocketToStandardExtensionAdapter
-
- getParameters() - Method in class org.springframework.web.socket.WebSocketExtension
-
Return the parameters of the extension (never null
).
- getPath() - Method in class org.springframework.web.socket.server.standard.ServerEndpointRegistration
-
- getPayload() - Method in class org.springframework.web.socket.AbstractWebSocketMessage
-
Return the message payload (never null
).
- getPayload() - Method in interface org.springframework.web.socket.WebSocketMessage
-
Return the message payload (never null
).
- getPayloadLength() - Method in class org.springframework.web.socket.BinaryMessage
-
- getPayloadLength() - Method in class org.springframework.web.socket.PingMessage
-
- getPayloadLength() - Method in class org.springframework.web.socket.PongMessage
-
- getPayloadLength() - Method in class org.springframework.web.socket.TextMessage
-
- getPayloadLength() - Method in interface org.springframework.web.socket.WebSocketMessage
-
Return the number of bytes contained in the message.
- getPhase() - Method in class org.springframework.web.socket.client.ConnectionManagerSupport
-
Return the phase in which this endpoint connection factory will be auto-connected
and stopped.
- getPhase() - Method in class org.springframework.web.socket.messaging.WebSocketStompClient
-
Return the configured phase.
- getPrelude(ServerHttpRequest) - Method in class org.springframework.web.socket.sockjs.transport.session.StreamingSockJsSession
-
Get the prelude to write to the response before any other data.
- getPrincipal() - Method in class org.springframework.web.socket.adapter.jetty.JettyWebSocketSession
-
- getPrincipal() - Method in class org.springframework.web.socket.adapter.standard.StandardWebSocketSession
-
- getPrincipal() - Method in class org.springframework.web.socket.handler.WebSocketSessionDecorator
-
- getPrincipal() - Method in class org.springframework.web.socket.sockjs.client.AbstractClientSockJsSession
-
- getPrincipal() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractHttpSockJsSession
-
- getPrincipal() - Method in class org.springframework.web.socket.sockjs.transport.session.WebSocketServerSockJsSession
-
- getPrincipal() - Method in interface org.springframework.web.socket.WebSocketSession
-
Return a
Principal
instance containing the name
of the authenticated user.
- getProtocolHandlerMap() - Method in class org.springframework.web.socket.messaging.SubProtocolWebSocketHandler
-
Return the sub-protocols keyed by protocol name.
- getProtocolHandlers() - Method in class org.springframework.web.socket.messaging.SubProtocolWebSocketHandler
-
- getReason() - Method in class org.springframework.web.socket.CloseStatus
-
Return the reason, or null
if none.
- getRemoteAddress() - Method in class org.springframework.web.socket.adapter.jetty.JettyWebSocketSession
-
- getRemoteAddress() - Method in class org.springframework.web.socket.adapter.standard.StandardWebSocketSession
-
- getRemoteAddress() - Method in class org.springframework.web.socket.handler.WebSocketSessionDecorator
-
- getRemoteAddress() - Method in class org.springframework.web.socket.sockjs.client.WebSocketClientSockJsSession
-
- getRemoteAddress() - Method in class org.springframework.web.socket.sockjs.client.XhrClientSockJsSession
-
- getRemoteAddress() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractHttpSockJsSession
-
- getRemoteAddress() - Method in class org.springframework.web.socket.sockjs.transport.session.WebSocketServerSockJsSession
-
- getRemoteAddress() - Method in interface org.springframework.web.socket.WebSocketSession
-
Return the address of the remote client.
- getRequestUpgradeStrategy() - Method in class org.springframework.web.socket.server.support.AbstractHandshakeHandler
-
- getResponseStatus() - Method in class org.springframework.web.socket.sockjs.transport.handler.AbstractHttpReceivingTransportHandler
-
- getResponseStatus() - Method in class org.springframework.web.socket.sockjs.transport.handler.XhrReceivingTransportHandler
-
- getRestTemplate() - Method in class org.springframework.web.socket.sockjs.client.RestTemplateXhrTransport
-
Return the configured RestTemplate
.
- getSecWebSocketAccept() - Method in class org.springframework.web.socket.WebSocketHttpHeaders
-
Returns the value of the Sec-WebSocket-Accept
header.
- getSecWebSocketExtensions() - Method in class org.springframework.web.socket.WebSocketHttpHeaders
-
Returns the value of the Sec-WebSocket-Extensions
header.
- getSecWebSocketKey() - Method in class org.springframework.web.socket.WebSocketHttpHeaders
-
Returns the value of the Sec-WebSocket-Key
header.
- getSecWebSocketProtocol() - Method in class org.springframework.web.socket.WebSocketHttpHeaders
-
Returns the value of the Sec-WebSocket-Key
header.
- getSecWebSocketVersion() - Method in class org.springframework.web.socket.WebSocketHttpHeaders
-
Returns the value of the Sec-WebSocket-Version
header.
- getSendBufferSizeLimit() - Method in class org.springframework.web.socket.config.annotation.WebSocketTransportRegistration
-
Protected accessor for internal use.
- getSendBufferSizeLimit() - Method in class org.springframework.web.socket.messaging.SubProtocolWebSocketHandler
-
Return the buffer-size limit (number of bytes).
- getSendTimeLimit() - Method in class org.springframework.web.socket.config.annotation.WebSocketTransportRegistration
-
Protected accessor for internal use.
- getSendTimeLimit() - Method in class org.springframework.web.socket.handler.ConcurrentWebSocketSessionDecorator
-
Return the configured send-time limit (milliseconds).
- getSendTimeLimit() - Method in class org.springframework.web.socket.messaging.SubProtocolWebSocketHandler
-
Return the send-time limit (milliseconds).
- getServerContainer() - Method in class org.springframework.web.socket.server.standard.ServerEndpointExporter
-
- getServerId() - Method in class org.springframework.web.socket.sockjs.client.SockJsUrlInfo
-
- getServiceConfig() - Method in class org.springframework.web.socket.sockjs.transport.handler.AbstractTransportHandler
-
- getSessionId() - Method in class org.springframework.web.socket.messaging.SessionDisconnectEvent
-
Return the session id.
- getSessionId() - Method in class org.springframework.web.socket.sockjs.client.SockJsUrlInfo
-
- getSockJsClientLibraryUrl() - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService
-
Return he URL to the SockJS JavaScript client library.
- getSockJsConfig() - Method in class org.springframework.web.socket.sockjs.transport.handler.SockJsWebSocketHandler
-
- getSockJsService() - Method in class org.springframework.web.socket.config.annotation.SockJsServiceRegistration
-
- getSockJsService() - Method in class org.springframework.web.socket.sockjs.support.SockJsHttpRequestHandler
-
- getSockJsServiceConfig() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession
-
- getSockJsServiceRegistration() - Method in class org.springframework.web.socket.config.annotation.AbstractWebSocketHandlerRegistration
-
Expose the SockJsServiceRegistration
-- if SockJS is enabled or
null
otherwise -- so that it can be configured with a TaskScheduler
if the application did not provide one.
- getSockJsSessionId() - Method in exception org.springframework.web.socket.sockjs.SockJsException
-
Return the SockJS session id.
- getSockJsTaskSchedulerStatsInfo() - Method in class org.springframework.web.socket.config.WebSocketMessageBrokerStats
-
Get stats about the SockJS task scheduler.
- getSockJsUrl() - Method in class org.springframework.web.socket.sockjs.client.SockJsUrlInfo
-
- getSockJsUrlInfo() - Method in interface org.springframework.web.socket.sockjs.client.TransportRequest
-
Return information about the SockJS URL including server and session ID.
- getStats() - Method in class org.springframework.web.socket.messaging.StompSubProtocolHandler
-
Return a structured object with internal state and counters.
- getStats() - Method in class org.springframework.web.socket.messaging.SubProtocolWebSocketHandler
-
Return a structured object with various session counters.
- getStatsInfo() - Method in class org.springframework.web.socket.messaging.StompSubProtocolHandler
-
Return a String describing internal state and counters.
- getStatsInfo() - Method in class org.springframework.web.socket.messaging.SubProtocolWebSocketHandler
-
Return a String describing internal state and counters.
- getStatus() - Method in exception org.springframework.web.socket.handler.SessionLimitExceededException
-
- getStompBrokerRelayStatsInfo() - Method in class org.springframework.web.socket.config.WebSocketMessageBrokerStats
-
Get stats about STOMP broker relay (when using a full-featured STOMP broker).
- getStompSubProtocolStatsInfo() - Method in class org.springframework.web.socket.config.WebSocketMessageBrokerStats
-
Get stats about STOMP-related WebSocket message processing.
- getStreamBytesLimit() - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService
-
Return the minimum number of bytes that can be sent over a single HTTP
streaming request before it will be closed.
- getStreamBytesLimit() - Method in interface org.springframework.web.socket.sockjs.transport.SockJsServiceConfig
-
Streaming transports save responses on the client side and don't free
memory used by delivered messages.
- getSubProtocols() - Method in class org.springframework.web.socket.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 class org.springframework.web.socket.sockjs.transport.handler.SockJsWebSocketHandler
-
- getSubProtocols() - Method in interface org.springframework.web.socket.SubProtocolCapable
-
Return the list of supported sub-protocols.
- getSupportedExtensions(ServerHttpRequest) - Method in class org.springframework.web.socket.server.jetty.Jetty10RequestUpgradeStrategy
-
- getSupportedExtensions(ServerHttpRequest) - Method in class org.springframework.web.socket.server.jetty.JettyRequestUpgradeStrategy
-
- getSupportedExtensions(ServerHttpRequest) - Method in interface org.springframework.web.socket.server.RequestUpgradeStrategy
-
Return the WebSocket protocol extensions supported by the underlying WebSocket server.
- getSupportedExtensions(ServerHttpRequest) - Method in class org.springframework.web.socket.server.standard.AbstractStandardUpgradeStrategy
-
- getSupportedProtocols() - Method in class org.springframework.web.socket.messaging.StompSubProtocolHandler
-
- getSupportedProtocols() - Method in interface org.springframework.web.socket.messaging.SubProtocolHandler
-
Return the list of sub-protocols supported by this handler (never null
).
- getSupportedProtocols() - Method in class org.springframework.web.socket.server.support.AbstractHandshakeHandler
-
Return the list of supported sub-protocols.
- getSupportedVersions() - Method in class org.springframework.web.socket.server.jetty.Jetty10RequestUpgradeStrategy
-
- getSupportedVersions() - Method in class org.springframework.web.socket.server.jetty.JettyRequestUpgradeStrategy
-
- getSupportedVersions() - Method in interface org.springframework.web.socket.server.RequestUpgradeStrategy
-
Return the supported WebSocket protocol versions.
- getSupportedVersions() - Method in class org.springframework.web.socket.server.standard.AbstractTyrusRequestUpgradeStrategy
-
- getSupportedVersions() - Method in class org.springframework.web.socket.server.standard.TomcatRequestUpgradeStrategy
-
- getSupportedVersions() - Method in class org.springframework.web.socket.server.standard.UndertowRequestUpgradeStrategy
-
- getSupportedVersions() - Method in class org.springframework.web.socket.server.standard.WebSphereRequestUpgradeStrategy
-
- getSupportedVersions() - Method in class org.springframework.web.socket.server.support.AbstractHandshakeHandler
-
- 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
.
- getTaskExecutor() - Method in class org.springframework.web.socket.sockjs.client.RestTemplateXhrTransport
-
Return the configured TaskExecutor
.
- getTaskScheduler() - Method in class org.springframework.web.socket.config.annotation.SockJsServiceRegistration
-
Return the TaskScheduler, if configured.
- getTaskScheduler() - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService
-
A scheduler instance to use for scheduling heart-beat messages.
- getTaskScheduler() - Method in interface org.springframework.web.socket.sockjs.transport.SockJsServiceConfig
-
A scheduler instance to use for scheduling heart-beat messages.
- getTextMessageSizeLimit() - Method in class org.springframework.web.socket.adapter.jetty.JettyWebSocketSession
-
- getTextMessageSizeLimit() - Method in class org.springframework.web.socket.adapter.standard.StandardWebSocketSession
-
- getTextMessageSizeLimit() - Method in class org.springframework.web.socket.handler.WebSocketSessionDecorator
-
- getTextMessageSizeLimit() - Method in class org.springframework.web.socket.sockjs.client.WebSocketClientSockJsSession
-
- getTextMessageSizeLimit() - Method in class org.springframework.web.socket.sockjs.client.XhrClientSockJsSession
-
- getTextMessageSizeLimit() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractHttpSockJsSession
-
- getTextMessageSizeLimit() - Method in class org.springframework.web.socket.sockjs.transport.session.WebSocketServerSockJsSession
-
- getTextMessageSizeLimit() - Method in interface org.springframework.web.socket.WebSocketSession
-
Get the configured maximum size for an incoming text message.
- getTimeSinceLastActive() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession
-
- getTimeSinceLastActive() - Method in interface org.springframework.web.socket.sockjs.transport.SockJsSession
-
Return the time (in ms) since the session was last active, or otherwise
if the session is new, then the time since the session was created.
- getTimeSinceSendStarted() - Method in class org.springframework.web.socket.handler.ConcurrentWebSocketSessionDecorator
-
Return the time (milliseconds) since the current send started,
or 0 if no send is currently in progress.
- getTimeToFirstMessage() - Method in class org.springframework.web.socket.config.annotation.WebSocketTransportRegistration
-
Protected accessor for internal use.
- getTimeToFirstMessage() - Method in class org.springframework.web.socket.messaging.SubProtocolWebSocketHandler
-
Return the maximum time allowed after the WebSocket connection is
established and before the first sub-protocol message.
- getTotalConnect() - Method in interface org.springframework.web.socket.messaging.StompSubProtocolHandler.Stats
-
The number of CONNECT frames processed.
- getTotalConnected() - Method in interface org.springframework.web.socket.messaging.StompSubProtocolHandler.Stats
-
The number of CONNECTED frames processed.
- getTotalDisconnect() - Method in interface org.springframework.web.socket.messaging.StompSubProtocolHandler.Stats
-
The number of DISCONNECT frames processed.
- getTotalSessions() - Method in interface org.springframework.web.socket.messaging.SubProtocolWebSocketHandler.Stats
-
- getTransportErrorSessions() - Method in interface org.springframework.web.socket.messaging.SubProtocolWebSocketHandler.Stats
-
- getTransportHandlers() - Method in class org.springframework.web.socket.sockjs.transport.TransportHandlingSockJsService
-
Return the registered handlers per transport type.
- getTransportRegistration() - Method in class org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurationSupport
-
- getTransportType() - Method in class org.springframework.web.socket.sockjs.transport.handler.EventSourceTransportHandler
-
- getTransportType() - Method in class org.springframework.web.socket.sockjs.transport.handler.HtmlFileTransportHandler
-
- getTransportType() - Method in class org.springframework.web.socket.sockjs.transport.handler.WebSocketTransportHandler
-
- getTransportType() - Method in class org.springframework.web.socket.sockjs.transport.handler.XhrPollingTransportHandler
-
- getTransportType() - Method in class org.springframework.web.socket.sockjs.transport.handler.XhrReceivingTransportHandler
-
- getTransportType() - Method in class org.springframework.web.socket.sockjs.transport.handler.XhrStreamingTransportHandler
-
- getTransportType() - Method in interface org.springframework.web.socket.sockjs.transport.TransportHandler
-
Return the transport type supported by this handler.
- getTransportTypes() - Method in class org.springframework.web.socket.sockjs.client.AbstractXhrTransport
-
- getTransportTypes() - Method in interface org.springframework.web.socket.sockjs.client.Transport
-
Return the SockJS transport types that this transport can be used for.
- getTransportTypes() - Method in class org.springframework.web.socket.sockjs.client.WebSocketTransport
-
- getTransportUrl(TransportType) - Method in class org.springframework.web.socket.sockjs.client.SockJsUrlInfo
-
- getTransportUrl() - Method in interface org.springframework.web.socket.sockjs.client.TransportRequest
-
Return the transport URL for the given transport.
- getType() - Method in class org.springframework.web.socket.adapter.standard.ConvertingEncoderDecoderSupport
-
Returns the type being converted.
- getType() - Method in class org.springframework.web.socket.sockjs.frame.SockJsFrame
-
Return the SockJS frame type.
- getUndeliveredMessages() - Method in exception org.springframework.web.socket.sockjs.SockJsMessageDeliveryException
-
- getUri() - Method in class org.springframework.web.socket.adapter.jetty.JettyWebSocketSession
-
- getUri() - Method in class org.springframework.web.socket.adapter.standard.StandardWebSocketSession
-
- getUri() - Method in class org.springframework.web.socket.client.ConnectionManagerSupport
-
- getUri() - Method in class org.springframework.web.socket.handler.WebSocketSessionDecorator
-
- getUri() - Method in class org.springframework.web.socket.sockjs.client.AbstractClientSockJsSession
-
- getUri() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractHttpSockJsSession
-
- getUri() - Method in class org.springframework.web.socket.sockjs.transport.session.WebSocketServerSockJsSession
-
- getUri() - Method in interface org.springframework.web.socket.WebSocketSession
-
Return the URI used to open the WebSocket connection.
- getUrlPathHelper() - Method in class org.springframework.web.socket.config.annotation.ServletWebSocketHandlerRegistry
-
- getUrlPathHelper() - Method in class org.springframework.web.socket.config.annotation.WebMvcStompEndpointRegistry
-
- getUser() - Method in class org.springframework.web.socket.client.jetty.JettyWebSocketClient
-
- getUser() - Method in class org.springframework.web.socket.messaging.AbstractSubProtocolEvent
-
Return the user for the session associated with the event.
- getUser(String) - Method in class org.springframework.web.socket.messaging.DefaultSimpUserRegistry
-
- getUser() - Method in class org.springframework.web.socket.sockjs.client.SockJsClient
-
- getUser() - Method in interface org.springframework.web.socket.sockjs.client.TransportRequest
-
Return the user associated with the request, if any.
- getUserCount() - Method in class org.springframework.web.socket.messaging.DefaultSimpUserRegistry
-
- getUserProperties() - Method in class org.springframework.web.socket.client.standard.StandardWebSocketClient
-
The configured user properties.
- getUserProperties() - Method in class org.springframework.web.socket.server.standard.ServerEndpointRegistration
-
- getUsers() - Method in class org.springframework.web.socket.messaging.DefaultSimpUserRegistry
-
- getUuid() - Method in class org.springframework.web.socket.sockjs.client.SockJsUrlInfo
-
- getWebSocketClient() - Method in class org.springframework.web.socket.messaging.WebSocketStompClient
-
Return the configured WebSocketClient.
- getWebSocketClient() - Method in class org.springframework.web.socket.sockjs.client.WebSocketTransport
-
Return the configured WebSocketClient
.
- getWebSocketContainer() - Method in class org.springframework.web.socket.client.standard.AnnotatedEndpointConnectionManager
-
- getWebSocketContainer() - Method in class org.springframework.web.socket.client.standard.EndpointConnectionManager
-
- getWebSocketHandler() - Method in class org.springframework.web.socket.server.support.WebSocketHttpRequestHandler
-
Return the WebSocketHandler.
- getWebSocketHandler() - Method in class org.springframework.web.socket.sockjs.client.AbstractClientSockJsSession
-
- getWebSocketHandler() - Method in class org.springframework.web.socket.sockjs.support.SockJsHttpRequestHandler
-
- getWebSocketSessions() - Method in interface org.springframework.web.socket.messaging.SubProtocolWebSocketHandler.Stats
-
- getWebSocketSessionStatsInfo() - Method in class org.springframework.web.socket.config.WebSocketMessageBrokerStats
-
Get stats about WebSocket sessions.
- getWorker() - Method in class org.springframework.web.socket.sockjs.client.UndertowXhrTransport
-
Return the
XnioWorker
backing the I/O operations
for Undertow's HTTP client.
- GlassFishRequestUpgradeStrategy - Class in org.springframework.web.socket.server.standard
-
A WebSocket RequestUpgradeStrategy
for Oracle's GlassFish 4.1 and higher.
- GlassFishRequestUpgradeStrategy() - Constructor for class org.springframework.web.socket.server.standard.GlassFishRequestUpgradeStrategy
-
- GOING_AWAY - Static variable in class org.springframework.web.socket.CloseStatus
-
"1001 indicates that an endpoint is "going away", such as a server going down or a
browser having navigated away from a page."
- scheduleHeartbeat() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession
-
- SEC_WEBSOCKET_ACCEPT - Static variable in class org.springframework.web.socket.WebSocketHttpHeaders
-
- SEC_WEBSOCKET_EXTENSIONS - Static variable in class org.springframework.web.socket.WebSocketHttpHeaders
-
- SEC_WEBSOCKET_KEY - Static variable in class org.springframework.web.socket.WebSocketHttpHeaders
-
- SEC_WEBSOCKET_PROTOCOL - Static variable in class org.springframework.web.socket.WebSocketHttpHeaders
-
- SEC_WEBSOCKET_VERSION - Static variable in class org.springframework.web.socket.WebSocketHttpHeaders
-
- selectProtocol(List<String>, WebSocketHandler) - Method in class org.springframework.web.socket.server.support.AbstractHandshakeHandler
-
Perform the sub-protocol negotiation based on requested and supported sub-protocols.
- sendBinaryMessage(BinaryMessage) - Method in class org.springframework.web.socket.adapter.AbstractWebSocketSession
-
- sendBinaryMessage(BinaryMessage) - Method in class org.springframework.web.socket.adapter.jetty.JettyWebSocketSession
-
- sendBinaryMessage(BinaryMessage) - Method in class org.springframework.web.socket.adapter.standard.StandardWebSocketSession
-
- sendHeartbeat() - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession
-
- sendInternal(TextMessage) - Method in class org.springframework.web.socket.sockjs.client.AbstractClientSockJsSession
-
- sendInternal(TextMessage) - Method in class org.springframework.web.socket.sockjs.client.WebSocketClientSockJsSession
-
- sendInternal(TextMessage) - Method in class org.springframework.web.socket.sockjs.client.XhrClientSockJsSession
-
- sendMessage(WebSocketMessage<?>) - Method in class org.springframework.web.socket.adapter.AbstractWebSocketSession
-
- sendMessage(WebSocketMessage<?>) - Method in class org.springframework.web.socket.handler.ConcurrentWebSocketSessionDecorator
-
- sendMessage(WebSocketMessage<?>) - Method in class org.springframework.web.socket.handler.WebSocketSessionDecorator
-
- sendMessage(WebSocketMessage<?>) - Method in class org.springframework.web.socket.sockjs.client.AbstractClientSockJsSession
-
- sendMessage(WebSocketMessage<?>) - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractSockJsSession
-
- sendMessage(WebSocketMessage<?>) - Method in interface org.springframework.web.socket.WebSocketSession
-
- 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
-
- ServerEndpointExporter() - Constructor for class org.springframework.web.socket.server.standard.ServerEndpointExporter
-
- ServerEndpointRegistration - Class in org.springframework.web.socket.server.standard
-
- ServerEndpointRegistration(String, Endpoint) - Constructor for class org.springframework.web.socket.server.standard.ServerEndpointRegistration
-
- ServerEndpointRegistration(String, Class<? extends Endpoint>) - Constructor for class org.springframework.web.socket.server.standard.ServerEndpointRegistration
-
- 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
-
- ServletServerContainerFactoryBean() - Constructor for class org.springframework.web.socket.server.standard.ServletServerContainerFactoryBean
-
- ServletWebSocketHandlerRegistration - Class in org.springframework.web.socket.config.annotation
-
A helper class for configuring
WebSocketHandler
request handling
including SockJS fallback options.
- ServletWebSocketHandlerRegistration() - Constructor for class org.springframework.web.socket.config.annotation.ServletWebSocketHandlerRegistration
-
- ServletWebSocketHandlerRegistry - Class in org.springframework.web.socket.config.annotation
-
- ServletWebSocketHandlerRegistry() - Constructor for class org.springframework.web.socket.config.annotation.ServletWebSocketHandlerRegistry
-
- SESSION_NOT_RELIABLE - Static variable in class org.springframework.web.socket.CloseStatus
-
A status code for use within the framework the indicate a session has
become unreliable (e.g.
- SessionConnectedEvent - Class in org.springframework.web.socket.messaging
-
A connected event represents the server response to a client's connect request.
- SessionConnectedEvent(Object, Message<byte[]>) - Constructor for class org.springframework.web.socket.messaging.SessionConnectedEvent
-
Create a new SessionConnectedEvent.
- SessionConnectedEvent(Object, Message<byte[]>, Principal) - Constructor for class org.springframework.web.socket.messaging.SessionConnectedEvent
-
- SessionConnectEvent - Class in org.springframework.web.socket.messaging
-
Event raised when a new WebSocket client using a Simple Messaging Protocol
(e.g.
- SessionConnectEvent(Object, Message<byte[]>) - Constructor for class org.springframework.web.socket.messaging.SessionConnectEvent
-
Create a new SessionConnectEvent.
- SessionConnectEvent(Object, Message<byte[]>, Principal) - Constructor for class org.springframework.web.socket.messaging.SessionConnectEvent
-
- SessionDisconnectEvent - Class in org.springframework.web.socket.messaging
-
Event raised when the session of a WebSocket client using a Simple Messaging
Protocol (e.g.
- SessionDisconnectEvent(Object, Message<byte[]>, String, CloseStatus) - Constructor for class org.springframework.web.socket.messaging.SessionDisconnectEvent
-
Create a new SessionDisconnectEvent.
- SessionDisconnectEvent(Object, Message<byte[]>, String, CloseStatus, Principal) - Constructor for class org.springframework.web.socket.messaging.SessionDisconnectEvent
-
Create a new SessionDisconnectEvent.
- SessionLimitExceededException - Exception in org.springframework.web.socket.handler
-
Raised when a WebSocket session has exceeded limits it has been configured
for, e.g.
- SessionLimitExceededException(String, CloseStatus) - Constructor for exception org.springframework.web.socket.handler.SessionLimitExceededException
-
- SessionSubscribeEvent - Class in org.springframework.web.socket.messaging
-
Event raised when a new WebSocket client using a Simple Messaging Protocol
(e.g.
- SessionSubscribeEvent(Object, Message<byte[]>) - Constructor for class org.springframework.web.socket.messaging.SessionSubscribeEvent
-
- SessionSubscribeEvent(Object, Message<byte[]>, Principal) - Constructor for class org.springframework.web.socket.messaging.SessionSubscribeEvent
-
- SessionUnsubscribeEvent - Class in org.springframework.web.socket.messaging
-
Event raised when a new WebSocket client using a Simple Messaging Protocol
(e.g.
- SessionUnsubscribeEvent(Object, Message<byte[]>) - Constructor for class org.springframework.web.socket.messaging.SessionUnsubscribeEvent
-
- SessionUnsubscribeEvent(Object, Message<byte[]>, Principal) - Constructor for class org.springframework.web.socket.messaging.SessionUnsubscribeEvent
-
- set(String, String) - Method in class org.springframework.web.socket.WebSocketHttpHeaders
-
Set the given, single header value under the given name.
- setAcceptedProtocol(String) - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractHttpSockJsSession
-
Unlike WebSocket where sub-protocol negotiation is part of the initial
handshake, in HTTP transports the same negotiation must be emulated and
the selected protocol set through this setter.
- setAll(Map<String, String>) - Method in class org.springframework.web.socket.WebSocketHttpHeaders
-
- setAllowedOriginPatterns(String...) - Method in class org.springframework.web.socket.config.annotation.AbstractWebSocketHandlerRegistration
-
- setAllowedOriginPatterns(String...) - Method in class org.springframework.web.socket.config.annotation.SockJsServiceRegistration
-
Configure allowed Origin
pattern header values.
- setAllowedOriginPatterns(String...) - Method in interface org.springframework.web.socket.config.annotation.StompWebSocketEndpointRegistration
-
- setAllowedOriginPatterns(String...) - Method in class org.springframework.web.socket.config.annotation.WebMvcStompWebSocketEndpointRegistration
-
- setAllowedOriginPatterns(String...) - Method in interface org.springframework.web.socket.config.annotation.WebSocketHandlerRegistration
-
- setAllowedOriginPatterns(Collection<String>) - Method in class org.springframework.web.socket.server.support.OriginHandshakeInterceptor
-
- setAllowedOriginPatterns(Collection<String>) - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService
-
- setAllowedOrigins(String...) - Method in class org.springframework.web.socket.config.annotation.AbstractWebSocketHandlerRegistration
-
- setAllowedOrigins(String...) - Method in class org.springframework.web.socket.config.annotation.SockJsServiceRegistration
-
Configure allowed Origin
header values.
- setAllowedOrigins(String...) - Method in interface org.springframework.web.socket.config.annotation.StompWebSocketEndpointRegistration
-
Configure allowed Origin
header values.
- setAllowedOrigins(String...) - Method in class org.springframework.web.socket.config.annotation.WebMvcStompWebSocketEndpointRegistration
-
- setAllowedOrigins(String...) - Method in interface org.springframework.web.socket.config.annotation.WebSocketHandlerRegistration
-
Configure allowed Origin
header values.
- setAllowedOrigins(Collection<String>) - Method in class org.springframework.web.socket.server.support.OriginHandshakeInterceptor
-
Configure allowed Origin
header values.
- setAllowedOrigins(Collection<String>) - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService
-
Configure allowed Origin
header values.
- setAnnotatedEndpointClasses(Class<?>...) - Method in class org.springframework.web.socket.server.standard.ServerEndpointExporter
-
Explicitly list annotated endpoint types that should be registered on startup.
- setApplicationContext(ApplicationContext) - Method in class org.springframework.web.socket.config.annotation.WebMvcStompEndpointRegistry
-
- setApplicationEventPublisher(ApplicationEventPublisher) - Method in class org.springframework.web.socket.messaging.StompSubProtocolHandler
-
- setAsyncSendTimeout(long) - Method in class org.springframework.web.socket.client.standard.WebSocketContainerFactoryBean
-
- setAsyncSendTimeout(Long) - Method in class org.springframework.web.socket.server.standard.ServletServerContainerFactoryBean
-
- setAutoStartup(boolean) - Method in class org.springframework.web.socket.client.ConnectionManagerSupport
-
Set whether to auto-connect to the remote endpoint after this connection manager
has been initialized and the Spring context has been refreshed.
- setAutoStartup(boolean) - Method in class org.springframework.web.socket.messaging.WebSocketStompClient
-
Set whether to auto-start the contained WebSocketClient when the Spring
context has been refreshed.
- setBeanFactory(BeanFactory) - Method in class org.springframework.web.socket.client.standard.AnnotatedEndpointConnectionManager
-
- setBeanFactory(BeanFactory) - Method in class org.springframework.web.socket.client.standard.EndpointConnectionManager
-
- setBeanFactory(BeanFactory) - Method in class org.springframework.web.socket.handler.BeanCreatingHandlerProvider
-
- setBeanFactory(BeanFactory) - Method in class org.springframework.web.socket.handler.PerConnectionWebSocketHandler
-
- setBeanFactory(BeanFactory) - Method in class org.springframework.web.socket.server.standard.ServerEndpointRegistration
-
- setBinaryMessageSizeLimit(int) - Method in class org.springframework.web.socket.adapter.jetty.JettyWebSocketSession
-
This method is a no-op for Jetty.
- setBinaryMessageSizeLimit(int) - Method in class org.springframework.web.socket.adapter.standard.StandardWebSocketSession
-
- setBinaryMessageSizeLimit(int) - Method in class org.springframework.web.socket.handler.WebSocketSessionDecorator
-
- setBinaryMessageSizeLimit(int) - Method in class org.springframework.web.socket.sockjs.client.WebSocketClientSockJsSession
-
- setBinaryMessageSizeLimit(int) - Method in class org.springframework.web.socket.sockjs.client.XhrClientSockJsSession
-
- setBinaryMessageSizeLimit(int) - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractHttpSockJsSession
-
- setBinaryMessageSizeLimit(int) - Method in class org.springframework.web.socket.sockjs.transport.session.WebSocketServerSockJsSession
-
- setBinaryMessageSizeLimit(int) - Method in interface org.springframework.web.socket.WebSocketSession
-
Configure the maximum size for an incoming binary message.
- setClientLibraryUrl(String) - Method in class org.springframework.web.socket.config.annotation.SockJsServiceRegistration
-
Transports with no native cross-domain communication (e.g.
- setConfigurator(ClientEndpointConfig.Configurator) - Method in class org.springframework.web.socket.client.standard.EndpointConnectionManager
-
- setConfigurers(List<WebSocketConfigurer>) - Method in class org.springframework.web.socket.config.annotation.DelegatingWebSocketConfiguration
-
- setConfigurers(List<WebSocketMessageBrokerConfigurer>) - Method in class org.springframework.web.socket.config.annotation.DelegatingWebSocketMessageBrokerConfiguration
-
- setConnectTimeoutScheduler(TaskScheduler) - Method in class org.springframework.web.socket.sockjs.client.SockJsClient
-
Configure a TaskScheduler
for scheduling a connect timeout task
where the timeout value is calculated based on the duration of the initial
SockJS "Info" request.
- setCopyAllAttributes(boolean) - Method in class org.springframework.web.socket.server.support.HttpSessionHandshakeInterceptor
-
Whether to copy all attributes from the HTTP session.
- setCopyHttpSessionId(boolean) - Method in class org.springframework.web.socket.server.support.HttpSessionHandshakeInterceptor
-
- setCreateSession(boolean) - Method in class org.springframework.web.socket.server.support.HttpSessionHandshakeInterceptor
-
Whether to allow the HTTP session to be created while accessing it.
- setDecoder(StompDecoder) - Method in class org.springframework.web.socket.messaging.StompSubProtocolHandler
-
Configure a StompDecoder
for decoding STOMP frames.
- setDecoders(List<Class<? extends Decoder>>) - Method in class org.springframework.web.socket.client.standard.EndpointConnectionManager
-
- setDecoders(List<Class<? extends Decoder>>) - Method in class org.springframework.web.socket.server.standard.ServerEndpointRegistration
-
- setDecoratorFactories(WebSocketHandlerDecoratorFactory...) - Method in class org.springframework.web.socket.config.annotation.WebSocketTransportRegistration
-
Configure one or more factories to decorate the handler used to process
WebSocket messages.
- setDefaultProtocolHandler(SubProtocolHandler) - Method in class org.springframework.web.socket.messaging.SubProtocolWebSocketHandler
-
- setDisconnectDelay(long) - Method in class org.springframework.web.socket.config.annotation.SockJsServiceRegistration
-
The amount of time in milliseconds before a client is considered
disconnected after not having a receiving connection, i.e.
- setDisconnectDelay(long) - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService
-
The amount of time in milliseconds before a client is considered
disconnected after not having a receiving connection, i.e.
- setEncoder(StompEncoder) - Method in class org.springframework.web.socket.messaging.StompSubProtocolHandler
-
Configure a StompEncoder
for encoding STOMP frames.
- setEncoders(List<Class<? extends Encoder>>) - Method in class org.springframework.web.socket.client.standard.EndpointConnectionManager
-
- setEncoders(List<Class<? extends Encoder>>) - Method in class org.springframework.web.socket.server.standard.ServerEndpointRegistration
-
- setErrorHandler(StompSubProtocolErrorHandler) - Method in interface org.springframework.web.socket.config.annotation.StompEndpointRegistry
-
Configure a handler for customizing or handling STOMP ERROR frames to clients.
- setErrorHandler(StompSubProtocolErrorHandler) - Method in class org.springframework.web.socket.config.annotation.WebMvcStompEndpointRegistry
-
- setErrorHandler(StompSubProtocolErrorHandler) - Method in class org.springframework.web.socket.messaging.StompSubProtocolHandler
-
Configure a handler for error messages sent to clients which allows
customizing the error messages or preventing them from being sent.
- setExtensions(Extension...) - Method in class org.springframework.web.socket.client.standard.EndpointConnectionManager
-
- setExtensions(List<Extension>) - Method in class org.springframework.web.socket.server.standard.ServerEndpointRegistration
-
- setHandshakeHandler(HandshakeHandler) - Method in class org.springframework.web.socket.config.annotation.AbstractWebSocketHandlerRegistration
-
- setHandshakeHandler(HandshakeHandler) - Method in interface org.springframework.web.socket.config.annotation.StompWebSocketEndpointRegistration
-
Configure the HandshakeHandler to use.
- setHandshakeHandler(HandshakeHandler) - Method in class org.springframework.web.socket.config.annotation.WebMvcStompWebSocketEndpointRegistration
-
- setHandshakeHandler(HandshakeHandler) - Method in interface org.springframework.web.socket.config.annotation.WebSocketHandlerRegistration
-
Configure the HandshakeHandler to use.
- setHandshakeInterceptors(List<HandshakeInterceptor>) - Method in class org.springframework.web.socket.server.support.WebSocketHttpRequestHandler
-
Configure one or more WebSocket handshake request interceptors.
- setHandshakeInterceptors(List<HandshakeInterceptor>) - Method in class org.springframework.web.socket.sockjs.transport.TransportHandlingSockJsService
-
Configure one or more WebSocket handshake request interceptors.
- setHeaderInitializer(MessageHeaderInitializer) - Method in class org.springframework.web.socket.messaging.StompSubProtocolHandler
-
Configure a MessageHeaderInitializer
to apply to the headers of all
messages created from decoded STOMP frames and other messages sent to the
client inbound channel.
- setHeaders(HttpHeaders) - Method in class org.springframework.web.socket.client.WebSocketConnectionManager
-
Provide default headers to add to the WebSocket handshake request.
- setHeartbeatTime(long) - Method in class org.springframework.web.socket.config.annotation.SockJsServiceRegistration
-
The amount of time in milliseconds when the server has not sent any
messages and after which the server should send a heartbeat frame to the
client in order to keep the connection from breaking.
- setHeartbeatTime(long) - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService
-
Specify the amount of time in milliseconds when the server has not sent
any messages and after which the server should send a heartbeat frame
to the client in order to keep the connection from breaking.
- setHttpHeaderNames(String...) - Method in class org.springframework.web.socket.sockjs.client.SockJsClient
-
- setHttpMessageCacheSize(int) - Method in class org.springframework.web.socket.config.annotation.SockJsServiceRegistration
-
The number of server-to-client messages that a session can cache while waiting for
the next HTTP polling request from the client.
- setHttpMessageCacheSize(int) - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService
-
The number of server-to-client messages that a session can cache while waiting
for the next HTTP polling request from the client.
- setInboundChannelExecutor(TaskExecutor) - Method in class org.springframework.web.socket.config.WebSocketMessageBrokerStats
-
- setInboundMessageSizeLimit(int) - Method in class org.springframework.web.socket.messaging.WebSocketStompClient
-
Configure the maximum size allowed for inbound STOMP message.
- setInfoReceiver(InfoReceiver) - Method in class org.springframework.web.socket.sockjs.client.SockJsClient
-
Configure the InfoReceiver
to use to perform the SockJS "Info"
request before the SockJS session starts.
- setInterceptors(HandshakeInterceptor...) - Method in class org.springframework.web.socket.config.annotation.SockJsServiceRegistration
-
- setLoggingPeriod(long) - Method in class org.springframework.web.socket.config.WebSocketMessageBrokerStats
-
Set the frequency for logging information at INFO level in milliseconds.
- setMaxBinaryMessageBufferSize(int) - Method in class org.springframework.web.socket.client.standard.WebSocketContainerFactoryBean
-
- setMaxBinaryMessageBufferSize(Integer) - Method in class org.springframework.web.socket.server.standard.ServletServerContainerFactoryBean
-
- setMaxSessionIdleTimeout(long) - Method in class org.springframework.web.socket.client.standard.WebSocketContainerFactoryBean
-
- setMaxSessionIdleTimeout(Long) - Method in class org.springframework.web.socket.server.standard.ServletServerContainerFactoryBean
-
- setMaxTextMessageBufferSize(int) - Method in class org.springframework.web.socket.client.standard.WebSocketContainerFactoryBean
-
- setMaxTextMessageBufferSize(Integer) - Method in class org.springframework.web.socket.server.standard.ServletServerContainerFactoryBean
-
- setMessageCallback(Consumer<WebSocketMessage<?>>) - Method in class org.springframework.web.socket.handler.ConcurrentWebSocketSessionDecorator
-
Set a callback invoked after a message is added to the send buffer.
- setMessageCodec(SockJsMessageCodec) - Method in class org.springframework.web.socket.config.annotation.SockJsServiceRegistration
-
The codec to use for encoding and decoding SockJS messages.
- setMessageCodec(SockJsMessageCodec) - Method in class org.springframework.web.socket.sockjs.client.SockJsClient
-
Set the SockJsMessageCodec to use.
- setMessageCodec(SockJsMessageCodec) - Method in class org.springframework.web.socket.sockjs.transport.TransportHandlingSockJsService
-
The codec to use for encoding and decoding SockJS messages.
- setMessageSizeLimit(int) - Method in class org.springframework.web.socket.config.annotation.WebSocketTransportRegistration
-
Configure the maximum size of an inbound sub-protocol message, such as
a STOMP frame which may be aggregated from multiple WebSocket messages.
- setMessageSizeLimit(int) - Method in class org.springframework.web.socket.messaging.StompSubProtocolHandler
-
Configure the maximum size allowed for an incoming STOMP message.
- setName(String) - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService
-
Set a unique name for this service (mainly for logging purposes).
- setOrder(int) - Method in class org.springframework.web.socket.config.annotation.ServletWebSocketHandlerRegistry
-
Set the order for the resulting SimpleUrlHandlerMapping
relative to
other handler mappings configured in Spring MVC.
- setOrder(int) - Method in interface org.springframework.web.socket.config.annotation.StompEndpointRegistry
-
Set the order of the HandlerMapping
used for STOMP endpoints relative to other Spring MVC handler mappings.
- setOrder(int) - Method in class org.springframework.web.socket.config.annotation.WebMvcStompEndpointRegistry
-
Set the order for the resulting
HandlerMapping
relative to other handler mappings configured in Spring MVC.
- setOrder(int) - Method in class org.springframework.web.socket.messaging.DefaultSimpUserRegistry
-
Specify the order value for this registry.
- setOrigin(String) - Method in class org.springframework.web.socket.client.WebSocketConnectionManager
-
Set the origin to use.
- setOutboundChannelExecutor(TaskExecutor) - Method in class org.springframework.web.socket.config.WebSocketMessageBrokerStats
-
- setPhase(int) - Method in class org.springframework.web.socket.client.ConnectionManagerSupport
-
Specify the phase in which a connection should be established to the remote
endpoint and subsequently closed.
- setPhase(int) - Method in class org.springframework.web.socket.messaging.WebSocketStompClient
-
Specify the phase in which the WebSocket client should be started and
subsequently closed.
- setProtocolHandlers(List<SubProtocolHandler>) - Method in class org.springframework.web.socket.messaging.SubProtocolWebSocketHandler
-
Configure one or more handlers to use depending on the sub-protocol requested by
the client in the WebSocket handshake request.
- setSecWebSocketAccept(String) - Method in class org.springframework.web.socket.WebSocketHttpHeaders
-
Sets the (new) value of the Sec-WebSocket-Accept
header.
- setSecWebSocketExtensions(List<WebSocketExtension>) - Method in class org.springframework.web.socket.WebSocketHttpHeaders
-
Sets the (new) value(s) of the Sec-WebSocket-Extensions
header.
- setSecWebSocketKey(String) - Method in class org.springframework.web.socket.WebSocketHttpHeaders
-
Sets the (new) value of the Sec-WebSocket-Key
header.
- setSecWebSocketProtocol(String) - Method in class org.springframework.web.socket.WebSocketHttpHeaders
-
Sets the (new) value of the Sec-WebSocket-Protocol
header.
- setSecWebSocketProtocol(List<String>) - Method in class org.springframework.web.socket.WebSocketHttpHeaders
-
Sets the (new) value of the Sec-WebSocket-Protocol
header.
- setSecWebSocketVersion(String) - Method in class org.springframework.web.socket.WebSocketHttpHeaders
-
Sets the (new) value of the Sec-WebSocket-Version
header.
- setSendBufferSizeLimit(int) - Method in class org.springframework.web.socket.config.annotation.WebSocketTransportRegistration
-
Configure the maximum amount of data to buffer when sending messages
to a WebSocket session, or an HTTP response when SockJS fallback
option are in use.
- setSendBufferSizeLimit(int) - Method in class org.springframework.web.socket.messaging.SubProtocolWebSocketHandler
-
Specify the buffer-size limit (number of bytes).
- setSendTimeLimit(int) - Method in class org.springframework.web.socket.config.annotation.WebSocketTransportRegistration
-
Configure a time limit (in milliseconds) for the maximum amount of a time
allowed when sending messages to a WebSocket session or writing to an
HTTP response when SockJS fallback option are in use.
- setSendTimeLimit(int) - Method in class org.springframework.web.socket.messaging.SubProtocolWebSocketHandler
-
Specify the send-time limit (milliseconds).
- setServerContainer(ServerContainer) - Method in class org.springframework.web.socket.server.standard.ServerEndpointExporter
-
- setServletContext(ServletContext) - Method in class org.springframework.web.socket.server.jetty.JettyRequestUpgradeStrategy
-
- setServletContext(ServletContext) - Method in class org.springframework.web.socket.server.standard.ServletServerContainerFactoryBean
-
- setServletContext(ServletContext) - Method in class org.springframework.web.socket.server.support.DefaultHandshakeHandler
-
- setServletContext(ServletContext) - Method in class org.springframework.web.socket.server.support.WebSocketHttpRequestHandler
-
- setServletContext(ServletContext) - Method in class org.springframework.web.socket.sockjs.support.SockJsHttpRequestHandler
-
- setServletContext(ServletContext) - Method in class org.springframework.web.socket.sockjs.transport.handler.DefaultSockJsService
-
- setServletContext(ServletContext) - Method in class org.springframework.web.socket.sockjs.transport.handler.WebSocketTransportHandler
-
- setSessionCookieNeeded(boolean) - Method in class org.springframework.web.socket.config.annotation.SockJsServiceRegistration
-
The SockJS protocol requires a server to respond to the initial "/info" request
from clients with a "cookie_needed" boolean property that indicates whether the use
of a JSESSIONID cookie is required for the application to function correctly, e.g.
- setSessionCookieNeeded(boolean) - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService
-
The SockJS protocol requires a server to respond to an initial "/info" request from
clients with a "cookie_needed" boolean property that indicates whether the use of a
JSESSIONID cookie is required for the application to function correctly, e.g.
- setSockJsClientLibraryUrl(String) - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService
-
Transports with no native cross-domain communication (e.g.
- setSockJsTaskScheduler(TaskScheduler) - Method in class org.springframework.web.socket.config.WebSocketMessageBrokerStats
-
- setStompBrokerRelay(StompBrokerRelayMessageHandler) - Method in class org.springframework.web.socket.config.WebSocketMessageBrokerStats
-
- setStreamBytesLimit(int) - Method in class org.springframework.web.socket.config.annotation.SockJsServiceRegistration
-
Streaming transports save responses on the client side and don't free
memory used by delivered messages.
- setStreamBytesLimit(int) - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService
-
Streaming transports save responses on the client side and don't free
memory used by delivered messages.
- setSubProtocols(List<String>) - Method in class org.springframework.web.socket.client.WebSocketConnectionManager
-
Set the sub-protocols to use.
- setSubprotocols(List<String>) - Method in class org.springframework.web.socket.server.standard.ServerEndpointRegistration
-
- setSubProtocolWebSocketHandler(SubProtocolWebSocketHandler) - Method in class org.springframework.web.socket.config.WebSocketMessageBrokerStats
-
- setSupportedProtocols(String...) - Method in class org.springframework.web.socket.client.standard.EndpointConnectionManager
-
- setSupportedProtocols(String...) - Method in class org.springframework.web.socket.server.support.AbstractHandshakeHandler
-
Use this property to configure the list of supported sub-protocols.
- setSuppressCors(boolean) - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService
-
This option can be used to disable automatic addition of CORS headers for
SockJS requests.
- setSupressCors(boolean) - Method in class org.springframework.web.socket.config.annotation.SockJsServiceRegistration
-
This option can be used to disable automatic addition of CORS headers for
SockJS requests.
- setTaskExecutor(AsyncListenableTaskExecutor) - Method in class org.springframework.web.socket.client.jetty.JettyWebSocketClient
-
Set an AsyncListenableTaskExecutor
to use when opening connections.
- setTaskExecutor(TaskExecutor) - Method in class org.springframework.web.socket.client.standard.AnnotatedEndpointConnectionManager
-
Set a TaskExecutor
to use to open the connection.
- setTaskExecutor(TaskExecutor) - Method in class org.springframework.web.socket.client.standard.EndpointConnectionManager
-
Set a TaskExecutor
to use to open connections.
- setTaskExecutor(AsyncListenableTaskExecutor) - Method in class org.springframework.web.socket.client.standard.StandardWebSocketClient
-
Set an AsyncListenableTaskExecutor
to use when opening connections.
- setTaskExecutor(TaskExecutor) - Method in class org.springframework.web.socket.sockjs.client.RestTemplateXhrTransport
-
Configure the TaskExecutor
to use to execute XHR receive requests.
- setTaskScheduler(TaskScheduler) - Method in class org.springframework.web.socket.config.annotation.ServletWebSocketHandlerRegistry
-
Provide the TaskScheduler to use for SockJS endpoints for which a task
scheduler has not been explicitly registered.
- setTaskScheduler(TaskScheduler) - Method in class org.springframework.web.socket.config.annotation.SockJsServiceRegistration
-
A scheduler instance to use for scheduling SockJS heart-beats.
- setTaskScheduler(TaskScheduler) - Method in class org.springframework.web.socket.messaging.WebSocketStompClient
- setTextMessageSizeLimit(int) - Method in class org.springframework.web.socket.adapter.jetty.JettyWebSocketSession
-
This method is a no-op for Jetty.
- setTextMessageSizeLimit(int) - Method in class org.springframework.web.socket.adapter.standard.StandardWebSocketSession
-
- setTextMessageSizeLimit(int) - Method in class org.springframework.web.socket.handler.WebSocketSessionDecorator
-
- setTextMessageSizeLimit(int) - Method in class org.springframework.web.socket.sockjs.client.WebSocketClientSockJsSession
-
- setTextMessageSizeLimit(int) - Method in class org.springframework.web.socket.sockjs.client.XhrClientSockJsSession
-
- setTextMessageSizeLimit(int) - Method in class org.springframework.web.socket.sockjs.transport.session.AbstractHttpSockJsSession
-
- setTextMessageSizeLimit(int) - Method in class org.springframework.web.socket.sockjs.transport.session.WebSocketServerSockJsSession
-
- setTextMessageSizeLimit(int) - Method in interface org.springframework.web.socket.WebSocketSession
-
Configure the maximum size for an incoming text message.
- setTimeToFirstMessage(int) - Method in class org.springframework.web.socket.config.annotation.WebSocketTransportRegistration
-
Set the maximum time allowed in milliseconds after the WebSocket connection
is established and before the first sub-protocol message is received.
- setTimeToFirstMessage(int) - Method in class org.springframework.web.socket.messaging.SubProtocolWebSocketHandler
-
Set the maximum time allowed in milliseconds after the WebSocket connection
is established and before the first sub-protocol message is received.
- setTransportHandlerOverrides(TransportHandler...) - Method in class org.springframework.web.socket.config.annotation.SockJsServiceRegistration
-
- setTransportHandlers(TransportHandler...) - Method in class org.springframework.web.socket.config.annotation.SockJsServiceRegistration
-
- setUrlPathHelper(UrlPathHelper) - Method in class org.springframework.web.socket.config.annotation.ServletWebSocketHandlerRegistry
-
Set the UrlPathHelper to configure on the SimpleUrlHandlerMapping
used to map handshake requests.
- setUrlPathHelper(UrlPathHelper) - Method in interface org.springframework.web.socket.config.annotation.StompEndpointRegistry
-
Configure a customized UrlPathHelper
for the STOMP endpoint
HandlerMapping
.
- setUrlPathHelper(UrlPathHelper) - Method in class org.springframework.web.socket.config.annotation.WebMvcStompEndpointRegistry
-
Set the UrlPathHelper to configure on the HandlerMapping
used to map handshake requests.
- setUserProperties(Map<String, Object>) - Method in class org.springframework.web.socket.client.standard.StandardWebSocketClient
-
The standard Java WebSocket API allows passing "user properties" to the
server via
userProperties
.
- setUserProperties(Map<String, Object>) - Method in class org.springframework.web.socket.server.standard.ServerEndpointRegistration
-
- setWebSocketContainer(WebSocketContainer) - Method in class org.springframework.web.socket.client.standard.AnnotatedEndpointConnectionManager
-
- setWebSocketContainer(WebSocketContainer) - Method in class org.springframework.web.socket.client.standard.EndpointConnectionManager
-
- setWebSocketEnabled(boolean) - Method in class org.springframework.web.socket.config.annotation.SockJsServiceRegistration
-
Some load balancers don't support WebSocket.
- setWebSocketEnabled(boolean) - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService
-
Some load balancers do not support WebSocket.
- setWebSocketUpgradeMatch(boolean) - Method in class org.springframework.web.socket.server.support.WebSocketHandlerMapping
-
- setXhrStreamingDisabled(boolean) - Method in class org.springframework.web.socket.sockjs.client.AbstractXhrTransport
-
An XhrTransport
can support both the "xhr_streaming" and "xhr"
SockJS server transports.
- shouldSuppressCors() - Method in class org.springframework.web.socket.sockjs.support.AbstractSockJsService
-
Return if automatic addition of CORS headers has been disabled.
- size() - Method in class org.springframework.web.socket.WebSocketHttpHeaders
-
- SockJsClient - Class in org.springframework.web.socket.sockjs.client
-
A SockJS implementation of
WebSocketClient
with fallback alternatives that simulate a WebSocket interaction through plain
HTTP streaming and long polling techniques..
- SockJsClient(List<Transport>) - Constructor for class org.springframework.web.socket.sockjs.client.SockJsClient
-
Create a SockJsClient
with the given transports.
- SockJsException - Exception in org.springframework.web.socket.sockjs
-
Base class for exceptions raised while processing SockJS HTTP requests.
- SockJsException(String, Throwable) - Constructor for exception org.springframework.web.socket.sockjs.SockJsException
-
Constructor for SockJsException.
- SockJsException(String, String, Throwable) - Constructor for exception org.springframework.web.socket.sockjs.SockJsException
-
Constructor for SockJsException.
- SockJsFrame - Class in org.springframework.web.socket.sockjs.frame
-
Represents a SockJS frame.
- SockJsFrame(String) - Constructor for class org.springframework.web.socket.sockjs.frame.SockJsFrame
-
Create a new instance frame with the given frame content.
- SockJsFrameFormat - Interface in org.springframework.web.socket.sockjs.frame
-
Applies a transport-specific format to the content of a SockJS frame resulting
in a content that can be written out.
- SockJsFrameType - Enum in org.springframework.web.socket.sockjs.frame
-
SockJS frame types.
- SockJsHttpRequestHandler - Class in org.springframework.web.socket.sockjs.support
-
An
HttpRequestHandler
that allows mapping a
SockJsService
to requests
in a Servlet container.
- SockJsHttpRequestHandler(SockJsService, WebSocketHandler) - Constructor for class org.springframework.web.socket.sockjs.support.SockJsHttpRequestHandler
-
Create a new SockJsHttpRequestHandler.
- SockJsMessageCodec - Interface in org.springframework.web.socket.sockjs.frame
-
Encode and decode messages to and from a SockJS message frame,
essentially an array of JSON-encoded messages.
- SockJsMessageDeliveryException - Exception in org.springframework.web.socket.sockjs
-
An exception thrown when a message frame was successfully received over an HTTP POST
and parsed but one or more of the messages it contained could not be delivered to the
WebSocketHandler either because the handler failed or because the connection got
closed.
- SockJsMessageDeliveryException(String, List<String>, Throwable) - Constructor for exception org.springframework.web.socket.sockjs.SockJsMessageDeliveryException
-
- SockJsMessageDeliveryException(String, List<String>, String) - 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
-
- SockJsServiceRegistration() - Constructor for class org.springframework.web.socket.config.annotation.SockJsServiceRegistration
-
- SockJsSession - Interface in org.springframework.web.socket.sockjs.transport
-
- 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, Throwable) - Constructor for exception org.springframework.web.socket.sockjs.SockJsTransportFailureException
-
Constructor for SockJsTransportFailureException.
- SockJsTransportFailureException(String, String, Throwable) - Constructor for exception org.springframework.web.socket.sockjs.SockJsTransportFailureException
-
Constructor for SockJsTransportFailureException.
- SockJsUrlInfo - Class in org.springframework.web.socket.sockjs.client
-
Container for the base URL of a SockJS endpoint with additional helper methods
to derive related SockJS URLs: specifically, the
info
and
transport
URLs.
- SockJsUrlInfo(URI) - Constructor for class org.springframework.web.socket.sockjs.client.SockJsUrlInfo
-
- SockJsWebSocketHandler - Class in org.springframework.web.socket.sockjs.transport.handler
-
An implementation of
WebSocketHandler
that adds SockJS messages frames, sends
SockJS heartbeat messages, and delegates lifecycle events and messages to a target
WebSocketHandler
.
- SockJsWebSocketHandler(SockJsServiceConfig, WebSocketHandler, WebSocketServerSockJsSession) - Constructor for class org.springframework.web.socket.sockjs.transport.handler.SockJsWebSocketHandler
-
- SpringConfigurator - Class in org.springframework.web.socket.server.standard
-
- 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
-
A WebSocketClient based on standard Java WebSocket API.
- StandardWebSocketClient() - Constructor for class org.springframework.web.socket.client.standard.StandardWebSocketClient
-
Default constructor that calls
ContainerProvider.getWebSocketContainer()
to obtain a (new)
WebSocketContainer
instance.
- StandardWebSocketClient(WebSocketContainer) - Constructor for class org.springframework.web.socket.client.standard.StandardWebSocketClient
-
- StandardWebSocketHandlerAdapter - Class in org.springframework.web.socket.adapter.standard
-
- StandardWebSocketHandlerAdapter(WebSocketHandler, StandardWebSocketSession) - Constructor for class org.springframework.web.socket.adapter.standard.StandardWebSocketHandlerAdapter
-
- StandardWebSocketSession - Class in org.springframework.web.socket.adapter.standard
-
- StandardWebSocketSession(HttpHeaders, Map<String, Object>, InetSocketAddress, InetSocketAddress) - Constructor for class org.springframework.web.socket.adapter.standard.StandardWebSocketSession
-
Constructor for a standard WebSocket session.
- StandardWebSocketSession(HttpHeaders, Map<String, Object>, InetSocketAddress, InetSocketAddress, Principal) - Constructor for class org.springframework.web.socket.adapter.standard.StandardWebSocketSession
-
Constructor that associates a user with the WebSocket session.
- 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
-
- start() - Method in class org.springframework.web.socket.messaging.WebSocketStompClient
-
- start() - Method in class org.springframework.web.socket.server.jetty.JettyRequestUpgradeStrategy
-
- start() - Method in class org.springframework.web.socket.server.support.AbstractHandshakeHandler
-
- start() - Method in class org.springframework.web.socket.server.support.WebSocketHandlerMapping
-
- start() - Method in class org.springframework.web.socket.server.support.WebSocketHttpRequestHandler
-
- start() - Method in class org.springframework.web.socket.sockjs.client.JettyXhrTransport
-
- start() - Method in class org.springframework.web.socket.sockjs.client.SockJsClient
-
- start() - Method in class org.springframework.web.socket.sockjs.client.WebSocketTransport
-
- start() - Method in class org.springframework.web.socket.sockjs.support.SockJsHttpRequestHandler
-
- start() - Method in class org.springframework.web.socket.sockjs.transport.handler.WebSocketTransportHandler
-
- start() - Method in class org.springframework.web.socket.sockjs.transport.TransportHandlingSockJsService
-
- startInternal() - Method in class org.springframework.web.socket.client.ConnectionManagerSupport
-
- startInternal() - Method in class org.springframework.web.socket.client.WebSocketConnectionManager
-
- StompEndpointRegistry - Interface in org.springframework.web.socket.config.annotation
-
A contract for registering STOMP over WebSocket endpoints.
- StompSubProtocolErrorHandler - Class in org.springframework.web.socket.messaging
-
- StompSubProtocolErrorHandler() - Constructor for class org.springframework.web.socket.messaging.StompSubProtocolErrorHandler
-
- StompSubProtocolHandler - Class in org.springframework.web.socket.messaging
-
A
SubProtocolHandler
for STOMP that supports versions 1.0, 1.1, and 1.2
of the STOMP specification.
- StompSubProtocolHandler() - Constructor for class org.springframework.web.socket.messaging.StompSubProtocolHandler
-
- StompSubProtocolHandler.Stats - Interface in org.springframework.web.socket.messaging
-
Contract for access to session counters.
- StompWebSocketEndpointRegistration - Interface in org.springframework.web.socket.config.annotation
-
A contract for configuring a STOMP over WebSocket endpoint.
- stompWebSocketHandlerMapping(WebSocketHandler, TaskScheduler) - Method in class org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurationSupport
-
- stop() - Method in class org.springframework.web.socket.client.ConnectionManagerSupport
-
- stop(Runnable) - Method in class org.springframework.web.socket.client.ConnectionManagerSupport
-
- stop() - 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
-
- stop() - Method in class org.springframework.web.socket.messaging.WebSocketStompClient
-
- stop() - Method in class org.springframework.web.socket.server.jetty.JettyRequestUpgradeStrategy
-
- stop() - Method in class org.springframework.web.socket.server.support.AbstractHandshakeHandler
-
- stop() - Method in class org.springframework.web.socket.server.support.WebSocketHandlerMapping
-
- stop() - Method in class org.springframework.web.socket.server.support.WebSocketHttpRequestHandler
-
- stop() - Method in class org.springframework.web.socket.sockjs.client.JettyXhrTransport
-
- stop() - Method in class org.springframework.web.socket.sockjs.client.SockJsClient
-
- stop() - Method in class org.springframework.web.socket.sockjs.client.WebSocketTransport
-
- stop() - Method in class org.springframework.web.socket.sockjs.support.SockJsHttpRequestHandler
-
- stop() - Method in class org.springframework.web.socket.sockjs.transport.handler.WebSocketTransportHandler
-
- stop() - Method in class org.springframework.web.socket.sockjs.transport.TransportHandlingSockJsService
-
- stopInternal() - Method in class org.springframework.web.socket.client.ConnectionManagerSupport
-
- stopInternal() - Method in class org.springframework.web.socket.client.WebSocketConnectionManager
-
- StreamingSockJsSession - Class in org.springframework.web.socket.sockjs.transport.session
-
A SockJS session for use with streaming HTTP transports.
- StreamingSockJsSession(String, SockJsServiceConfig, WebSocketHandler, Map<String, Object>) - Constructor for class org.springframework.web.socket.sockjs.transport.session.StreamingSockJsSession
-
- SubProtocolCapable - Interface in org.springframework.web.socket
-
An interface for WebSocket handlers that support sub-protocols as defined in RFC 6455.
- SubProtocolErrorHandler<P> - Interface in org.springframework.web.socket.messaging
-
A contract for handling sub-protocol errors sent to clients.
- SubProtocolHandler - Interface in org.springframework.web.socket.messaging
-
A contract for handling WebSocket messages as part of a higher level protocol,
referred to as "sub-protocol" in the WebSocket RFC specification.
- subProtocolWebSocketHandler(AbstractSubscribableChannel, AbstractSubscribableChannel) - Method in class org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurationSupport
-
- SubProtocolWebSocketHandler - Class in org.springframework.web.socket.messaging
-
An implementation of
WebSocketHandler
that delegates incoming WebSocket
messages to a
SubProtocolHandler
along with a
MessageChannel
to which
the sub-protocol handler can send messages from WebSocket clients to the application.
- SubProtocolWebSocketHandler(MessageChannel, SubscribableChannel) - Constructor for class org.springframework.web.socket.messaging.SubProtocolWebSocketHandler
-
Create a new SubProtocolWebSocketHandler
for the given inbound and outbound channels.
- SubProtocolWebSocketHandler.Stats - Interface in org.springframework.web.socket.messaging
-
Contract for access to session counters.
- supportsCors() - Method in enum org.springframework.web.socket.sockjs.transport.TransportType
-
- supportsEventType(Class<? extends ApplicationEvent>) - Method in class org.springframework.web.socket.messaging.DefaultSimpUserRegistry
-
- supportsOrigin() - 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.
- supportsSourceType(Class<?>) - Method in class org.springframework.web.socket.messaging.DefaultSimpUserRegistry
-