MQTTConfiguration (Camel :: MQTT 2.24.2 API)

java.lang.Object
- org.fusesource.mqtt.client.MQTT
- - org.apache.camel.component.mqtt.MQTTConfiguration

@UriParams
public class MQTTConfiguration
extends org.fusesource.mqtt.client.MQTT

Field Summary

Fields
Modifier and Type Field and Description

static String MQTT_PUBLISH_TOPIC

static String MQTT_SUBSCRIBE_TOPIC
- Fields inherited from class org.fusesource.mqtt.client.MQTT
  connect, tracer, useLocalHost

Fields
Modifier and Type	Field and Description
`static String`	`MQTT_PUBLISH_TOPIC`
`static String`	`MQTT_SUBSCRIBE_TOPIC`

Constructor Summary

Constructors
Constructor and Description

MQTTConfiguration()

Constructors
Constructor and Description
`MQTTConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Executor`	`getBlockingExecutor()`
`long`	`getConnectAttemptsMax()`
`int`	`getConnectWaitInSeconds()`
`int`	`getDisconnectWaitInSeconds()`
`org.fusesource.hawtdispatch.DispatchQueue`	`getDispatchQueue()`
`URI`	`getHost()`
`URI`	`getLocalAddress()`
`int`	`getMaxReadRate()`
`int`	`getMaxWriteRate()`
`String`	`getMqttQosPropertyName()`
`String`	`getMqttRetainPropertyName()`
`String`	`getMqttTopicPropertyName()` Deprecated.
`String`	`getPublishTopicName()`
`org.fusesource.mqtt.client.QoS`	`getQoS()`
`String`	`getQualityOfService()`
`int`	`getReceiveBufferSize()`
`long`	`getReconnectAttemptsMax()`
`double`	`getReconnectBackOffMultiplier()`
`long`	`getReconnectDelay()`
`long`	`getReconnectDelayMax()`
`int`	`getSendBufferSize()`
`int`	`getSendWaitInSeconds()`
`SSLContext`	`getSslContext()`
`String`	`getSubscribeTopicName()` Deprecated.
`String`	`getSubscribeTopicNames()`
`int`	`getTrafficClass()`
`String`	`getVersion()`
`boolean`	`isByDefaultRetain()`
`boolean`	`isLazySessionCreation()`
`void`	`setBlockingExecutor(Executor blockingExecutor)` SSL connections perform blocking operations against internal thread pool unless you call the setBlockingExecutor method to configure that executor they will use instead.
`void`	`setByDefaultRetain(boolean byDefaultRetain)` The default retain policy to be used on messages sent to the MQTT broker
`void`	`setCleanSession(boolean cleanSession)` Set to false if you want the MQTT server to persist topic subscriptions and ack positions across client sessions.
`void`	`setClientId(String clientId)` Use to set the client Id of the session.
`void`	`setConnectAttemptsMax(long connectAttemptsMax)` The maximum number of reconnect attempts before an error is reported back to the client on the first attempt by the client to connect to a server.
`void`	`setConnectWaitInSeconds(int connectWaitInSeconds)` Delay in seconds the Component will wait for a connection to be established to the MQTT broker
`void`	`setDisconnectWaitInSeconds(int disconnectWaitInSeconds)` The number of seconds the Component will wait for a valid disconnect on stop() from the MQTT broker
`void`	`setDispatchQueue(org.fusesource.hawtdispatch.DispatchQueue dispatchQueue)` A HawtDispatch dispatch queue is used to synchronize access to the connection.
`void`	`setHost(String host)` The URI of the MQTT broker to connect too - this component also supports SSL - e.g.
`void`	`setHost(URI host)` The URI of the MQTT broker to connect too - this component also supports SSL - e.g.
`void`	`setKeepAlive(short keepAlive)` Configures the Keep Alive timer in seconds.
`void`	`setLazySessionCreation(boolean lazySessionCreation)` Sessions can be lazily created to avoid exceptions, if the remote server is not up and running when the Camel producer is started.
`void`	`setLocalAddress(String localAddress)` The local InetAddress and port to use
`void`	`setLocalAddress(URI localAddress)`
`void`	`setMaxReadRate(int maxReadRate)` Sets the maximum bytes per second that this transport will receive data at.
`void`	`setMaxWriteRate(int maxWriteRate)` Sets the maximum bytes per second that this transport will send data at.
`void`	`setMqttQosPropertyName(String mqttQosPropertyName)` The property name to look for on an Exchange for an individual published message.
`void`	`setMqttRetainPropertyName(String mqttRetainPropertyName)` The property name to look for on an Exchange for an individual published message.
`void`	`setMqttTopicPropertyName(String mqttTopicPropertyName)` Deprecated.
`void`	`setPassword(String password)` Password to be used for authentication against the MQTT broker
`void`	`setPublishTopicName(String publishTopicName)` The default Topic to publish messages on
`void`	`setQualityOfService(String qualityOfService)` Quality of service level to use for topics.
`void`	`setReceiveBufferSize(int receiveBufferSize)` Sets the size of the internal socket receive buffer.
`void`	`setReconnectAttemptsMax(long reconnectAttemptsMax)` The maximum number of reconnect attempts before an error is reported back to the client after a server connection had previously been established.
`void`	`setReconnectBackOffMultiplier(double reconnectBackOffMultiplier)` The Exponential backoff be used between reconnect attempts.
`void`	`setReconnectDelay(long reconnectDelay)` How long to wait in ms before the first reconnect attempt.
`void`	`setReconnectDelayMax(long reconnectDelayMax)` The maximum amount of time in ms to wait between reconnect attempts.
`void`	`setSendBufferSize(int sendBufferSize)` Sets the size of the internal socket send buffer.
`void`	`setSendWaitInSeconds(int sendWaitInSeconds)` The maximum time the Component will wait for a receipt from the MQTT broker to acknowledge a published message before throwing an exception
`void`	`setSslContext(SSLContext sslContext)` To configure security using SSLContext configuration
`void`	`setSubscribeTopicName(String subscribeTopicName)` Deprecated.
`void`	`setSubscribeTopicNames(String subscribeTopicNames)` A comma-delimited list of Topics to subscribe to for messages.
`void`	`setTrafficClass(int trafficClass)` Sets traffic class or type-of-service octet in the IP header for packets sent from the transport.
`void`	`setUserName(String userName)` Username to be used for authentication against the MQTT broker
`void`	`setVersion(String version)` Set to 3.1.1 to use MQTT version 3.1.1.
`void`	`setWillMessage(String willMessage)` The Will message to send.
`void`	`setWillQos(org.fusesource.mqtt.client.QoS willQos)` Sets the quality of service to use for the Will message.
`void`	`setWillRetain(boolean willRetain)` Set to true if you want the Will to be published with the retain option.
`void`	`setWillTopic(String willTopic)` If set the server will publish the client's Will message to the specified topics if the client has an unexpected disconnection.

Methods inherited from class org.fusesource.mqtt.client.MQTT
blockingConnection, callbackConnection, futureConnection, getBlockingThreadPool, getClientId, getKeepAlive, getPassword, getTracer, getType, getUserName, getWillMessage, getWillQos, getWillTopic, isCleanSession, isUseLocalHost, isWillRetain, setBlockingThreadPool, setClientId, setHost, setPassword, setTracer, setUseLocalHost, setUserName, setWillMessage, setWillTopic

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MQTT_SUBSCRIBE_TOPIC
```
public static final String MQTT_SUBSCRIBE_TOPIC
```
    See Also:
    
    Constant Field Values
  - MQTT_PUBLISH_TOPIC
```
public static final String MQTT_PUBLISH_TOPIC
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MQTTConfiguration
```
public MQTTConfiguration()
```
- Method Detail
  - getQualityOfService
```
public String getQualityOfService()
```
  - setQualityOfService
```
public void setQualityOfService(String qualityOfService)
```
    Quality of service level to use for topics.
  - getQoS
```
public org.fusesource.mqtt.client.QoS getQoS()
```
  - getSubscribeTopicName
```
@Deprecated
public String getSubscribeTopicName()
```
    Deprecated.
  - setSubscribeTopicName
```
@Deprecated
public void setSubscribeTopicName(String subscribeTopicName)
```
    Deprecated.
    
    The name of the Topic to subscribe to for messages.
  - getSubscribeTopicNames
```
public String getSubscribeTopicNames()
```
  - setSubscribeTopicNames
```
public void setSubscribeTopicNames(String subscribeTopicNames)
```
    A comma-delimited list of Topics to subscribe to for messages. Note that each item of this list can contain MQTT wildcards (+ and/or #), in order to subscribe to topics matching a certain pattern within a hierarchy. For example, + is a wildcard for all topics at a level within the hierarchy, so if a broker has topics topics/one and topics/two, then topics/+ can be used to subscribe to both. A caveat to consider here is that if the broker adds topics/three, the route would also begin to receive messages from that topic.
  - getPublishTopicName
```
public String getPublishTopicName()
```
  - setPublishTopicName
```
public void setPublishTopicName(String publishTopicName)
```
    The default Topic to publish messages on
  - getMqttTopicPropertyName
```
@Deprecated
public String getMqttTopicPropertyName()
```
    Deprecated.
    
    Please use MQTT_SUBSCRIBE_TOPIC and MQTT_PUBLISH_TOPIC to set or get the topic name
  - setMqttTopicPropertyName
```
@Deprecated
public void setMqttTopicPropertyName(String mqttTopicPropertyName)
```
    Deprecated.
    
    Please use MQTT_SUBSCRIBE_TOPIC and MQTT_PUBLISH_TOPIC to set or get the topic name
  - getMqttRetainPropertyName
```
public String getMqttRetainPropertyName()
```
  - setMqttRetainPropertyName
```
public void setMqttRetainPropertyName(String mqttRetainPropertyName)
```
    The property name to look for on an Exchange for an individual published message. If this is set (expects a Boolean value) - then the retain property will be set on the message sent to the MQTT message broker.
  - getMqttQosPropertyName
```
public String getMqttQosPropertyName()
```
  - setMqttQosPropertyName
```
public void setMqttQosPropertyName(String mqttQosPropertyName)
```
    The property name to look for on an Exchange for an individual published message. If this is set (one of AtMostOnce, AtLeastOnce or ExactlyOnce ) - then that QoS will be set on the message sent to the MQTT message broker.
  - getConnectWaitInSeconds
```
public int getConnectWaitInSeconds()
```
  - setConnectWaitInSeconds
```
public void setConnectWaitInSeconds(int connectWaitInSeconds)
```
    Delay in seconds the Component will wait for a connection to be established to the MQTT broker
  - getDisconnectWaitInSeconds
```
public int getDisconnectWaitInSeconds()
```
  - setDisconnectWaitInSeconds
```
public void setDisconnectWaitInSeconds(int disconnectWaitInSeconds)
```
    The number of seconds the Component will wait for a valid disconnect on stop() from the MQTT broker
  - getSendWaitInSeconds
```
public int getSendWaitInSeconds()
```
  - setSendWaitInSeconds
```
public void setSendWaitInSeconds(int sendWaitInSeconds)
```
    The maximum time the Component will wait for a receipt from the MQTT broker to acknowledge a published message before throwing an exception
  - isByDefaultRetain
```
public boolean isByDefaultRetain()
```
  - setByDefaultRetain
```
public void setByDefaultRetain(boolean byDefaultRetain)
```
    The default retain policy to be used on messages sent to the MQTT broker
  - setClientId
```
public void setClientId(String clientId)
```
    Use to set the client Id of the session. This is what an MQTT server uses to identify a session where setCleanSession(false); is being used. The id must be 23 characters or less. Defaults to auto generated id (based on your socket address, port and timestamp).
    
    Overrides:
    
    setClientId in class org.fusesource.mqtt.client.MQTT
  - setCleanSession
```
public void setCleanSession(boolean cleanSession)
```
    Set to false if you want the MQTT server to persist topic subscriptions and ack positions across client sessions. Defaults to true.
    
    Overrides:
    
    setCleanSession in class org.fusesource.mqtt.client.MQTT
  - setKeepAlive
```
public void setKeepAlive(short keepAlive)
```
    Configures the Keep Alive timer in seconds. Defines the maximum time interval between messages received from a client. It enables the server to detect that the network connection to a client has dropped, without having to wait for the long TCP/IP timeout.
    
    Overrides:
    
    setKeepAlive in class org.fusesource.mqtt.client.MQTT
  - setPassword
```
public void setPassword(String password)
```
    Password to be used for authentication against the MQTT broker
    
    Overrides:
    
    setPassword in class org.fusesource.mqtt.client.MQTT
  - setUserName
```
public void setUserName(String userName)
```
    Username to be used for authentication against the MQTT broker
    
    Overrides:
    
    setUserName in class org.fusesource.mqtt.client.MQTT
  - setWillMessage
```
public void setWillMessage(String willMessage)
```
    The Will message to send. Defaults to a zero length message.
    
    Overrides:
    
    setWillMessage in class org.fusesource.mqtt.client.MQTT
  - setWillQos
```
public void setWillQos(org.fusesource.mqtt.client.QoS willQos)
```
    Sets the quality of service to use for the Will message. Defaults to AT_MOST_ONCE.
    
    Overrides:
    
    setWillQos in class org.fusesource.mqtt.client.MQTT
  - setVersion
```
public void setVersion(String version)
```
    Set to 3.1.1 to use MQTT version 3.1.1. Otherwise defaults to the 3.1 protocol version.
    
    Overrides:
    
    setVersion in class org.fusesource.mqtt.client.MQTT
  - getVersion
```
public String getVersion()
```
    Overrides:
    
    getVersion in class org.fusesource.mqtt.client.MQTT
  - setWillRetain
```
public void setWillRetain(boolean willRetain)
```
    Set to true if you want the Will to be published with the retain option.
    
    Overrides:
    
    setWillRetain in class org.fusesource.mqtt.client.MQTT
  - setWillTopic
```
public void setWillTopic(String willTopic)
```
    If set the server will publish the client's Will message to the specified topics if the client has an unexpected disconnection.
    
    Overrides:
    
    setWillTopic in class org.fusesource.mqtt.client.MQTT
  - getBlockingExecutor
```
public Executor getBlockingExecutor()
```
    Overrides:
    
    getBlockingExecutor in class org.fusesource.mqtt.client.MQTT
  - setBlockingExecutor
```
public void setBlockingExecutor(Executor blockingExecutor)
```
    SSL connections perform blocking operations against internal thread pool unless you call the setBlockingExecutor method to configure that executor they will use instead.
    
    Overrides:
    
    setBlockingExecutor in class org.fusesource.mqtt.client.MQTT
  - getDispatchQueue
```
public org.fusesource.hawtdispatch.DispatchQueue getDispatchQueue()
```
    Overrides:
    
    getDispatchQueue in class org.fusesource.mqtt.client.MQTT
  - setDispatchQueue
```
public void setDispatchQueue(org.fusesource.hawtdispatch.DispatchQueue dispatchQueue)
```
    A HawtDispatch dispatch queue is used to synchronize access to the connection. If an explicit queue is not configured via the setDispatchQueue method, then a new queue will be created for the connection. Setting an explicit queue might be handy if you want multiple connection to share the same queue for synchronization.
    
    Overrides:
    
    setDispatchQueue in class org.fusesource.mqtt.client.MQTT
  - getLocalAddress
```
public URI getLocalAddress()
```
    Overrides:
    
    getLocalAddress in class org.fusesource.mqtt.client.MQTT
  - setLocalAddress
```
public void setLocalAddress(String localAddress)
                     throws URISyntaxException
```
    The local InetAddress and port to use
    
    Overrides:
    
    setLocalAddress in class org.fusesource.mqtt.client.MQTT
    
    Throws:
    
    URISyntaxException
  - setLocalAddress
```
public void setLocalAddress(URI localAddress)
```
    Overrides:
    
    setLocalAddress in class org.fusesource.mqtt.client.MQTT
  - getMaxReadRate
```
public int getMaxReadRate()
```
    Overrides:
    
    getMaxReadRate in class org.fusesource.mqtt.client.MQTT
  - setMaxReadRate
```
public void setMaxReadRate(int maxReadRate)
```
    Sets the maximum bytes per second that this transport will receive data at. This setting throttles reads so that the rate is not exceeded. Defaults to 0 which disables throttling.
    
    Overrides:
    
    setMaxReadRate in class org.fusesource.mqtt.client.MQTT
  - getMaxWriteRate
```
public int getMaxWriteRate()
```
    Overrides:
    
    getMaxWriteRate in class org.fusesource.mqtt.client.MQTT
  - setMaxWriteRate
```
public void setMaxWriteRate(int maxWriteRate)
```
    Sets the maximum bytes per second that this transport will send data at. This setting throttles writes so that the rate is not exceeded. Defaults to 0 which disables throttling.
    
    Overrides:
    
    setMaxWriteRate in class org.fusesource.mqtt.client.MQTT
  - getReceiveBufferSize
```
public int getReceiveBufferSize()
```
    Overrides:
    
    getReceiveBufferSize in class org.fusesource.mqtt.client.MQTT
  - setReceiveBufferSize
```
public void setReceiveBufferSize(int receiveBufferSize)
```
    Sets the size of the internal socket receive buffer. Defaults to 65536 (64k)
    
    Overrides:
    
    setReceiveBufferSize in class org.fusesource.mqtt.client.MQTT
  - getHost
```
public URI getHost()
```
    Overrides:
    
    getHost in class org.fusesource.mqtt.client.MQTT
  - setHost
```
public void setHost(String host)
             throws URISyntaxException
```
    The URI of the MQTT broker to connect too - this component also supports SSL - e.g. ssl://127.0.0.1:8883
    
    Overrides:
    
    setHost in class org.fusesource.mqtt.client.MQTT
    
    Throws:
    
    URISyntaxException
  - setHost
```
public void setHost(URI host)
```
    The URI of the MQTT broker to connect too - this component also supports SSL - e.g. ssl://127.0.0.1:8883
    
    Overrides:
    
    setHost in class org.fusesource.mqtt.client.MQTT
  - getSendBufferSize
```
public int getSendBufferSize()
```
    Overrides:
    
    getSendBufferSize in class org.fusesource.mqtt.client.MQTT
  - setSendBufferSize
```
public void setSendBufferSize(int sendBufferSize)
```
    Sets the size of the internal socket send buffer. Defaults to 65536 (64k)
    
    Overrides:
    
    setSendBufferSize in class org.fusesource.mqtt.client.MQTT
  - getSslContext
```
public SSLContext getSslContext()
```
    Overrides:
    
    getSslContext in class org.fusesource.mqtt.client.MQTT
  - setSslContext
```
public void setSslContext(SSLContext sslContext)
```
    To configure security using SSLContext configuration
    
    Overrides:
    
    setSslContext in class org.fusesource.mqtt.client.MQTT
  - getTrafficClass
```
public int getTrafficClass()
```
    Overrides:
    
    getTrafficClass in class org.fusesource.mqtt.client.MQTT
  - setTrafficClass
```
public void setTrafficClass(int trafficClass)
```
    Sets traffic class or type-of-service octet in the IP header for packets sent from the transport. Defaults to 8 which means the traffic should be optimized for throughput.
    
    Overrides:
    
    setTrafficClass in class org.fusesource.mqtt.client.MQTT
  - getConnectAttemptsMax
```
public long getConnectAttemptsMax()
```
    Overrides:
    
    getConnectAttemptsMax in class org.fusesource.mqtt.client.MQTT
  - setConnectAttemptsMax
```
public void setConnectAttemptsMax(long connectAttemptsMax)
```
    The maximum number of reconnect attempts before an error is reported back to the client on the first attempt by the client to connect to a server. Set to -1 to use unlimited attempts. Defaults to -1.
    
    Overrides:
    
    setConnectAttemptsMax in class org.fusesource.mqtt.client.MQTT
  - getReconnectAttemptsMax
```
public long getReconnectAttemptsMax()
```
    Overrides:
    
    getReconnectAttemptsMax in class org.fusesource.mqtt.client.MQTT
  - setReconnectAttemptsMax
```
public void setReconnectAttemptsMax(long reconnectAttemptsMax)
```
    The maximum number of reconnect attempts before an error is reported back to the client after a server connection had previously been established. Set to -1 to use unlimited attempts. Defaults to -1.
    
    Overrides:
    
    setReconnectAttemptsMax in class org.fusesource.mqtt.client.MQTT
  - getReconnectBackOffMultiplier
```
public double getReconnectBackOffMultiplier()
```
    Overrides:
    
    getReconnectBackOffMultiplier in class org.fusesource.mqtt.client.MQTT
  - setReconnectBackOffMultiplier
```
public void setReconnectBackOffMultiplier(double reconnectBackOffMultiplier)
```
    The Exponential backoff be used between reconnect attempts. Set to 1 to disable exponential backoff. Defaults to 2.
    
    Overrides:
    
    setReconnectBackOffMultiplier in class org.fusesource.mqtt.client.MQTT
  - getReconnectDelay
```
public long getReconnectDelay()
```
    Overrides:
    
    getReconnectDelay in class org.fusesource.mqtt.client.MQTT
  - setReconnectDelay
```
public void setReconnectDelay(long reconnectDelay)
```
    How long to wait in ms before the first reconnect attempt. Defaults to 10.
    
    Overrides:
    
    setReconnectDelay in class org.fusesource.mqtt.client.MQTT
  - getReconnectDelayMax
```
public long getReconnectDelayMax()
```
    Overrides:
    
    getReconnectDelayMax in class org.fusesource.mqtt.client.MQTT
  - setReconnectDelayMax
```
public void setReconnectDelayMax(long reconnectDelayMax)
```
    The maximum amount of time in ms to wait between reconnect attempts. Defaults to 30,000.
    
    Overrides:
    
    setReconnectDelayMax in class org.fusesource.mqtt.client.MQTT
  - isLazySessionCreation
```
public boolean isLazySessionCreation()
```
  - setLazySessionCreation
```
public void setLazySessionCreation(boolean lazySessionCreation)
```
    Sessions can be lazily created to avoid exceptions, if the remote server is not up and running when the Camel producer is started.

Class MQTTConfiguration

Field Summary

Fields inherited from class org.fusesource.mqtt.client.MQTT

Constructor Summary

Method Summary

Methods inherited from class org.fusesource.mqtt.client.MQTT

Methods inherited from class java.lang.Object

Field Detail

MQTT_SUBSCRIBE_TOPIC

MQTT_PUBLISH_TOPIC

Constructor Detail

MQTTConfiguration

Method Detail

getQualityOfService

setQualityOfService

getQoS

getSubscribeTopicName

setSubscribeTopicName

getSubscribeTopicNames

setSubscribeTopicNames

getPublishTopicName

setPublishTopicName

getMqttTopicPropertyName

setMqttTopicPropertyName

getMqttRetainPropertyName

setMqttRetainPropertyName

getMqttQosPropertyName

setMqttQosPropertyName

getConnectWaitInSeconds

setConnectWaitInSeconds

getDisconnectWaitInSeconds

setDisconnectWaitInSeconds

getSendWaitInSeconds

setSendWaitInSeconds

isByDefaultRetain

setByDefaultRetain

setClientId

setCleanSession

setKeepAlive

setPassword

setUserName

setWillMessage

setWillQos

setVersion

getVersion

setWillRetain

setWillTopic

getBlockingExecutor

setBlockingExecutor

getDispatchQueue

setDispatchQueue

getLocalAddress

setLocalAddress

setLocalAddress

getMaxReadRate

setMaxReadRate

getMaxWriteRate

setMaxWriteRate

getReceiveBufferSize

setReceiveBufferSize

getHost

setHost

setHost

getSendBufferSize

setSendBufferSize

getSslContext

setSslContext

getTrafficClass

setTrafficClass

getConnectAttemptsMax

setConnectAttemptsMax

getReconnectAttemptsMax

setReconnectAttemptsMax

getReconnectBackOffMultiplier

setReconnectBackOffMultiplier

getReconnectDelay

setReconnectDelay

getReconnectDelayMax

setReconnectDelayMax

isLazySessionCreation