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

  • Field Details

    • logger

      protected final org.apache.commons.logging.Log logger

    • lock

      protected final Lock lock

  • Constructor Details

    • AbstractMqttClientManager

      protected AbstractMqttClientManager(String clientId)

  • Method Details

    • setManualAcks

      public void setManualAcks(boolean manualAcks)

    • getUrl

      public String getUrl()
      Description copied from interface: ClientManager
      Return the managed client url.
      Specified by:
      getUrl in interface ClientManager<T,C>
      Returns:
      the managed client url, never null.

    • setUrl

      protected void setUrl(String url)

    • getClientId

      public String getClientId()
      Description copied from interface: ClientManager
      Return the managed client id.
      Specified by:
      getClientId in interface ClientManager<T,C>
      Returns:
      the managed client id, never null.

    • getApplicationEventPublisher

      protected ApplicationEventPublisher getApplicationEventPublisher()

    • setClient

      protected void setClient(@Nullable T client)

    • getCallbacks

      protected Set<ClientManager.ConnectCallback> getCallbacks()

    • setCompletionTimeout

      public void setCompletionTimeout(long completionTimeout)
      Set the completion timeout for operations. Default 30000L<T,C> 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<T,C> milliseconds.
      Parameters:
      completionTimeout - The timeout.
      Since:
      6.0.3

    • getDisconnectCompletionTimeout

      protected long getDisconnectCompletionTimeout()

    • setQuiescentTimeout

      public void setQuiescentTimeout(long quiescentTimeout)
      Set the quiescentTimeout timeout when disconnecting. Default is ClientManager.QUIESCENT_TIMEOUT milliseconds.
      Parameters:
      quiescentTimeout - The timeout.
      Since:
      7.0.0

    • getQuiescentTimeout

      protected long getQuiescentTimeout()

    • 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 @Nullable 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:

    • 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: