Register a sub-protocol handler.

Implements org.springframework.web.socket.WebSocketHandler.afterConnectionClosed.

Doc from org.springframework.web.socket.WebSocketHandler.afterConnectionClosed.

Invoked after the WebSocket connection has been closed by either side, or after a transport error has occurred. Although the session may technically still be open, depending on the underlying implementation, sending messages at this point is discouraged and most likely will not succeed.

Annotations

@Override

Exceptions

Exception:

this method can handle or propagate exceptions; see class-level Javadoc for details.

Implements org.springframework.web.socket.WebSocketHandler.afterConnectionEstablished.

Doc from org.springframework.web.socket.WebSocketHandler.afterConnectionEstablished.

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

Annotations

@Override

Exceptions

Exception:

this method can handle or propagate exceptions; see class-level Javadoc for details.

Return the default sub-protocol handler to use.

Annotations

@Nullable

Overrides default org.springframework.context.SmartLifecycle.getPhase.

Doc from org.springframework.context.SmartLifecycle.getPhase.

Return the phase that this lifecycle object is supposed to run in.

The default implementation returns DEFAULT_PHASE in order to let stop() callbacks execute before regular Lifecycle implementations.

Annotations

@Override

Return the sub-protocols keyed by protocol name.

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

Return the send-time limit (milliseconds).

Return a structured object with various session counters.

Since

5.2

Return a String describing internal state and counters. Effectively toString() on getStats().

Implements org.springframework.web.socket.SubProtocolCapable.getSubProtocols.

Return all supported protocols.

Annotations

@Override

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

Since

5.1

Implements org.springframework.web.socket.WebSocketHandler.handleMessage.

Handle an inbound message from a WebSocket client.

Annotations

@Override

Exceptions

Exception:

Doc from org.springframework.web.socket.WebSocketHandler.handleMessage.

this method can handle or propagate exceptions; see class-level Javadoc for details.

Implements org.springframework.messaging.MessageHandler.handleMessage.

Handle an outbound Spring Message to a WebSocket client.

Parameters

message:Message<?>

Doc from org.springframework.messaging.MessageHandler.handleMessage.

the message to be handled

Annotations

@Override

Exceptions

MessagingException:

Doc from org.springframework.messaging.MessageHandler.handleMessage.

if the handler failed to process the message

Implements org.springframework.web.socket.WebSocketHandler.handleTransportError.

Doc from org.springframework.web.socket.WebSocketHandler.handleTransportError.

Handle an error from the underlying WebSocket message transport.

Annotations

@Override

Exceptions

Exception:

this method can handle or propagate exceptions; see class-level Javadoc for details.

Implements org.springframework.context.Lifecycle.isRunning.

Doc from org.springframework.context.Lifecycle.isRunning.

Check whether this component is currently running.

In the case of a container, this will return true only if all components that apply are currently running.

Returns:boolean

whether the component is currently running

Annotations

@Override

Set the SubProtocolHandler to use when the client did not request a sub-protocol.

Parameters

defaultProtocolHandler:SubProtocolHandler

the default handler

Set the phase that this handler should run in.

By default, this is SmartLifecycle#DEFAULT_PHASE.

Since

6.1.4

Configure one or more handlers to use depending on the sub-protocol requested by the client in the WebSocket handshake request.

Parameters

protocolHandlers:List<SubProtocolHandler>

the sub-protocol handlers to use

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

See Also

ConcurrentWebSocketSessionDecorator

Specify the send-time limit (milliseconds).

See Also

ConcurrentWebSocketSessionDecorator

Set the maximum time allowed in milliseconds after the WebSocket connection is established and before the first sub-protocol message is received.

This handler is for WebSocket connections that use a sub-protocol. Therefore, we expect the client to send at least one sub-protocol message in the beginning, or else we assume the connection isn't doing well, e.g. proxy issue, slow network, and can be closed.

By default this is set to 60,000 (1 minute).

Parameters

timeToFirstMessage:int

the maximum time allowed in milliseconds

Since

5.1

See Also

checkSessions()

Implements org.springframework.context.Lifecycle.start.

Doc from org.springframework.context.Lifecycle.start.

Start this component.

Should not throw an exception if the component is already running.

In the case of a container, this will propagate the start signal to all components that apply.

Annotations

@Override

Implements org.springframework.context.Lifecycle.stop.

Doc from org.springframework.context.Lifecycle.stop.

Stop this component, typically in a synchronous fashion, such that the component is fully stopped upon return of this method. Consider implementing SmartLifecycle and its stop(Runnable) variant when asynchronous stop behavior is necessary.

Note that this stop notification is not guaranteed to come before destruction: On regular shutdown, Lifecycle beans will first receive a stop notification before the general destruction callbacks are being propagated; however, on hot refresh during a context's lifetime or on aborted refresh attempts, a given bean's destroy method will be called without any consideration of stop signals upfront.

Should not throw an exception if the component is not running (not started yet).

In the case of a container, this will propagate the stop signal to all components that apply.

Annotations

@Override

Overrides default org.springframework.context.SmartLifecycle.stop.

Doc from org.springframework.context.SmartLifecycle.stop.

Indicates that a Lifecycle component must stop if it is currently running.

The provided callback is used by the LifecycleProcessor to support an ordered, and potentially concurrent, shutdown of all components having a common shutdown order value. The callback must be executed after the SmartLifecycle component does indeed stop.

The LifecycleProcessor will call only this variant of the stop method; i.e. Lifecycle#stop() will not be called for SmartLifecycle implementations unless explicitly delegated to within the implementation of this method.

The default implementation delegates to stop() and immediately triggers the given callback in the calling thread. Note that there is no synchronization between the two, so custom implementations may at least want to put the same steps within their common lifecycle monitor (if any).

Annotations

@Override

Implements org.springframework.web.socket.WebSocketHandler.supportsPartialMessages.

Doc from org.springframework.web.socket.WebSocketHandler.supportsPartialMessages.

Whether the WebSocketHandler handles partial messages. If this flag is set to true and the underlying WebSocket server supports partial messages, then a large WebSocket message, or one of an unknown size may be split and maybe received over multiple calls to handleMessage(WebSocketSession, WebSocketMessage). The flag org.springframework.web.socket.WebSocketMessage#isLast() indicates if the message is partial and whether it is the last part.

Annotations

@Override

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override