Package org.springframework.integration.mqtt.core

Class DefaultMqttPahoClientFactory

java.lang.Object
org.springframework.integration.mqtt.core.DefaultMqttPahoClientFactory
All Implemented Interfaces:
MqttPahoClientFactory
public class DefaultMqttPahoClientFactory extends Object implements MqttPahoClientFactory
Creates a default MqttClient and a set of options as configured.
Since:
4.0
Author:
Gary Russell, Gunnar Hillert

  • Constructor Details

    • DefaultMqttPahoClientFactory

      public DefaultMqttPahoClientFactory()

  • Method Details

    • setPersistence

      public void setPersistence(org.eclipse.paho.client.mqttv3.MqttClientPersistence persistence)
      Set the persistence to pass into the client constructor.
      Parameters:
      persistence - the persistence to set.

    • getConsumerStopAction

      @Deprecated public ConsumerStopAction getConsumerStopAction()
      Deprecated.
      since 5.5.17 in favor of standard MqttConnectOptions.setCleanSession(boolean). Will be removed in 6.1.0.
      Get the consumer stop action.
      Specified by:
      getConsumerStopAction in interface MqttPahoClientFactory
      Returns:
      the consumer stop action.
      Since:
      4.2.3

    • setConsumerStopAction

      @Deprecated public void setConsumerStopAction(ConsumerStopAction consumerStopAction)
      Deprecated.
      since 5.5.17 in favor of standard MqttConnectOptions.setCleanSession(boolean). Will be removed in 6.1.0.
      Set the consumer stop action. Determines whether we unsubscribe when the consumer stops. Default: ConsumerStopAction.UNSUBSCRIBE_CLEAN.
      Parameters:
      consumerStopAction - the consumer stop action.
      Since:
      4.2.3.

    • getClientInstance

      public org.eclipse.paho.client.mqttv3.IMqttClient getClientInstance(String uri, String clientId) throws org.eclipse.paho.client.mqttv3.MqttException
      Description copied from interface: MqttPahoClientFactory
      Retrieve a client instance.
      Specified by:
      getClientInstance in interface MqttPahoClientFactory
      Parameters:
      uri - The URL.
      clientId - The client id.
      Returns:
      The client instance.
      Throws:
      org.eclipse.paho.client.mqttv3.MqttException - Any.

    • getAsyncClientInstance

      public org.eclipse.paho.client.mqttv3.IMqttAsyncClient getAsyncClientInstance(String uri, String clientId) throws org.eclipse.paho.client.mqttv3.MqttException
      Description copied from interface: MqttPahoClientFactory
      Retrieve an async client instance.
      Specified by:
      getAsyncClientInstance in interface MqttPahoClientFactory
      Parameters:
      uri - The URL.
      clientId - The client id.
      Returns:
      The client instance.
      Throws:
      org.eclipse.paho.client.mqttv3.MqttException - Any.

    • setConnectionOptions

      public void setConnectionOptions(org.eclipse.paho.client.mqttv3.MqttConnectOptions options)
      Set the preconfigured MqttConnectOptions.
      Parameters:
      options - the options.
      Since:
      4.3.16

    • getConnectionOptions

      public org.eclipse.paho.client.mqttv3.MqttConnectOptions getConnectionOptions()
      Description copied from interface: MqttPahoClientFactory
      Retrieve the connection options.
      Specified by:
      getConnectionOptions in interface MqttPahoClientFactory
      Returns:
      The options.