Class PahoConfiguration
- java.lang.Object
-
- org.apache.camel.component.paho.PahoConfiguration
-
-
Constructor Summary
Constructors Constructor Description PahoConfiguration()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PahoConfiguration
copy()
String
getBrokerUrl()
String
getClientId()
int
getConnectionTimeout()
Properties
getCustomWebSocketHeaders()
int
getExecutorServiceTimeout()
String
getFilePersistenceDirectory()
int
getKeepAliveInterval()
int
getMaxInflight()
int
getMaxReconnectDelay()
int
getMqttVersion()
String
getPassword()
PahoPersistence
getPersistence()
int
getQos()
String
getServerURIs()
SocketFactory
getSocketFactory()
Properties
getSslClientProps()
HostnameVerifier
getSslHostnameVerifier()
String
getUserName()
String
getWillPayload()
int
getWillQos()
String
getWillTopic()
boolean
isAutomaticReconnect()
boolean
isCleanSession()
boolean
isHttpsHostnameVerificationEnabled()
boolean
isRetained()
boolean
isWillRetained()
void
setAutomaticReconnect(boolean automaticReconnect)
Sets whether the client will automatically attempt to reconnect to the server if the connection is lost.void
setBrokerUrl(String brokerUrl)
The URL of the MQTT broker.void
setCleanSession(boolean cleanSession)
Sets whether the client and server should remember state across restarts and reconnects.void
setClientId(String clientId)
MQTT client identifier.void
setConnectionTimeout(int connectionTimeout)
Sets the connection timeout value.void
setCustomWebSocketHeaders(Properties customWebSocketHeaders)
Sets the Custom WebSocket Headers for the WebSocket Connection.void
setExecutorServiceTimeout(int executorServiceTimeout)
Set the time in seconds that the executor service should wait when terminating before forcefully terminating.void
setFilePersistenceDirectory(String filePersistenceDirectory)
Base directory used by file persistence.void
setHttpsHostnameVerificationEnabled(boolean httpsHostnameVerificationEnabled)
Whether SSL HostnameVerifier is enabled or not.void
setKeepAliveInterval(int keepAliveInterval)
Sets the keep alive interval.void
setMaxInflight(int maxInflight)
Sets the max inflight.void
setMaxReconnectDelay(int maxReconnectDelay)
Get the maximum time (in millis) to wait between reconnectsvoid
setMqttVersion(int mqttVersion)
Sets the MQTT version.void
setPassword(String password)
Password to be used for authentication against the MQTT brokervoid
setPersistence(PahoPersistence persistence)
Client persistence to be used - memory or file.void
setQos(int qos)
Client quality of service level (0-2).void
setRetained(boolean retained)
Retain optionvoid
setServerURIs(String serverURIs)
Set a list of one or more serverURIs the client may connect to.void
setSocketFactory(SocketFactory socketFactory)
Sets the SocketFactory to use.void
setSslClientProps(Properties sslClientProps)
Sets the SSL properties for the connection.void
setSslHostnameVerifier(HostnameVerifier sslHostnameVerifier)
Sets the HostnameVerifier for the SSL connection.void
setUserName(String userName)
Username to be used for authentication against the MQTT brokervoid
setWillPayload(String willPayload)
Sets the "Last Will and Testament" (LWT) for the connection.void
setWillQos(int willQos)
Sets the "Last Will and Testament" (LWT) for the connection.void
setWillRetained(boolean willRetained)
Sets the "Last Will and Testament" (LWT) for the connection.void
setWillTopic(String willTopic)
Sets the "Last Will and Testament" (LWT) for the connection.
-
-
-
Method Detail
-
getClientId
public String getClientId()
-
setClientId
public void setClientId(String clientId)
MQTT client identifier. The identifier must be unique.
-
getBrokerUrl
public String getBrokerUrl()
-
setBrokerUrl
public void setBrokerUrl(String brokerUrl)
The URL of the MQTT broker.
-
getQos
public int getQos()
-
setQos
public void setQos(int qos)
Client quality of service level (0-2).
-
isRetained
public boolean isRetained()
-
setRetained
public void setRetained(boolean retained)
Retain option
-
getPersistence
public PahoPersistence getPersistence()
-
setPersistence
public void setPersistence(PahoPersistence persistence)
Client persistence to be used - memory or file.
-
getFilePersistenceDirectory
public String getFilePersistenceDirectory()
-
setFilePersistenceDirectory
public void setFilePersistenceDirectory(String filePersistenceDirectory)
Base directory used by file persistence. Will by default use user directory.
-
getUserName
public String getUserName()
-
setUserName
public void setUserName(String userName)
Username to be used for authentication against the MQTT broker
-
getPassword
public String getPassword()
-
setPassword
public void setPassword(String password)
Password to be used for authentication against the MQTT broker
-
getKeepAliveInterval
public int getKeepAliveInterval()
-
setKeepAliveInterval
public void setKeepAliveInterval(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
-
getMaxInflight
public int getMaxInflight()
-
setMaxInflight
public void setMaxInflight(int maxInflight)
Sets the max inflight. please increase this value in a high traffic environment.The default value is 10
-
getWillTopic
public String getWillTopic()
-
setWillTopic
public void setWillTopic(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. Sets the topic that the willPayload will be published to.
-
getWillPayload
public String getWillPayload()
-
setWillPayload
public void setWillPayload(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. Sets the message for the LWT.
-
getWillQos
public int getWillQos()
-
setWillQos
public void setWillQos(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. Sets the quality of service to publish the message at (0, 1 or 2).
-
isWillRetained
public boolean isWillRetained()
-
setWillRetained
public void setWillRetained(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. Sets whether or not the message should be retained.
-
getSocketFactory
public SocketFactory getSocketFactory()
-
setSocketFactory
public void setSocketFactory(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.
-
getSslClientProps
public Properties getSslClientProps()
-
setSslClientProps
public void setSslClientProps(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".
-
isHttpsHostnameVerificationEnabled
public boolean isHttpsHostnameVerificationEnabled()
-
setHttpsHostnameVerificationEnabled
public void setHttpsHostnameVerificationEnabled(boolean httpsHostnameVerificationEnabled)
Whether SSL HostnameVerifier is enabled or not. The default value is true.
-
getSslHostnameVerifier
public HostnameVerifier getSslHostnameVerifier()
-
setSslHostnameVerifier
public void setSslHostnameVerifier(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
-
isCleanSession
public boolean isCleanSession()
-
setCleanSession
public void setCleanSession(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
- 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:
-
getConnectionTimeout
public int getConnectionTimeout()
-
setConnectionTimeout
public void setConnectionTimeout(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.
-
getServerURIs
public String getServerURIs()
-
setServerURIs
public void setServerURIs(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 supportedtcp://
for a TCP connection andssl://
for a TCP connection secured by SSL/TLS. For example:tcp://localhost:1883
ssl://localhost:8883
tcp://
" URIs, and 8883 forssl://
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
-
getMqttVersion
public int getMqttVersion()
-
setMqttVersion
public void setMqttVersion(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.
-
isAutomaticReconnect
public boolean isAutomaticReconnect()
-
setAutomaticReconnect
public void setAutomaticReconnect(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.
-
getMaxReconnectDelay
public int getMaxReconnectDelay()
-
setMaxReconnectDelay
public void setMaxReconnectDelay(int maxReconnectDelay)
Get the maximum time (in millis) to wait between reconnects
-
getCustomWebSocketHeaders
public Properties getCustomWebSocketHeaders()
-
setCustomWebSocketHeaders
public void setCustomWebSocketHeaders(Properties customWebSocketHeaders)
Sets the Custom WebSocket Headers for the WebSocket Connection.
-
getExecutorServiceTimeout
public int getExecutorServiceTimeout()
-
setExecutorServiceTimeout
public void setExecutorServiceTimeout(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.
-
copy
public PahoConfiguration copy()
-
-