Package de.iip_ecosphere.platform.transport.spring.binder.mqttv3

Class MqttConfiguration

java.lang.Object
de.iip_ecosphere.platform.transport.spring.BasicConfiguration
de.iip_ecosphere.platform.transport.spring.binder.mqttv3.MqttConfiguration
@ConfigurationProperties(prefix="mqtt") public class MqttConfiguration extends de.iip_ecosphere.platform.transport.spring.BasicConfiguration
Represents the configuration options of a MQTT v3 client.
Author:
Holger Eichelberger, SSE

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private int
    actionTimeout
     
    private boolean
    autoClientId
     
    private String
    clientId
     
    private List<String>
    filteredTopics
     
    private int
    keepAlive
     
    private String
    qos
     
    private String
    schema
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    MqttConfiguration()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getActionTimeout()
    Returns the action timeout to wait for the broker to complete an action.
    boolean
    getAutoClientId()
    Returns whether making the client ID unique is enabled.
    String
    getBrokerString()
    Returns the broker connection string consisting of getSchema(), BasicConfiguration.getHost() and BasicConfiguration.getPort().
    String
    getClientId()
    Returns the client identification.
    List<String>
    getFilteredTopics()
    Returns all filtered topics.
    int
    getKeepAlive()
    Returns the keep-alive time between heartbeats.
    de.iip_ecosphere.platform.transport.connectors.basics.MqttQoS
    getQos()
    Returns the QoS level for sending.
    String
    getSchema()
    Returns the connection schema.
    boolean
    isFilteredTopic(String topic)
    Returns whether topic is a filtered topic, i.e., we shall not subscribe to this topic.
    void
    setActionTimeout(int actionTimeout)
    Changes the action timeout to wait for the broker to complete an action.
    void
    setAutoClientId(boolean autoClientId)
    Changes whether the client identification is expected to be unique or shall be made unique upon first connect.
    void
    setClientId(String clientId)
    Changes the client identification.
    void
    setFilteredTopics(List<String> filteredTopics)
    Changes all filtered topics.
    void
    setKeepAlive(int keepAlive)
    Changes the keep-alive time between heartbeats.
    void
    setQos(String qos)
    Defines the QoS level.
    void
    setSchema(String schema)
    Changes the connection schema.
    de.iip_ecosphere.platform.transport.connectors.TransportParameter
    toTransportParameter()
    Turns the actual configuration into a TransportParameter instance.

    Methods inherited from class de.iip_ecosphere.platform.transport.spring.BasicConfiguration

    createTlsContext, createTransportParameterBuilder, createTrustManagerFactory, getAuthenticationKey, getHost, getHostnameVerification, getKeyAlias, getKeystoreKey, getPort, setAuthenticationKey, setHost, setHostnameVerification, setKeyAlias, setKeystoreKey, setPort, useTls

    Methods inherited from class java.lang.Object

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

  • Field Details

    • schema

      private String schema

    • clientId

      private String clientId

    • autoClientId

      private boolean autoClientId

    • keepAlive

      private int keepAlive

    • actionTimeout

      private int actionTimeout

    • filteredTopics

      private List<String> filteredTopics

    • qos

      private String qos

  • Constructor Details

    • MqttConfiguration

      public MqttConfiguration()

  • Method Details

    • isFilteredTopic

      public boolean isFilteredTopic(String topic)
      Returns whether topic is a filtered topic, i.e., we shall not subscribe to this topic.
      Parameters:
      topic - the topic name
      Returns:
      true if the topic is filtered (no subscription), false else

    • getFilteredTopics

      public List<String> getFilteredTopics()
      Returns all filtered topics.
      Returns:
      the filtered topics
      See Also:

    • getBrokerString

      public String getBrokerString()
      Returns the broker connection string consisting of getSchema(), BasicConfiguration.getHost() and BasicConfiguration.getPort().
      Returns:
      the broker connection string

    • getSchema

      public String getSchema()
      Returns the connection schema.
      Returns:
      the connection schema ("tcp" by default)

    • getClientId

      public String getClientId()
      Returns the client identification.
      Returns:
      the client identification

    • getAutoClientId

      public boolean getAutoClientId()
      Returns whether making the client ID unique is enabled.
      Returns:
      true for enabled (default), false else

    • getKeepAlive

      public int getKeepAlive()
      Returns the keep-alive time between heartbeats.
      Returns:
      the keep-alive time in ms (60000 by default)

    • getActionTimeout

      public int getActionTimeout()
      Returns the action timeout to wait for the broker to complete an action.
      Returns:
      the action timeout in ms (1000 by default)

    • getQos

      public de.iip_ecosphere.platform.transport.connectors.basics.MqttQoS getQos()
      Returns the QoS level for sending.
      Returns:
      the QoS level

    • setSchema

      public void setSchema(String schema)
      Changes the connection schema. [required by Spring]
      Parameters:
      schema - the connection schema

    • setClientId

      public void setClientId(String clientId)
      Changes the client identification. [required by Spring]
      Parameters:
      clientId - the client identification

    • setAutoClientId

      public void setAutoClientId(boolean autoClientId)
      Changes whether the client identification is expected to be unique or shall be made unique upon first connect. [required by Spring]
      Parameters:
      autoClientId - true (default) for make unique, false else

    • setKeepAlive

      public void setKeepAlive(int keepAlive)
      Changes the keep-alive time between heartbeats. [required by Spring]
      Parameters:
      keepAlive - the keep-alive time in ms

    • setActionTimeout

      public void setActionTimeout(int actionTimeout)
      Changes the action timeout to wait for the broker to complete an action. [required by Spring]
      Parameters:
      actionTimeout - the action timeout in ms (60000 by default)

    • setFilteredTopics

      public void setFilteredTopics(List<String> filteredTopics)
      Changes all filtered topics. [required by Spring]
      Parameters:
      filteredTopics - the new filtered topics
      See Also:

    • setQos

      public void setQos(String qos)
      Defines the QoS level.
      Parameters:
      qos - the QoS level, ignored if invalid, see MqttQoS

    • toTransportParameter

      public de.iip_ecosphere.platform.transport.connectors.TransportParameter toTransportParameter()
      Turns the actual configuration into a TransportParameter instance.
      Overrides:
      toTransportParameter in class de.iip_ecosphere.platform.transport.spring.BasicConfiguration
      Returns:
      the transport parameter instance