MqttConnectOptions

java.lang.Object
- org.eclipse.paho.client.mqttv3.MqttConnectOptions

```
public class MqttConnectOptions
extends java.lang.Object
```
Holds the set of options that control how the client connects to a server.

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`CLEAN_SESSION_DEFAULT` The default clean session setting if one is not specified
`static int`	`CONNECTION_TIMEOUT_DEFAULT` The default connection timeout in seconds if one is not specified
`static int`	`KEEP_ALIVE_INTERVAL_DEFAULT` The default keep alive interval in seconds if one is not specified
`static int`	`MAX_INFLIGHT_DEFAULT` The default max inflight if one is not specified
`static int`	`MQTT_VERSION_3_1`
`static int`	`MQTT_VERSION_3_1_1`
`static int`	`MQTT_VERSION_DEFAULT` The default MqttVersion is 3.1.1 first, dropping back to 3.1 if that fails

Constructor Summary

Constructors
Constructor and Description

MqttConnectOptions()
Constructs a new MqttConnectOptions object using the default values.

Constructors
Constructor and Description
`MqttConnectOptions()` Constructs a new `MqttConnectOptions` object using the default values.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getConnectionTimeout()` Returns the connection timeout value.
`java.util.Properties`	`getDebug()`
`int`	`getKeepAliveInterval()` Returns the "keep alive" interval.
`int`	`getMaxInflight()` Returns the "max inflight".
`int`	`getMqttVersion()` Returns the MQTT version.
`char[]`	`getPassword()` Returns the password to use for the connection.
`java.lang.String[]`	`getServerURIs()` Return a list of serverURIs the client may connect to
`javax.net.SocketFactory`	`getSocketFactory()` Returns the socket factory that will be used when connecting, or `null` if one has not been set.
`java.util.Properties`	`getSSLProperties()` Returns the SSL properties for the connection.
`java.lang.String`	`getUserName()` Returns the user name to use for the connection.
`java.lang.String`	`getWillDestination()` Returns the topic to be used for last will and testament (LWT).
`MqttMessage`	`getWillMessage()` Returns the message to be sent as last will and testament (LWT).
`boolean`	`isAutomaticReconnect()` Returns whether the client will automatically attempt to reconnect to the server if the connection is lost
`boolean`	`isCleanSession()` Returns whether the client and server should remember state for the client across reconnects.
`void`	`setAutomaticReconnect(boolean automaticReconnect)` Sets whether the client will automatically attempt to reconnect to the server if the connection is lost.
`void`	`setCleanSession(boolean cleanSession)` Sets whether the client and server should remember state across restarts and reconnects.
`void`	`setConnectionTimeout(int connectionTimeout)` Sets the connection timeout value.
`void`	`setKeepAliveInterval(int keepAliveInterval)` Sets the "keep alive" interval.
`void`	`setMaxInflight(int maxInflight)` Sets the "max inflight".
`void`	`setMqttVersion(int MqttVersion)` Sets the MQTT version.
`void`	`setPassword(char[] password)` Sets the password to use for the connection.
`void`	`setServerURIs(java.lang.String[] array)` Set a list of one or more serverURIs the client may connect to.
`void`	`setSocketFactory(javax.net.SocketFactory socketFactory)` Sets the `SocketFactory` to use.
`void`	`setSSLProperties(java.util.Properties props)` Sets the SSL properties for the connection.
`void`	`setUserName(java.lang.String userName)` Sets the user name to use for the connection.
`void`	`setWill(MqttTopic topic, byte[] payload, int qos, boolean retained)` Sets the "Last Will and Testament" (LWT) for the connection.
`void`	`setWill(java.lang.String topic, byte[] payload, int qos, boolean retained)` Sets the "Last Will and Testament" (LWT) for the connection.
`java.lang.String`	`toString()`

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

- Field Detail
  - KEEP_ALIVE_INTERVAL_DEFAULT
```
public static final int KEEP_ALIVE_INTERVAL_DEFAULT
```
    The default keep alive interval in seconds if one is not specified
    
    See Also:
    
    Constant Field Values
  - CONNECTION_TIMEOUT_DEFAULT
```
public static final int CONNECTION_TIMEOUT_DEFAULT
```
    The default connection timeout in seconds if one is not specified
    
    See Also:
    
    Constant Field Values
  - MAX_INFLIGHT_DEFAULT
```
public static final int MAX_INFLIGHT_DEFAULT
```
    The default max inflight if one is not specified
    
    See Also:
    
    Constant Field Values
  - CLEAN_SESSION_DEFAULT
```
public static final boolean CLEAN_SESSION_DEFAULT
```
    The default clean session setting if one is not specified
    
    See Also:
    
    Constant Field Values
  - MQTT_VERSION_DEFAULT
```
public static final int MQTT_VERSION_DEFAULT
```
    The default MqttVersion is 3.1.1 first, dropping back to 3.1 if that fails
    
    See Also:
    
    Constant Field Values
  - MQTT_VERSION_3_1
```
public static final int MQTT_VERSION_3_1
```
    See Also:
    
    Constant Field Values
  - MQTT_VERSION_3_1_1
```
public static final int MQTT_VERSION_3_1_1
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MqttConnectOptions
```
public MqttConnectOptions()
```
    Constructs a new MqttConnectOptions object using the default values. The defaults are:
    - The keepalive interval is 60 seconds
    - Clean Session is true
    - The message delivery retry interval is 15 seconds
    - The connection timeout period is 30 seconds
    - No Will message is set
    - A standard SocketFactory is used
    More information about these values can be found in the setter methods.
- Method Detail
  - getPassword
```
public char[] getPassword()
```
    Returns the password to use for the connection.
    
    Returns:
    
    the password to use for the connection.
  - setPassword
```
public void setPassword(char[] password)
```
    Sets the password to use for the connection.
  - getUserName
```
public java.lang.String getUserName()
```
    Returns the user name to use for the connection.
    
    Returns:
    
    the user name to use for the connection.
  - setUserName
```
public void setUserName(java.lang.String userName)
```
    Sets the user name to use for the connection.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the user name is blank or only contains whitespace characters.
  - setWill
```
public void setWill(MqttTopic topic,
                    byte[] payload,
                    int qos,
                    boolean retained)
```
    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.
    
    Parameters:
    
    topic - the topic to publish to.
    
    payload - the byte payload for the message.
    
    qos - the quality of service to publish the message at (0, 1 or 2).
    
    retained - whether or not the message should be retained.
  - setWill
```
public void setWill(java.lang.String topic,
                    byte[] payload,
                    int qos,
                    boolean retained)
```
    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.
    
    Parameters:
    
    topic - the topic to publish to.
    
    payload - the byte payload for the message.
    
    qos - the quality of service to publish the message at (0, 1 or 2).
    
    retained - whether or not the message should be retained.
  - getKeepAliveInterval
```
public int getKeepAliveInterval()
```
    Returns the "keep alive" interval.
    
    Returns:
    
    the keep alive interval.
    
    See Also:
    
    setKeepAliveInterval(int)
  - getMqttVersion
```
public int getMqttVersion()
```
    Returns the MQTT version.
    
    Returns:
    
    the MQTT version.
    
    See Also:
    
    setMqttVersion(int)
  - setKeepAliveInterval
```
public void setKeepAliveInterval(int keepAliveInterval)
                          throws java.lang.IllegalArgumentException
```
    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
    
    Parameters:
    
    keepAliveInterval - the interval, measured in seconds, must be >= 0.
    
    Throws:
    
    java.lang.IllegalArgumentException
  - getMaxInflight
```
public int getMaxInflight()
```
    Returns the "max inflight". The max inflight limits to how many messages we can send without receiving acknowledgments.
    
    Returns:
    
    the max inflight
    
    See Also:
    
    setMaxInflight(int)
  - setMaxInflight
```
public void setMaxInflight(int maxInflight)
```
    Sets the "max inflight". please increase this value in a high traffic environment.
    The default value is 10
    
    Parameters:
    
    maxInflight -
  - getConnectionTimeout
```
public int getConnectionTimeout()
```
    Returns the connection timeout value.
    
    Returns:
    
    the connection timeout value.
    
    See Also:
    
    setConnectionTimeout(int)
  - 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.
    
    Parameters:
    
    connectionTimeout - the timeout value, measured in seconds. It must be >0;
  - getSocketFactory
```
public javax.net.SocketFactory getSocketFactory()
```
    Returns the socket factory that will be used when connecting, or null if one has not been set.
  - setSocketFactory
```
public void setSocketFactory(javax.net.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.
    
    Parameters:
    
    socketFactory - the factory to use.
  - getWillDestination
```
public java.lang.String getWillDestination()
```
    Returns the topic to be used for last will and testament (LWT).
    
    Returns:
    
    the MqttTopic to use, or null if LWT is not set.
    
    See Also:
    
    setWill(MqttTopic, byte[], int, boolean)
  - getWillMessage
```
public MqttMessage getWillMessage()
```
    Returns the message to be sent as last will and testament (LWT). The returned object is "read only". Calling any "setter" methods on the returned object will result in an IllegalStateException being thrown.
    
    Returns:
    
    the message to use, or null if LWT is not set.
  - getSSLProperties
```
public java.util.Properties getSSLProperties()
```
    Returns the SSL properties for the connection.
    
    Returns:
    
    the properties for the SSL connection
  - setSSLProperties
```
public void setSSLProperties(java.util.Properties props)
```
    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 SocketFactory has been set using setSocketFactory(SocketFactory). 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".
  - isCleanSession
```
public boolean isCleanSession()
```
    Returns whether the client and server should remember state for the client across reconnects.
    
    Returns:
    
    the clean session flag
  - 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
  - getServerURIs
```
public java.lang.String[] getServerURIs()
```
    Return a list of serverURIs the client may connect to
    
    Returns:
    
    the serverURIs or null if not set
  - setServerURIs
```
public void setServerURIs(java.lang.String[] array)
```
    Set a list of one or more serverURIs the client may connect to.
    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:
    1. 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.
    2. 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
    Parameters:
    
    array - of serverURIs
  - setMqttVersion
```
public void setMqttVersion(int MqttVersion)
                    throws java.lang.IllegalArgumentException
```
    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.
    
    Parameters:
    
    MqttVersion - the version of the MQTT protocol.
    
    Throws:
    
    java.lang.IllegalArgumentException
  - isAutomaticReconnect
```
public boolean isAutomaticReconnect()
```
    Returns whether the client will automatically attempt to reconnect to the server if the connection is lost
    
    Returns:
    
    the automatic reconnection flag.
  - 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.
    Parameters:
    
    automaticReconnect -
  - getDebug
```
public java.util.Properties getDebug()
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class MqttConnectOptions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

KEEP_ALIVE_INTERVAL_DEFAULT

CONNECTION_TIMEOUT_DEFAULT

MAX_INFLIGHT_DEFAULT

CLEAN_SESSION_DEFAULT

MQTT_VERSION_DEFAULT

MQTT_VERSION_3_1

MQTT_VERSION_3_1_1

Constructor Detail

MqttConnectOptions

Method Detail

getPassword

setPassword

getUserName

setUserName

setWill

setWill

getKeepAliveInterval

getMqttVersion

setKeepAliveInterval

getMaxInflight

setMaxInflight

getConnectionTimeout

setConnectionTimeout

getSocketFactory

setSocketFactory

getWillDestination

getWillMessage

getSSLProperties

setSSLProperties

isCleanSession

setCleanSession

getServerURIs

setServerURIs

setMqttVersion

isAutomaticReconnect

setAutomaticReconnect

getDebug

toString