PahoComponentBuilderFactory.PahoComponentBuilder (Camel

All Superinterfaces:

ComponentBuilder<org.apache.camel.component.paho.PahoComponent>

All Known Implementing Classes:

PahoComponentBuilderFactory.PahoComponentBuilderImpl

Enclosing interface:

PahoComponentBuilderFactory
```
public static interface PahoComponentBuilderFactory.PahoComponentBuilder
extends ComponentBuilder<org.apache.camel.component.paho.PahoComponent>
```
Builder for the Paho component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default PahoComponentBuilderFactory.PahoComponentBuilder`	`automaticReconnect(boolean automaticReconnect)` Sets whether the client will automatically attempt to reconnect to the server if the connection is lost.
`default PahoComponentBuilderFactory.PahoComponentBuilder`	`basicPropertyBinding(boolean basicPropertyBinding)` Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities.
`default PahoComponentBuilderFactory.PahoComponentBuilder`	`bridgeErrorHandler(boolean bridgeErrorHandler)` Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler.
`default PahoComponentBuilderFactory.PahoComponentBuilder`	`brokerUrl(String brokerUrl)` The URL of the MQTT broker.
`default PahoComponentBuilderFactory.PahoComponentBuilder`	`cleanSession(boolean cleanSession)` Sets whether the client and server should remember state across restarts and reconnects.
`default PahoComponentBuilderFactory.PahoComponentBuilder`	`client(org.eclipse.paho.client.mqttv3.MqttClient client)` To use a shared Paho client.
`default PahoComponentBuilderFactory.PahoComponentBuilder`	`clientId(String clientId)` MQTT client identifier.
`default PahoComponentBuilderFactory.PahoComponentBuilder`	`configuration(org.apache.camel.component.paho.PahoConfiguration configuration)` To use the shared Paho configuration.
`default PahoComponentBuilderFactory.PahoComponentBuilder`	`connectionTimeout(int connectionTimeout)` Sets the connection timeout value.
`default PahoComponentBuilderFactory.PahoComponentBuilder`	`customWebSocketHeaders(Properties customWebSocketHeaders)` Sets the Custom WebSocket Headers for the WebSocket Connection.
`default PahoComponentBuilderFactory.PahoComponentBuilder`	`executorServiceTimeout(int executorServiceTimeout)` Set the time in seconds that the executor service should wait when terminating before forcefully terminating.
`default PahoComponentBuilderFactory.PahoComponentBuilder`	`filePersistenceDirectory(String filePersistenceDirectory)` Base directory used by file persistence.
`default PahoComponentBuilderFactory.PahoComponentBuilder`	`httpsHostnameVerificationEnabled(boolean httpsHostnameVerificationEnabled)` Whether SSL HostnameVerifier is enabled or not.
`default PahoComponentBuilderFactory.PahoComponentBuilder`	`keepAliveInterval(int keepAliveInterval)` Sets the keep alive interval.
`default PahoComponentBuilderFactory.PahoComponentBuilder`	`lazyStartProducer(boolean lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default PahoComponentBuilderFactory.PahoComponentBuilder`	`maxInflight(int maxInflight)` Sets the max inflight.
`default PahoComponentBuilderFactory.PahoComponentBuilder`	`maxReconnectDelay(int maxReconnectDelay)` Get the maximum time (in millis) to wait between reconnects.
`default PahoComponentBuilderFactory.PahoComponentBuilder`	`mqttVersion(int mqttVersion)` Sets the MQTT version.
`default PahoComponentBuilderFactory.PahoComponentBuilder`	`password(String password)` Password to be used for authentication against the MQTT broker.
`default PahoComponentBuilderFactory.PahoComponentBuilder`	`persistence(org.apache.camel.component.paho.PahoPersistence persistence)` Client persistence to be used - memory or file.
`default PahoComponentBuilderFactory.PahoComponentBuilder`	`qos(int qos)` Client quality of service level (0-2).
`default PahoComponentBuilderFactory.PahoComponentBuilder`	`retained(boolean retained)` Retain option.
`default PahoComponentBuilderFactory.PahoComponentBuilder`	`serverURIs(String serverURIs)` Set a list of one or more serverURIs the client may connect to.
`default PahoComponentBuilderFactory.PahoComponentBuilder`	`socketFactory(SocketFactory socketFactory)` Sets the SocketFactory to use.
`default PahoComponentBuilderFactory.PahoComponentBuilder`	`sslClientProps(Properties sslClientProps)` Sets the SSL properties for the connection.
`default PahoComponentBuilderFactory.PahoComponentBuilder`	`sslHostnameVerifier(HostnameVerifier sslHostnameVerifier)` Sets the HostnameVerifier for the SSL connection.
`default PahoComponentBuilderFactory.PahoComponentBuilder`	`userName(String userName)` Username to be used for authentication against the MQTT broker.
`default PahoComponentBuilderFactory.PahoComponentBuilder`	`willPayload(String willPayload)` Sets the Last Will and Testament (LWT) for the connection.
`default PahoComponentBuilderFactory.PahoComponentBuilder`	`willQos(int willQos)` Sets the Last Will and Testament (LWT) for the connection.
`default PahoComponentBuilderFactory.PahoComponentBuilder`	`willRetained(boolean willRetained)` Sets the Last Will and Testament (LWT) for the connection.
`default PahoComponentBuilderFactory.PahoComponentBuilder`	`willTopic(String willTopic)` Sets the Last Will and Testament (LWT) for the connection.

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder
build, build, doSetProperty, register

- Method Detail
  - automaticReconnect
```
default PahoComponentBuilderFactory.PahoComponentBuilder automaticReconnect(boolean automaticReconnect)
```
    Sets whether the client will automatically attempt to reconnect to the server if the connection is lost. If set to false, the client will not attempt to automatically reconnect to the server in the event that the connection is lost. If set to true, in the event that the connection is lost, the client will attempt to reconnect to the server. It will initially wait 1 second before it attempts to reconnect, for every failed reconnect attempt, the delay will double until it is at 2 minutes at which point the delay will stay at 2 minutes. The option is a: boolean type. Default: true Group: common
  - brokerUrl
```
default PahoComponentBuilderFactory.PahoComponentBuilder brokerUrl(String brokerUrl)
```
    The URL of the MQTT broker. The option is a: java.lang.String type. Default: tcp://localhost:1883 Group: common
  - cleanSession
```
default PahoComponentBuilderFactory.PahoComponentBuilder cleanSession(boolean cleanSession)
```
    Sets whether the client and server should remember state across restarts and reconnects. If set to false both the client and server will maintain state across restarts of the client, the server and the connection. As state is maintained: Message delivery will be reliable meeting the specified QOS even if the client, server or connection are restarted. The server will treat a subscription as durable. If set to true the client and server will not maintain state across restarts of the client, the server or the connection. This means Message delivery to the specified QOS cannot be maintained if the client, server or connection are restarted The server will treat a subscription as non-durable. The option is a: boolean type. Default: true Group: common
  - clientId
```
default PahoComponentBuilderFactory.PahoComponentBuilder clientId(String clientId)
```
    MQTT client identifier. The identifier must be unique. The option is a: java.lang.String type. Group: common
  - configuration
```
default PahoComponentBuilderFactory.PahoComponentBuilder configuration(org.apache.camel.component.paho.PahoConfiguration configuration)
```
    To use the shared Paho configuration. The option is a: org.apache.camel.component.paho.PahoConfiguration type. Group: common
  - connectionTimeout
```
default PahoComponentBuilderFactory.PahoComponentBuilder connectionTimeout(int connectionTimeout)
```
    Sets the connection timeout value. This value, measured in seconds, defines the maximum time interval the client will wait for the network connection to the MQTT server to be established. The default timeout is 30 seconds. A value of 0 disables timeout processing meaning the client will wait until the network connection is made successfully or fails. The option is a: int type. Default: 30 Group: common
  - filePersistenceDirectory
```
default PahoComponentBuilderFactory.PahoComponentBuilder filePersistenceDirectory(String filePersistenceDirectory)
```
    Base directory used by file persistence. Will by default use user directory. The option is a: java.lang.String type. Group: common
  - keepAliveInterval
```
default PahoComponentBuilderFactory.PahoComponentBuilder keepAliveInterval(int keepAliveInterval)
```
    Sets the keep alive interval. This value, measured in seconds, defines the maximum time interval between messages sent or received. It enables the client to detect if the server is no longer available, without having to wait for the TCP/IP timeout. The client will ensure that at least one message travels across the network within each keep alive period. In the absence of a data-related message during the time period, the client sends a very small ping message, which the server will acknowledge. A value of 0 disables keepalive processing in the client. The default value is 60 seconds. The option is a: int type. Default: 60 Group: common
  - maxInflight
```
default PahoComponentBuilderFactory.PahoComponentBuilder maxInflight(int maxInflight)
```
    Sets the max inflight. please increase this value in a high traffic environment. The default value is 10. The option is a: int type. Default: 10 Group: common
  - maxReconnectDelay
```
default PahoComponentBuilderFactory.PahoComponentBuilder maxReconnectDelay(int maxReconnectDelay)
```
    Get the maximum time (in millis) to wait between reconnects. The option is a: int type. Default: 128000 Group: common
  - mqttVersion
```
default PahoComponentBuilderFactory.PahoComponentBuilder mqttVersion(int mqttVersion)
```
    Sets the MQTT version. The default action is to connect with version 3.1.1, and to fall back to 3.1 if that fails. Version 3.1.1 or 3.1 can be selected specifically, with no fall back, by using the MQTT_VERSION_3_1_1 or MQTT_VERSION_3_1 options respectively. The option is a: int type. Group: common
  - persistence
```
default PahoComponentBuilderFactory.PahoComponentBuilder persistence(org.apache.camel.component.paho.PahoPersistence persistence)
```
    Client persistence to be used - memory or file. The option is a: org.apache.camel.component.paho.PahoPersistence type. Default: MEMORY Group: common
  - qos
```
default PahoComponentBuilderFactory.PahoComponentBuilder qos(int qos)
```
    Client quality of service level (0-2). The option is a: int type. Default: 2 Group: common
  - retained
```
default PahoComponentBuilderFactory.PahoComponentBuilder retained(boolean retained)
```
    Retain option. The option is a: boolean type. Default: false Group: common
  - serverURIs
```
default PahoComponentBuilderFactory.PahoComponentBuilder serverURIs(String serverURIs)
```
    Set a list of one or more serverURIs the client may connect to. Multiple servers can be separated by comma. Each serverURI specifies the address of a server that the client may connect to. Two types of connection are supported tcp:// for a TCP connection and ssl:// for a TCP connection secured by SSL/TLS. For example: tcp://localhost:1883 ssl://localhost:8883 If the port is not specified, it will default to 1883 for tcp:// URIs, and 8883 for ssl:// URIs. If serverURIs is set then it overrides the serverURI parameter passed in on the constructor of the MQTT client. When an attempt to connect is initiated the client will start with the first serverURI in the list and work through the list until a connection is established with a server. If a connection cannot be made to any of the servers then the connect attempt fails. Specifying a list of servers that a client may connect to has several uses: High Availability and reliable message delivery Some MQTT servers support a high availability feature where two or more equal MQTT servers share state. An MQTT client can connect to any of the equal servers and be assured that messages are reliably delivered and durable subscriptions are maintained no matter which server the client connects to. The cleansession flag must be set to false if durable subscriptions and/or reliable message delivery is required. Hunt List A set of servers may be specified that are not equal (as in the high availability option). As no state is shared across the servers reliable message delivery and durable subscriptions are not valid. The cleansession flag must be set to true if the hunt list mode is used. The option is a: java.lang.String type. Group: common
  - willPayload
```
default PahoComponentBuilderFactory.PahoComponentBuilder willPayload(String willPayload)
```
    Sets the Last Will and Testament (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details. The topic to publish to The byte payload for the message. The quality of service to publish the message at (0, 1 or 2). Whether or not the message should be retained. The option is a: java.lang.String type. Group: common
  - willQos
```
default PahoComponentBuilderFactory.PahoComponentBuilder willQos(int willQos)
```
    Sets the Last Will and Testament (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details. The topic to publish to The byte payload for the message. The quality of service to publish the message at (0, 1 or 2). Whether or not the message should be retained. The option is a: int type. Group: common
  - willRetained
```
default PahoComponentBuilderFactory.PahoComponentBuilder willRetained(boolean willRetained)
```
    Sets the Last Will and Testament (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details. The topic to publish to The byte payload for the message. The quality of service to publish the message at (0, 1 or 2). Whether or not the message should be retained. The option is a: boolean type. Default: false Group: common
  - willTopic
```
default PahoComponentBuilderFactory.PahoComponentBuilder willTopic(String willTopic)
```
    Sets the Last Will and Testament (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details. The topic to publish to The byte payload for the message. The quality of service to publish the message at (0, 1 or 2). Whether or not the message should be retained. The option is a: java.lang.String type. Group: common
  - bridgeErrorHandler
```
default PahoComponentBuilderFactory.PahoComponentBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
```
    Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: boolean type. Default: false Group: consumer
  - lazyStartProducer
```
default PahoComponentBuilderFactory.PahoComponentBuilder lazyStartProducer(boolean lazyStartProducer)
```
    Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: boolean type. Default: false Group: producer
  - basicPropertyBinding
```
default PahoComponentBuilderFactory.PahoComponentBuilder basicPropertyBinding(boolean basicPropertyBinding)
```
    Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities. The option is a: boolean type. Default: false Group: advanced
  - client
```
default PahoComponentBuilderFactory.PahoComponentBuilder client(org.eclipse.paho.client.mqttv3.MqttClient client)
```
    To use a shared Paho client. The option is a: org.eclipse.paho.client.mqttv3.MqttClient type. Group: advanced
  - customWebSocketHeaders
```
default PahoComponentBuilderFactory.PahoComponentBuilder customWebSocketHeaders(Properties customWebSocketHeaders)
```
    Sets the Custom WebSocket Headers for the WebSocket Connection. The option is a: java.util.Properties type. Group: advanced
  - executorServiceTimeout
```
default PahoComponentBuilderFactory.PahoComponentBuilder executorServiceTimeout(int executorServiceTimeout)
```
    Set the time in seconds that the executor service should wait when terminating before forcefully terminating. It is not recommended to change this value unless you are absolutely sure that you need to. The option is a: int type. Default: 1 Group: advanced
  - httpsHostnameVerificationEnabled
```
default PahoComponentBuilderFactory.PahoComponentBuilder httpsHostnameVerificationEnabled(boolean httpsHostnameVerificationEnabled)
```
    Whether SSL HostnameVerifier is enabled or not. The default value is true. The option is a: boolean type. Default: true Group: security
  - password
```
default PahoComponentBuilderFactory.PahoComponentBuilder password(String password)
```
    Password to be used for authentication against the MQTT broker. The option is a: java.lang.String type. Group: security
  - socketFactory
```
default PahoComponentBuilderFactory.PahoComponentBuilder socketFactory(SocketFactory socketFactory)
```
    Sets the SocketFactory to use. This allows an application to apply its own policies around the creation of network sockets. If using an SSL connection, an SSLSocketFactory can be used to supply application-specific security settings. The option is a: javax.net.SocketFactory type. Group: security
  - sslClientProps
```
default PahoComponentBuilderFactory.PahoComponentBuilder sslClientProps(Properties sslClientProps)
```
    Sets the SSL properties for the connection. Note that these properties are only valid if an implementation of the Java Secure Socket Extensions (JSSE) is available. These properties are not used if a custom SocketFactory has been set. The following properties can be used: com.ibm.ssl.protocol One of: SSL, SSLv3, TLS, TLSv1, SSL_TLS. com.ibm.ssl.contextProvider Underlying JSSE provider. For example IBMJSSE2 or SunJSSE com.ibm.ssl.keyStore The name of the file that contains the KeyStore object that you want the KeyManager to use. For example /mydir/etc/key.p12 com.ibm.ssl.keyStorePassword The password for the KeyStore object that you want the KeyManager to use. The password can either be in plain-text, or may be obfuscated using the static method: com.ibm.micro.security.Password.obfuscate(char password). This obfuscates the password using a simple and insecure XOR and Base64 encoding mechanism. Note that this is only a simple scrambler to obfuscate clear-text passwords. com.ibm.ssl.keyStoreType Type of key store, for example PKCS12, JKS, or JCEKS. com.ibm.ssl.keyStoreProvider Key store provider, for example IBMJCE or IBMJCEFIPS. com.ibm.ssl.trustStore The name of the file that contains the KeyStore object that you want the TrustManager to use. com.ibm.ssl.trustStorePassword The password for the TrustStore object that you want the TrustManager to use. The password can either be in plain-text, or may be obfuscated using the static method: com.ibm.micro.security.Password.obfuscate(char password). This obfuscates the password using a simple and insecure XOR and Base64 encoding mechanism. Note that this is only a simple scrambler to obfuscate clear-text passwords. com.ibm.ssl.trustStoreType The type of KeyStore object that you want the default TrustManager to use. Same possible values as keyStoreType. com.ibm.ssl.trustStoreProvider Trust store provider, for example IBMJCE or IBMJCEFIPS. com.ibm.ssl.enabledCipherSuites A list of which ciphers are enabled. Values are dependent on the provider, for example: SSL_RSA_WITH_AES_128_CBC_SHA;SSL_RSA_WITH_3DES_EDE_CBC_SHA. com.ibm.ssl.keyManager Sets the algorithm that will be used to instantiate a KeyManagerFactory object instead of using the default algorithm available in the platform. Example values: IbmX509 or IBMJ9X509. com.ibm.ssl.trustManager Sets the algorithm that will be used to instantiate a TrustManagerFactory object instead of using the default algorithm available in the platform. Example values: PKIX or IBMJ9X509. The option is a: java.util.Properties type. Group: security
  - sslHostnameVerifier
```
default PahoComponentBuilderFactory.PahoComponentBuilder sslHostnameVerifier(HostnameVerifier sslHostnameVerifier)
```
    Sets the HostnameVerifier for the SSL connection. Note that it will be used after handshake on a connection and you should do actions by yourself when hostname is verified error. There is no default HostnameVerifier. The option is a: javax.net.ssl.HostnameVerifier type. Group: security
  - userName
```
default PahoComponentBuilderFactory.PahoComponentBuilder userName(String userName)
```
    Username to be used for authentication against the MQTT broker. The option is a: java.lang.String type. Group: security

Interface PahoComponentBuilderFactory.PahoComponentBuilder

Method Summary

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder

Method Detail

automaticReconnect

brokerUrl

cleanSession

clientId

configuration

connectionTimeout

filePersistenceDirectory

keepAliveInterval

maxInflight

maxReconnectDelay

mqttVersion

persistence

qos

retained

serverURIs

willPayload

willQos

willRetained

willTopic

bridgeErrorHandler

lazyStartProducer

basicPropertyBinding

client

customWebSocketHeaders

executorServiceTimeout

httpsHostnameVerificationEnabled

password

socketFactory

sslClientProps

sslHostnameVerifier

userName