Package org.springframework.integration.mqtt.core

Class AbstractMqttClientManager<T,C>

java.lang.Object

org.springframework.integration.mqtt.core.AbstractMqttClientManager<T,C>

Type Parameters:

T - MQTT client type

C - MQTT connection options type (v5 or v3)

All Implemented Interfaces:

Aware, BeanNameAware, ApplicationEventPublisherAware, Lifecycle, Phased, SmartLifecycle, ClientManager<T,C>, MqttComponent<C>

Direct Known Subclasses:

Mqttv3ClientManager, Mqttv5ClientManager

public abstract class AbstractMqttClientManager<T,C>
extends Object
implements ClientManager<T,C>, ApplicationEventPublisherAware

Abstract class for MQTT client managers which can be a base for any common v3/v5 client manager implementation. Contains some basic utility and implementation-agnostic fields and methods.

Since:

6.0

Author:

Artem Vozhdayenko, Artem Bilan, Christian Tzolov

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.integration.mqtt.core.ClientManager

ClientManager.ConnectCallback

Field Summary

Fields

Modifier and Type	Field	Description
protected final Lock	lock
protected final Log	logger

Fields inherited from interface org.springframework.integration.mqtt.core.ClientManager

DEFAULT_COMPLETION_TIMEOUT, DISCONNECT_COMPLETION_TIMEOUT

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractMqttClientManager(String clientId)

Method Summary

Modifier and Type	Method	Description
void	addCallback(ClientManager.ConnectCallback connectCallback)	Register a callback for the connectComplete event from the client.
protected ApplicationEventPublisher	getApplicationEventPublisher()
String	getBeanName()	Return this component's bean name.
protected Set<ClientManager.ConnectCallback>	getCallbacks()
T	getClient()	Return the managed client.
protected String	getClientId()
protected long	getCompletionTimeout()
protected long	getDisconnectCompletionTimeout()
int	getPhase()	The phase of component auto-start in SmartLifecycle.
protected String	getUrl()
boolean	isManualAcks()	If manual acknowledge has to be used; false by default.
boolean	isRunning()
boolean	removeCallback(ClientManager.ConnectCallback connectCallback)	Remove the callback from registration.
void	setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)
void	setBeanName(String name)
protected void	setClient(T client)
void	setCompletionTimeout(long completionTimeout)	Set the completion timeout for operations.
void	setDisconnectCompletionTimeout(long completionTimeout)	Set the completion timeout when disconnecting.
void	setManualAcks(boolean manualAcks)
void	setPhase(int phase)	Set the phase of component autostart in SmartLifecycle.
protected void	setUrl(String url)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.integration.mqtt.core.ClientManager

isConnected

Methods inherited from interface org.springframework.context.Lifecycle

start, stop

Methods inherited from interface org.springframework.integration.mqtt.core.MqttComponent

getConnectionInfo

Methods inherited from interface org.springframework.context.SmartLifecycle

isAutoStartup, stop

Field Details

logger

protected final Log logger

lock

protected final Lock lock

Constructor Details

AbstractMqttClientManager

protected AbstractMqttClientManager(String clientId)

Method Details

setManualAcks

public void setManualAcks(boolean manualAcks)

getUrl

protected String getUrl()

setUrl

protected void setUrl(String url)

getClientId

protected String getClientId()

getApplicationEventPublisher

protected ApplicationEventPublisher getApplicationEventPublisher()

setClient

protected void setClient(T client)

getCallbacks

protected Set<ClientManager.ConnectCallback> getCallbacks()

setCompletionTimeout

public void setCompletionTimeout(long completionTimeout)

Set the completion timeout for operations. Default 30000L milliseconds.

Parameters:

completionTimeout - The timeout.

Since:

6.0.3

getCompletionTimeout

protected long getCompletionTimeout()

setDisconnectCompletionTimeout

public void setDisconnectCompletionTimeout(long completionTimeout)

Set the completion timeout when disconnecting. Default 5000L milliseconds.

Parameters:

completionTimeout - The timeout.

Since:

6.0.3

getDisconnectCompletionTimeout

protected long getDisconnectCompletionTimeout()

isManualAcks

public boolean isManualAcks()

Description copied from interface: ClientManager

If manual acknowledge has to be used; false by default.

Specified by:

isManualAcks in interface ClientManager<T,C>

Returns:

true if manual acknowledge has to be used.

getClient

public T getClient()

Description copied from interface: ClientManager

Return the managed client.

Specified by:

getClient in interface ClientManager<T,C>

Returns:

the managed client.

setApplicationEventPublisher

public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)

Specified by:

setApplicationEventPublisher in interface ApplicationEventPublisherAware

setBeanName

public void setBeanName(String name)

Specified by:

setBeanName in interface BeanNameAware

getBeanName

public String getBeanName()

Description copied from interface: MqttComponent

Return this component's bean name.

Specified by:

getBeanName in interface MqttComponent<T>

Returns:

the bean name.

getPhase

public int getPhase()

The phase of component auto-start in SmartLifecycle. If the custom one is required, note that for the correct behavior it should be less than phase of AbstractMqttMessageDrivenChannelAdapter implementations. The default phase is DEFAULT_MANAGER_PHASE.

Specified by:

getPhase in interface Phased

Specified by:

getPhase in interface SmartLifecycle

Returns:

SmartLifecycle autostart phase

See Also:

• setPhase(int)

addCallback

public void addCallback(ClientManager.ConnectCallback connectCallback)

Description copied from interface: ClientManager

Register a callback for the connectComplete event from the client.

Specified by:

addCallback in interface ClientManager<T,C>

Parameters:

connectCallback - a ClientManager.ConnectCallback to register.

removeCallback

public boolean removeCallback(ClientManager.ConnectCallback connectCallback)

Description copied from interface: ClientManager

Remove the callback from registration.

Specified by:

removeCallback in interface ClientManager<T,C>

Parameters:

connectCallback - a ClientManager.ConnectCallback to unregister.

Returns:

true if callback was removed.

isRunning

public boolean isRunning()

Specified by:

isRunning in interface Lifecycle

setPhase

public void setPhase(int phase)

Set the phase of component autostart in SmartLifecycle. If the custom one is required, note that for the correct behavior it should be less than phase of AbstractMqttMessageDrivenChannelAdapter implementations.

See Also:

• getPhase()