Class AbstractStompSessionManager

java.lang.Object

org.springframework.integration.stomp.AbstractStompSessionManager

All Implemented Interfaces:

Aware, BeanNameAware, DisposableBean, ApplicationEventPublisherAware, Lifecycle, Phased, SmartLifecycle, StompSessionManager

Direct Known Subclasses:

ReactorNettyTcpStompSessionManager, WebSocketStompSessionManager

public abstract class AbstractStompSessionManager
extends Object
implements StompSessionManager, ApplicationEventPublisherAware, SmartLifecycle, DisposableBean, BeanNameAware

Base StompSessionManager implementation to manage a single StompSession over its CompletableFuture from the target implementation of this class.

The connection to the StompSession is made during start().

The stop() lifecycle method manages StompSession.disconnect().

The connect(StompSessionHandler) and disconnect(StompSessionHandler) method implementations populate/remove the provided StompSessionHandler to/from an internal AbstractStompSessionManager.CompositeStompSessionHandler, which delegates all operations to the provided StompSessionHandlers. This AbstractStompSessionManager.CompositeStompSessionHandler is used for the StompSession connection.

Since:

4.2

Author:

Artem Bilan, Gary Russell, Christian Tzolov

Field Summary

Fields

Modifier and Type	Field	Description
protected final Log	logger
protected final StompClientSupport	stompClient

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor	Description
AbstractStompSessionManager(StompClientSupport stompClient)

Method Summary

Modifier and Type	Method	Description
void	connect(StompSessionHandler handler)
void	destroy()
void	disconnect(StompSessionHandler handler)
protected abstract CompletableFuture<StompSession>	doConnect(StompSessionHandler handler)
protected @Nullable StompHeaders	getConnectHeaders()
int	getPhase()
long	getRecoveryInterval()
boolean	isAutoReceiptEnabled()
boolean	isAutoStartup()
boolean	isConnected()
boolean	isRunning()
void	setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)
void	setAutoReceipt(boolean autoReceipt)
void	setAutoStartup(boolean autoStartup)
void	setBeanName(String name)
void	setConnectHeaders(StompHeaders connectHeaders)
void	setPhase(int phase)
void	setRecoveryInterval(int recoveryInterval)	Specify a reconnect interval in milliseconds in case of lost connection.
void	start()
void	stop()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.context.SmartLifecycle

isPauseable, stop

Field Details

logger

protected final Log logger

stompClient

protected final StompClientSupport stompClient

Constructor Details

AbstractStompSessionManager

public AbstractStompSessionManager(StompClientSupport stompClient)

Method Details

setConnectHeaders

public void setConnectHeaders(StompHeaders connectHeaders)

setAutoReceipt

public void setAutoReceipt(boolean autoReceipt)

isAutoReceiptEnabled

public boolean isAutoReceiptEnabled()

Specified by:

isAutoReceiptEnabled in interface StompSessionManager

isConnected

public boolean isConnected()

Specified by:

isConnected in interface StompSessionManager

setApplicationEventPublisher

public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)

Specified by:

setApplicationEventPublisher in interface ApplicationEventPublisherAware

setBeanName

public void setBeanName(String name)

Specified by:

setBeanName in interface BeanNameAware

setRecoveryInterval

public void setRecoveryInterval(int recoveryInterval)

Specify a reconnect interval in milliseconds in case of lost connection.

Parameters:

recoveryInterval - the reconnect interval in milliseconds in case of lost connection.

Since:

4.2.2

setAutoStartup

public void setAutoStartup(boolean autoStartup)

setPhase

public void setPhase(int phase)

getRecoveryInterval

public long getRecoveryInterval()

isAutoStartup

public boolean isAutoStartup()

Specified by:

isAutoStartup in interface SmartLifecycle

isRunning

public boolean isRunning()

Specified by:

isRunning in interface Lifecycle

getPhase

public int getPhase()

Specified by:

getPhase in interface Phased

Specified by:

getPhase in interface SmartLifecycle

destroy

public void destroy()

Specified by:

destroy in interface DisposableBean

start

public void start()

Specified by:

start in interface Lifecycle

stop

public void stop()

Specified by:

stop in interface Lifecycle

connect

public void connect(StompSessionHandler handler)

Specified by:

connect in interface StompSessionManager

disconnect

public void disconnect(StompSessionHandler handler)

Specified by:

disconnect in interface StompSessionManager

getConnectHeaders

protected @Nullable StompHeaders getConnectHeaders()

toString

public String toString()

Overrides:

toString in class Object

doConnect

protected abstract CompletableFuture<StompSession> doConnect(StompSessionHandler handler)