Spring Framework 6.1.4 · org.springframework.web.socket.client.ConnectionManagerSupport

Modifier and Type	Field and Description
private boolean	autoStartup
private final Object	lifecycleMonitor
protected final Log	logger
private int	phase
private volatile boolean	running
private final URI	uri

Access	Constructor and Description
public	ConnectionManagerSupport(String uriTemplate, Object... uriVariables) Constructor with a URI template and variables.
public	ConnectionManagerSupport(URI the url to connect to uri) Constructor with a prepared `URI`.

Method Summary

Modifier and Type	Method and Description
protected abstract void	closeConnection() Subclasses implement this to close the connection.
public int	getPhase() Overrides default org.springframework.context.SmartLifecycle.getPhase. Return the phase in which this endpoint connection factory will be auto-connected and stopped.
protected URI	getUri()
public boolean	isAutoStartup() Overrides default org.springframework.context.SmartLifecycle.isAutoStartup. Return the value for the 'autoStartup' property.
public abstract boolean	isConnected() Whether the connection is open/`true` or closed/`false`.
public boolean	isRunning() Implements org.springframework.context.Lifecycle.isRunning. Return whether this ConnectionManager has been started.
protected abstract void	openConnection() Subclasses implement this to actually establish the connection.
public void	setAutoStartup(boolean autoStartup) Set whether to auto-connect to the remote endpoint after this connection manager has been initialized and the Spring context has been refreshed.
public void	setPhase(int phase) Specify the phase in which a connection should be established to the remote endpoint and subsequently closed.
public final void	start() Implements org.springframework.context.Lifecycle.start. Start the WebSocket connection.
protected void	startInternal()
public final void	stop() Implements org.springframework.context.Lifecycle.stop. Stop this component, typically in a synchronous fashion, such that the component is fully stopped upon return of this method.
public final void	stop(Runnable callback) Overrides default org.springframework.context.SmartLifecycle.stop. Indicates that a Lifecycle component must stop if it is currently running.
protected void	stopInternal()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

autoStartup	back to summary
private boolean autoStartup

lifecycleMonitor	back to summary
private final Object lifecycleMonitor

logger	back to summary
protected final Log logger

phase	back to summary
private int phase

running	back to summary
private volatile boolean running

uri	back to summary
private final URI uri

ConnectionManagerSupport	back to summary
public ConnectionManagerSupport(String uriTemplate, Object... uriVariables) Constructor with a URI template and variables.

ConnectionManagerSupport	back to summary
public ConnectionManagerSupport(URI uri) Constructor with a prepared `URI`. Parameters uri:URI the url to connect to Since 6.0.5

Method Detail

closeConnection	back to summary
protected abstract void closeConnection() throws Exception Subclasses implement this to close the connection.

getPhase	back to summary
public int getPhase() Overrides default org.springframework.context.SmartLifecycle.getPhase. Return the phase in which this endpoint connection factory will be auto-connected and stopped. Annotations @Override

getPhase

back to summary

public int getPhase()

Overrides default org.springframework.context.SmartLifecycle.getPhase.

Return the phase in which this endpoint connection factory will be auto-connected and stopped.

Annotations

@Override

getUri	back to summary
protected URI getUri()

isAutoStartup	back to summary
public boolean isAutoStartup() Overrides default org.springframework.context.SmartLifecycle.isAutoStartup. Return the value for the 'autoStartup' property. If "true", this endpoint connection manager will connect to the remote endpoint upon a ContextRefreshedEvent. Annotations @Override

isAutoStartup

back to summary

public boolean isAutoStartup()

Overrides default org.springframework.context.SmartLifecycle.isAutoStartup.

Return the value for the 'autoStartup' property. If "true", this endpoint connection manager will connect to the remote endpoint upon a ContextRefreshedEvent.

Annotations

@Override

isConnected	back to summary
public abstract boolean isConnected() Whether the connection is open/`true` or closed/`false`.

isRunning	back to summary
public boolean isRunning() Implements org.springframework.context.Lifecycle.isRunning. Return whether this ConnectionManager has been started. Returns:boolean Doc from org.springframework.context.Lifecycle.isRunning. whether the component is currently running Annotations @Override

isRunning

back to summary

public boolean isRunning()

Implements org.springframework.context.Lifecycle.isRunning.

Return whether this ConnectionManager has been started.

Returns:boolean

Doc from org.springframework.context.Lifecycle.isRunning.

whether the component is currently running

Annotations

@Override

openConnection	back to summary
protected abstract void openConnection() Subclasses implement this to actually establish the connection.

setAutoStartup	back to summary
public void setAutoStartup(boolean autoStartup) Set whether to auto-connect to the remote endpoint after this connection manager has been initialized and the Spring context has been refreshed. Default is "false".

setAutoStartup

back to summary

public void setAutoStartup(boolean autoStartup)

Set whether to auto-connect to the remote endpoint after this connection manager has been initialized and the Spring context has been refreshed.

Default is "false".

setPhase	back to summary
public void setPhase(int phase) Specify the phase in which a connection should be established to the remote endpoint and subsequently closed. The startup order proceeds from lowest to highest, and the shutdown order is the reverse of that. By default, this value is Integer.MAX_VALUE meaning that this endpoint connection factory connects as late as possible and is closed as soon as possible.

start	back to summary
public final void start() Implements org.springframework.context.Lifecycle.start. Start the WebSocket connection. If already connected, the method has no impact. Annotations @Override

start

back to summary

public final void start()

Implements org.springframework.context.Lifecycle.start.

Start the WebSocket connection. If already connected, the method has no impact.

Annotations

@Override

startInternal	back to summary
protected void startInternal()

stop back to summary

stop	back to summary
public final void stop() Implements org.springframework.context.Lifecycle.stop. Doc from org.springframework.context.Lifecycle.stop. Stop this component, typically in a synchronous fashion, such that the component is fully stopped upon return of this method. Consider implementing `SmartLifecycle` and its `stop(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. Annotations @Override

public final void stop()

Implements org.springframework.context.Lifecycle.stop.

Doc from org.springframework.context.Lifecycle.stop.

Stop this component, typically in a synchronous fashion, such that the component is fully stopped upon return of this method. Consider implementing SmartLifecycle and its stop(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.

Annotations

@Override

stop back to summary

stop	back to summary
public final void stop(Runnable callback) Overrides default org.springframework.context.SmartLifecycle.stop. Doc from org.springframework.context.SmartLifecycle.stop. Indicates that a Lifecycle component must stop if it is currently running. The provided callback is used by the `LifecycleProcessor` to support an ordered, and potentially concurrent, shutdown of all components having a common shutdown order value. The callback must be executed after the `SmartLifecycle` component does indeed stop. The `LifecycleProcessor` will call only this variant of the `stop` method; i.e. `Lifecycle#stop()` will not be called for `SmartLifecycle` implementations unless explicitly delegated to within the implementation of this method. The default implementation delegates to `stop()` and immediately triggers the given callback in the calling thread. Note that there is no synchronization between the two, so custom implementations may at least want to put the same steps within their common lifecycle monitor (if any). Annotations @Override

public final void stop(Runnable callback)

Overrides default org.springframework.context.SmartLifecycle.stop.

Doc from org.springframework.context.SmartLifecycle.stop.

Indicates that a Lifecycle component must stop if it is currently running.

The provided callback is used by the LifecycleProcessor to support an ordered, and potentially concurrent, shutdown of all components having a common shutdown order value. The callback must be executed after the SmartLifecycle component does indeed stop.

The LifecycleProcessor will call only this variant of the stop method; i.e. Lifecycle#stop() will not be called for SmartLifecycle implementations unless explicitly delegated to within the implementation of this method.

The default implementation delegates to stop() and immediately triggers the given callback in the calling thread. Note that there is no synchronization between the two, so custom implementations may at least want to put the same steps within their common lifecycle monitor (if any).

Annotations

@Override

stopInternal	back to summary
protected void stopInternal() throws Exception

public abstract Class ConnectionManagerSupport

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail