org.springframework.web.socket.client.standard

Class EndpointConnectionManager

java.lang.Object

org.springframework.web.socket.client.ConnectionManagerSupport

org.springframework.web.socket.client.standard.EndpointConnectionManager

All Implemented Interfaces:

Aware, BeanFactoryAware, Lifecycle, Phased, SmartLifecycle

public class EndpointConnectionManager
extends ConnectionManagerSupport
implements BeanFactoryAware

A WebSocket connection manager that is given a URI, an Endpoint, connects to a WebSocket server through the ConnectionManagerSupport.start() and ConnectionManagerSupport.stop() methods. If ConnectionManagerSupport.setAutoStartup(boolean) is set to true this will be done automatically when the Spring ApplicationContext is refreshed.

Since:

4.0

Author:

Rossen Stoyanchev

See Also:

AnnotatedEndpointConnectionManager

Field Summary

Fields

Modifier and Type	Field and Description
private ClientEndpointConfig.Builder	configBuilder
private Endpoint	endpoint
private BeanCreatingHandlerProvider<Endpoint>	endpointProvider
private Session	session
private TaskExecutor	taskExecutor
private WebSocketContainer	webSocketContainer

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

logger

Constructor Summary

Constructors

Constructor and Description
EndpointConnectionManager(Endpoint endpoint, java.lang.String uriTemplate, java.lang.Object... uriVariables)

Method Summary

Modifier and Type	Method and Description
protected void	closeConnection()
TaskExecutor	getTaskExecutor() Return the configured TaskExecutor.
WebSocketContainer	getWebSocketContainer()
protected boolean	isConnected()
protected void	openConnection()
void	setBeanFactory(BeanFactory beanFactory) Callback that supplies the owning factory to a bean instance.
void	setConfigurator(Configurator configurator)
void	setDecoders(java.util.List<java.lang.Class<? extends Decoder>> decoders)
void	setEncoders(java.util.List<java.lang.Class<? extends Encoder>> encoders)
void	setExtensions(Extension... extensions)
void	setSupportedProtocols(java.lang.String... protocols)
void	setTaskExecutor(TaskExecutor taskExecutor) Set a TaskExecutor to use to open connections.
void	setWebSocketContainer(WebSocketContainer webSocketContainer)

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

getPhase, getUri, isAutoStartup, isRunning, setAutoStartup, setPhase, start, startInternal, stop, stop, stopInternal

Methods inherited from class java.lang.Object

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

Field Detail

endpoint

private final Endpoint endpoint

endpointProvider

private final BeanCreatingHandlerProvider<Endpoint> endpointProvider

configBuilder

private final ClientEndpointConfig.Builder configBuilder

webSocketContainer

private WebSocketContainer webSocketContainer

session

private Session session

taskExecutor

private TaskExecutor taskExecutor

Constructor Detail

EndpointConnectionManager

public EndpointConnectionManager(Endpoint endpoint,
                                 java.lang.String uriTemplate,
                                 java.lang.Object... uriVariables)

Method Detail

setSupportedProtocols

public void setSupportedProtocols(java.lang.String... protocols)

setExtensions

public void setExtensions(Extension... extensions)

setEncoders

public void setEncoders(java.util.List<java.lang.Class<? extends Encoder>> encoders)

setDecoders

public void setDecoders(java.util.List<java.lang.Class<? extends Decoder>> decoders)

setConfigurator

public void setConfigurator(Configurator configurator)

setWebSocketContainer

public void setWebSocketContainer(WebSocketContainer webSocketContainer)

getWebSocketContainer

public WebSocketContainer getWebSocketContainer()

setBeanFactory

public void setBeanFactory(BeanFactory beanFactory)
                    throws BeansException

Description copied from interface: BeanFactoryAware

Callback that supplies the owning factory to a bean instance.

Invoked after the population of normal bean properties but before an initialization callback such as InitializingBean.afterPropertiesSet() or a custom init-method.

Specified by:

setBeanFactory in interface BeanFactoryAware

Parameters:

beanFactory - owning BeanFactory (never null). The bean can immediately call methods on the factory.

Throws:

BeansException - in case of initialization errors

See Also:

BeanInitializationException

setTaskExecutor

public void setTaskExecutor(TaskExecutor taskExecutor)

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

getTaskExecutor

public TaskExecutor getTaskExecutor()

Return the configured TaskExecutor.

openConnection

protected void openConnection()

Specified by:

openConnection in class ConnectionManagerSupport

closeConnection

protected void closeConnection()
                        throws java.lang.Exception

Specified by:

closeConnection in class ConnectionManagerSupport

Throws:

java.lang.Exception

isConnected

protected boolean isConnected()

Specified by:

isConnected in class ConnectionManagerSupport