Class JettyWebSocketClient
- All Implemented Interfaces:
Lifecycle
,WebSocketClient
StandardWebSocketClient
.
As of 4.1 this class implements Lifecycle
rather than
SmartLifecycle
. Use
WebSocketConnectionManager
instead to auto-start a WebSocket connection.
- Since:
- 4.0
- Author:
- Rossen Stoyanchev, Juergen Hoeller
-
Field Summary
Fields inherited from class org.springframework.web.socket.client.AbstractWebSocketClient
logger
-
Constructor Summary
ConstructorDescriptionDeprecated, for removal: This API element is subject to removal in a future version.Default constructor that creates an instance ofWebSocketClient
.JettyWebSocketClient
(org.eclipse.jetty.websocket.client.WebSocketClient client) Deprecated, for removal: This API element is subject to removal in a future version.Constructor that accepts an existingWebSocketClient
instance. -
Method Summary
Modifier and TypeMethodDescriptionexecuteInternal
(WebSocketHandler wsHandler, HttpHeaders headers, URI uri, List<String> protocols, List<WebSocketExtension> extensions, Map<String, Object> attributes) Deprecated, for removal: This API element is subject to removal in a future version.Perform the actual handshake to establish a connection to the server.Deprecated, for removal: This API element is subject to removal in a future version.Return the configuredAsyncTaskExecutor
.protected Principal
getUser()
Deprecated, for removal: This API element is subject to removal in a future version.Return the user to make available throughWebSocketSession.getPrincipal()
.boolean
Deprecated, for removal: This API element is subject to removal in a future version.Check whether this component is currently running.void
setTaskExecutor
(AsyncTaskExecutor taskExecutor) Deprecated, for removal: This API element is subject to removal in a future version.Set anAsyncTaskExecutor
to use when opening connections.void
start()
Deprecated, for removal: This API element is subject to removal in a future version.Start this component.void
stop()
Deprecated, for removal: This API element is subject to removal in a future version.Stop this component, typically in a synchronous fashion, such that the component is fully stopped upon return of this method.Methods inherited from class org.springframework.web.socket.client.AbstractWebSocketClient
assertUri, doHandshakeInternal, execute, execute
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.springframework.web.socket.client.WebSocketClient
doHandshake, doHandshake
-
Constructor Details
-
JettyWebSocketClient
public JettyWebSocketClient()Deprecated, for removal: This API element is subject to removal in a future version.Default constructor that creates an instance ofWebSocketClient
. -
JettyWebSocketClient
public JettyWebSocketClient(org.eclipse.jetty.websocket.client.WebSocketClient client) Deprecated, for removal: This API element is subject to removal in a future version.Constructor that accepts an existingWebSocketClient
instance.
-
-
Method Details
-
setTaskExecutor
Deprecated, for removal: This API element is subject to removal in a future version.Set anAsyncTaskExecutor
to use when opening connections.If this property is set to
null
, calls to any of thedoHandshake
methods will block until the connection is established.By default an instance of
SimpleAsyncTaskExecutor
is used. -
getTaskExecutor
Deprecated, for removal: This API element is subject to removal in a future version.Return the configuredAsyncTaskExecutor
. -
start
public void start()Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:Lifecycle
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.
-
stop
public void stop()Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:Lifecycle
Stop this component, typically in a synchronous fashion, such that the component is fully stopped upon return of this method. Consider implementingSmartLifecycle
and itsstop(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.
-
isRunning
public boolean isRunning()Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:Lifecycle
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. -
executeInternal
public CompletableFuture<WebSocketSession> executeInternal(WebSocketHandler wsHandler, HttpHeaders headers, URI uri, List<String> protocols, List<WebSocketExtension> extensions, Map<String, Object> attributes) Deprecated, for removal: This API element is subject to removal in a future version.Description copied from class:AbstractWebSocketClient
Perform the actual handshake to establish a connection to the server.- Specified by:
executeInternal
in classAbstractWebSocketClient
- Parameters:
wsHandler
- the client-side handler for WebSocket messagesheaders
- the HTTP headers to use for the handshake, with unwanted (forbidden) headers filtered out (nevernull
)uri
- the target URI for the handshake (nevernull
)protocols
- requested sub-protocols, or an empty listextensions
- requested WebSocket extensions, or an empty listattributes
- the attributes to associate with the WebSocketSession, i.e. viaWebSocketSession.getAttributes()
; currently always an empty map- Returns:
- the established WebSocket session wrapped in a
CompletableFuture
.
-
getUser
Deprecated, for removal: This API element is subject to removal in a future version.Return the user to make available throughWebSocketSession.getPrincipal()
. By default, this method returnsnull
-
StandardWebSocketClient