org.springframework.web.socket.client.jetty

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, org.springframework.context.Phased, org.springframework.context.SmartLifecycle, WebSocketClient

public class JettyWebSocketClient
extends AbstractWebSocketClient
implements org.springframework.context.SmartLifecycle

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

Since:

4.0

Author:

Rossen Stoyanchev

Field Summary

Fields inherited from class org.springframework.web.socket.client.AbstractWebSocketClient

logger

Constructor Summary

Constructors

Constructor and Description
JettyWebSocketClient() Default constructor that creates an instance of WebSocketClient with default settings.
JettyWebSocketClient(org.eclipse.jetty.websocket.client.WebSocketClient client) Constructor that accepts a pre-configured WebSocketClient.

Method Summary

Modifier and Type	Method and Description
org.springframework.util.concurrent.ListenableFuture<WebSocketSession>	doHandshake(WebSocketHandler webSocketHandler, String uriTemplate, Object... uriVars)
org.springframework.util.concurrent.ListenableFuture<WebSocketSession>	doHandshakeInternal(WebSocketHandler wsHandler, org.springframework.http.HttpHeaders headers, URI uri, List<String> protocols, List<WebSocketExtension> extensions, Map<String,Object> handshakeAttributes) Perform the actual handshake to establish a connection to the server.
int	getPhase()
org.springframework.core.task.AsyncListenableTaskExecutor	getTaskExecutor() Return the configured TaskExecutor.
protected Principal	getUser()
boolean	isAutoStartup()
boolean	isRunning()
void	setAutoStartup(boolean autoStartup)
void	setPhase(int phase)
void	setTaskExecutor(org.springframework.core.task.AsyncListenableTaskExecutor taskExecutor) Set a TaskExecutor to use to open the connection.
void	start()
void	stop()
void	stop(Runnable callback)

Methods inherited from class org.springframework.web.socket.client.AbstractWebSocketClient

doHandshake

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JettyWebSocketClient

public JettyWebSocketClient()

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

JettyWebSocketClient

public JettyWebSocketClient(org.eclipse.jetty.websocket.client.WebSocketClient client)

Constructor that accepts a pre-configured WebSocketClient.

Method Detail

setTaskExecutor

public void setTaskExecutor(org.springframework.core.task.AsyncListenableTaskExecutor taskExecutor)

Set a TaskExecutor to use to open the connection. By default SimpleAsyncTaskExecutor is used.

getTaskExecutor

public org.springframework.core.task.AsyncListenableTaskExecutor getTaskExecutor()

Return the configured TaskExecutor.

setAutoStartup

public void setAutoStartup(boolean autoStartup)

isAutoStartup

public boolean isAutoStartup()

Specified by:

isAutoStartup in interface org.springframework.context.SmartLifecycle

setPhase

public void setPhase(int phase)

getPhase

public int getPhase()

Specified by:

getPhase in interface org.springframework.context.Phased

isRunning

public boolean isRunning()

Specified by:

isRunning in interface org.springframework.context.Lifecycle

start

public void start()

Specified by:

start in interface org.springframework.context.Lifecycle

stop

public void stop()

Specified by:

stop in interface org.springframework.context.Lifecycle

stop

public void stop(Runnable callback)

Specified by:

stop in interface org.springframework.context.SmartLifecycle

doHandshake

public org.springframework.util.concurrent.ListenableFuture<WebSocketSession> doHandshake(WebSocketHandler webSocketHandler,
                                                                                          String uriTemplate,
                                                                                          Object... uriVars)

Specified by:

doHandshake in interface WebSocketClient

Overrides:

doHandshake in class AbstractWebSocketClient

doHandshakeInternal

public org.springframework.util.concurrent.ListenableFuture<WebSocketSession> doHandshakeInternal(WebSocketHandler wsHandler,
                                                                                                  org.springframework.http.HttpHeaders headers,
                                                                                                  URI uri,
                                                                                                  List<String> protocols,
                                                                                                  List<WebSocketExtension> extensions,
                                                                                                  Map<String,Object> handshakeAttributes)

Description copied from class: AbstractWebSocketClient

Perform the actual handshake to establish a connection to the server.

Specified by:

doHandshakeInternal in class AbstractWebSocketClient

Parameters:

wsHandler - the client-side handler for WebSocket messages

headers - HTTP headers to use for the handshake, with unwanted (forbidden) headers filtered out, never null

uri - the target URI for the handshake, never null

protocols - requested sub-protocols, or an empty list

extensions - requested WebSocket extensions, or an empty list

handshakeAttributes - attributes to make available via WebSocketSession.getHandshakeAttributes(); currently always an empty map.

Returns:

the established WebSocket session wrapped in a ListenableFuture.

getUser

protected Principal getUser()

Returns:

the user to make available through WebSocketSession.getPrincipal(); by default this method returns null