Class JettyWebSocketClient
java.lang.Object
org.springframework.web.socket.client.AbstractWebSocketClient
org.springframework.web.socket.client.jetty.JettyWebSocketClient
- All Implemented Interfaces:
org.springframework.context.Lifecycle
,WebSocketClient
@Deprecated(since="6.0.3",
forRemoval=true)
public class JettyWebSocketClient
extends AbstractWebSocketClient
implements org.springframework.context.Lifecycle
Deprecated, for removal: This API element is subject to removal in a future version.
Initiates WebSocket requests to a WebSocket server programmatically
through the Jetty WebSocket API. Only supported on Jetty 11, superseded by
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, org.springframework.http.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.org.springframework.core.task.AsyncTaskExecutor
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.void
setTaskExecutor
(org.springframework.core.task.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.void
stop()
Deprecated, for removal: This API element is subject to removal in a future version.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
public void setTaskExecutor(@Nullable org.springframework.core.task.AsyncTaskExecutor taskExecutor) 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
@Nullable public org.springframework.core.task.AsyncTaskExecutor 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.- Specified by:
start
in interfaceorg.springframework.context.Lifecycle
-
stop
public void stop()Deprecated, for removal: This API element is subject to removal in a future version.- Specified by:
stop
in interfaceorg.springframework.context.Lifecycle
-
isRunning
public boolean isRunning()Deprecated, for removal: This API element is subject to removal in a future version.- Specified by:
isRunning
in interfaceorg.springframework.context.Lifecycle
-
executeInternal
public CompletableFuture<WebSocketSession> executeInternal(WebSocketHandler wsHandler, org.springframework.http.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