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, anEndpoint
, connects to a WebSocket server through theConnectionManagerSupport.start()
andConnectionManagerSupport.stop()
methods. IfConnectionManagerSupport.setAutoStartup(boolean)
is set totrue
this will be done automatically when the Spring ApplicationContext is refreshed.- Since:
- 4.0
- Author:
- Rossen Stoyanchev
- See Also:
AnnotatedEndpointConnectionManager
Field Summary
Fields inherited from class org.springframework.web.socket.client.ConnectionManagerSupport
logger
Fields inherited from interface org.springframework.context.SmartLifecycle
DEFAULT_PHASE
Constructor Summary
Constructors Constructor Description EndpointConnectionManager(Class<? extends Endpoint> endpointClass, String uriTemplate, Object... uriVars)
EndpointConnectionManager(Endpoint endpoint, String uriTemplate, Object... uriVariables)
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
closeConnection()
TaskExecutor
getTaskExecutor()
Return the configuredTaskExecutor
.WebSocketContainer
getWebSocketContainer()
protected boolean
isConnected()
protected void
openConnection()
void
setBeanFactory(BeanFactory beanFactory)
Callback that supplies the owning factory to a bean instance.void
setConfigurator(ClientEndpointConfig.Configurator configurator)
void
setDecoders(List<Class<? extends Decoder>> decoders)
void
setEncoders(List<Class<? extends Encoder>> encoders)
void
setExtensions(Extension... extensions)
void
setSupportedProtocols(String... protocols)
void
setTaskExecutor(TaskExecutor taskExecutor)
Set aTaskExecutor
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
Constructor Detail
EndpointConnectionManager
public EndpointConnectionManager(Endpoint endpoint, String uriTemplate, Object... uriVariables)
EndpointConnectionManager
public EndpointConnectionManager(Class<? extends Endpoint> endpointClass, String uriTemplate, Object... uriVars)
Method Detail
setSupportedProtocols
public void setSupportedProtocols(String... protocols)
setExtensions
public void setExtensions(Extension... extensions)
setEncoders
public void setEncoders(List<Class<? extends Encoder>> encoders)
setDecoders
public void setDecoders(List<Class<? extends Decoder>> decoders)
setConfigurator
public void setConfigurator(ClientEndpointConfig.Configurator configurator)
setWebSocketContainer
public void setWebSocketContainer(WebSocketContainer webSocketContainer)
getWebSocketContainer
public WebSocketContainer getWebSocketContainer()
setBeanFactory
public void setBeanFactory(BeanFactory beanFactory)
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 interfaceBeanFactoryAware
- Parameters:
beanFactory
- owning BeanFactory (nevernull
). The bean can immediately call methods on the factory.- See Also:
BeanInitializationException
setTaskExecutor
public void setTaskExecutor(TaskExecutor taskExecutor)
Set aTaskExecutor
to use to open connections. By defaultSimpleAsyncTaskExecutor
is used.
getTaskExecutor
public TaskExecutor getTaskExecutor()
Return the configuredTaskExecutor
.
openConnection
protected void openConnection()
- Specified by:
openConnection
in classConnectionManagerSupport
closeConnection
protected void closeConnection() throws Exception
- Specified by:
closeConnection
in classConnectionManagerSupport
- Throws:
Exception
isConnected
protected boolean isConnected()
- Specified by:
isConnected
in classConnectionManagerSupport