DxlClientConfig (dxlclient 0.2.6 API)

java.lang.Object
- com.opendxl.client.DxlClientConfig

```
public class DxlClientConfig
extends java.lang.Object
```
The DxlClientConfig class holds the information necessary to connect a DxlClient to the DXL fabric.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String KS_PASS
The default keystore password

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`KS_PASS` The default keystore password

Constructor Summary

Constructors
Constructor and Description
`DxlClientConfig(java.lang.String brokerCaBundlePath, java.lang.String certFile, java.lang.String privateKey, java.util.List<Broker> brokers)` Constructs the configuration
`DxlClientConfig(java.lang.String brokerCaBundlePath, java.lang.String certFile, java.lang.String privateKey, java.util.List<Broker> brokers, java.util.List<Broker> webSocketBrokers)` Constructs the configuration

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DxlClientConfig`	`createDxlConfigFromFile(java.lang.String fileName)` This method allows creation of a `DxlClientConfig` object from a specified configuration file.
`java.lang.String`	`getBrokerCaBundlePath()` Returns the file name of a bundle containing the broker CA certificates in PEM format
`java.util.List<Broker>`	`getBrokerList()` Returns the list of `Broker` objects representing brokers on the DXL fabric supporting standard MQTT connections.
`int`	`getConnectRetries()` Returns the maximum number of connection attempts for each `Broker` specified.
`int`	`getConnectTimeout()` Returns the connection timeout.
`int`	`getDisconnectTimeout()` Returns the disconnection timeout.
`int`	`getIncomingMessageQueueSize()` Returns the queue size for incoming messages (will block when queue is full)
`int`	`getIncomingMessageThreadPoolSize()` Returns the thread pool size for incoming messages
`java.util.List<Broker>`	`getInUseBrokerList()` Returns the list of `Broker` objects representing brokers on the DXL fabric.
`int`	`getKeepAliveInterval()` Returns the maximum period in seconds between communications with a connected `Broker`.
`java.security.KeyStore`	`getKeyStore()` Returns the `KeyStore` associated with the client configuration
`long`	`getOperationTimeToWait()` Returns the time to wait for an underlying protocol operation to complete.
`java.lang.String`	`getProxyAddress()` Returns the HTTP proxy address
`char[]`	`getProxyPassword()` Returns the the HTTP proxy password
`int`	`getProxyPort()` Returns the HTTP proxy port
`java.lang.String`	`getProxyUserName()` Returns the HTTP proxy user name
`int`	`getReconnectBackOffMultiplier()` Returns the exponential reconnect back off multiplier, defaults to `2`
`int`	`getReconnectDelay()` Returns the amount of time (in ms) for the first connect retry, defaults to `1000`
`long`	`getReconnectDelayMax()` Returns the maximum reconnect delay time, defaults to `60000` (one minute)
`float`	`getReconnectDelayRandom()` Returns the randomness delay percentage (between `0.0` and `1.0`).
`java.lang.String`	`getUniqueId()` Returns the unique identifier of the client instance
`java.util.List<Broker>`	`getWebSocketBrokers()` Returns the list of `Broker` objects representing brokers on the DXL fabric supporting DXL connections over WebSockets.
`boolean`	`isHttpsHostnameVerificationEnabled()` Returns whether the client should do SSL host name verification when connecting to a broker
`boolean`	`isInfiniteReconnectRetries()` Returns whether the client should infinitely retry to reconnect when it gets disconnected
`boolean`	`isUseWebSockets()` Returns whether the client should use WebSockets or regular MQTT over tcp when connecting to a `Broker`
`void`	`setConnectRetries(int retries)` Sets the maximum number of connection attempts for each `Broker` specified.
`void`	`setConnectTimeout(int timeout)` Sets the connection timeout.
`void`	`setDisconnectTimeout(int timeout)` Sets the disconnection timeout.
`void`	`setHttpsHostnameVerificationEnabled(boolean httpsHostnameVerificationEnabled)` Sets whether the client should do SSL host name verification when connecting to a broker.
`void`	`setIncomingMessageQueueSize(int size)` Sets the queue size for incoming messages (will block when queue is full)
`void`	`setIncomingMessageThreadPoolSize(int size)` Sets the thread pool size for incoming messages
`void`	`setInfiniteReconnectRetries(boolean infiniteReconnect)` Sets whether the client should infinitely retry to reconnect when it gets disconnected
`void`	`setKeepAliveInterval(int keepAliveInterval)` Sets the maximum period in seconds between communications with a connected `Broker`.
`void`	`setOperationTimeToWait(long timeToWait)` Sets the time to wait for an underlying protocol operation to complete.
`void`	`setProxyAddress(java.lang.String proxyAddress)` Sets the HTTP proxy address
`void`	`setProxyPassword(char[] proxyPassword)` Sets the the HTTP proxy password
`void`	`setProxyPort(int proxyPort)` Sets the HTTP proxy port
`void`	`setProxyUserName(java.lang.String proxyUserName)` Sets the HTTP proxy user name
`void`	`setReconnectBackOffMultiplier(int multiplier)` The exponential reconnect back off multiplier, defaults to `2`
`void`	`setReconnectDelay(int delay)` The amount of time (in ms) for the first connect retry, defaults to `1000`
`void`	`setReconnectDelayMax(long delayMax)` The maximum reconnect delay time, defaults to `60000` (one minute)
`void`	`setReconnectDelayRandom(float percent)` Sets a randomness delay percentage (between `0.0` and `1.0`).
`void`	`setUniqueId(java.lang.String uniqueId)` Overwrites the unique identifier of the client with a new UUID.
`void`	`setUseWebSockets(boolean useWebSockets)` Sets whether the client should use WebSockets or regular MQTT over tcp when connecting to a `Broker`
`void`	`setWebSocketBrokers(java.util.List<Broker> webSocketBrokers)` Set the list of `Broker` objects representing brokers on the DXL fabric supporting DXL connections over WebSockets.
`void`	`write(java.lang.String configFile)` Method to write out the dxlClient.config file from the DXLClientConfig object member variables

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

- Field Detail
  - KS_PASS
```
public static final java.lang.String KS_PASS
```
    The default keystore password
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DxlClientConfig
```
public DxlClientConfig(java.lang.String brokerCaBundlePath,
                       java.lang.String certFile,
                       java.lang.String privateKey,
                       java.util.List<Broker> brokers)
```
    Constructs the configuration
    
    Parameters:
    
    brokerCaBundlePath - The file name of a bundle containing the broker CA certificates in PEM format
    
    certFile - The file name of the client certificate in PEM format
    
    privateKey - The file name of the client private key in PEM format
    
    brokers - A list of Broker objects representing brokers comprising the DXL fabric supporting standard MQTT connections. When invoking the DxlClient.connect() method, the DxlClient will attempt to connect to the closest broker.
  - DxlClientConfig
```
public DxlClientConfig(java.lang.String brokerCaBundlePath,
                       java.lang.String certFile,
                       java.lang.String privateKey,
                       java.util.List<Broker> brokers,
                       java.util.List<Broker> webSocketBrokers)
```
    Constructs the configuration
    
    Parameters:
    
    brokerCaBundlePath - The file name of a bundle containing the broker CA certificates in PEM format
    
    certFile - The file name of the client certificate in PEM format
    
    privateKey - The file name of the client private key in PEM format
    
    brokers - A list of Broker objects representing brokers comprising the DXL fabric supporting standard MQTT connections. When invoking the DxlClient.connect() method, the DxlClient will attempt to connect to the closest broker.
    
    webSocketBrokers - A list Broker objects representing brokers on the DXL fabric supporting DXL connections over WebSockets. When invoking the DxlClient.connect() method, the DxlClient will attempt to connect to the closest broker.
- Method Detail
  - getKeyStore
```
public java.security.KeyStore getKeyStore()
                                   throws DxlException
```
    Returns the KeyStore associated with the client configuration
    
    Returns:
    
    The KeyStore associated with the client configuration
    
    Throws:
    
    DxlException - If an error occurs
  - getBrokerCaBundlePath
```
public java.lang.String getBrokerCaBundlePath()
```
    Returns the file name of a bundle containing the broker CA certificates in PEM format
    
    Returns:
    
    the file name of a bundle containing the broker CA certificates in PEM format
  - getUniqueId
```
public java.lang.String getUniqueId()
```
    Returns the unique identifier of the client instance
    
    Returns:
    
    The unique identifier of the client instance
  - setUniqueId
```
public void setUniqueId(java.lang.String uniqueId)
```
    Overwrites the unique identifier of the client with a new UUID.
    
    Parameters:
    
    uniqueId - The unique identifier of the client.
  - getBrokerList
```
public java.util.List<Broker> getBrokerList()
```
    Returns the list of Broker objects representing brokers on the DXL fabric supporting standard MQTT connections. When invoking the DxlClient.connect() method, the DxlClient will attempt to connect to the closest broker.
    
    Returns:
    
    The list of Broker objects representing brokers on the DXL fabric supporting standard MQTT connections.
  - getInUseBrokerList
```
public java.util.List<Broker> getInUseBrokerList()
```
    Returns the list of Broker objects representing brokers on the DXL fabric. When invoking the DxlClient.connect() method, the DxlClient will attempt to connect to the closest broker.
    
    Returns:
    
    The list of Broker objects representing brokers on the DXL fabric
  - getWebSocketBrokers
```
public java.util.List<Broker> getWebSocketBrokers()
```
    Returns the list of Broker objects representing brokers on the DXL fabric supporting DXL connections over WebSockets. When invoking the DxlClient.connect() method, the DxlClient will attempt to connect to the closest broker.
    
    Returns:
    
    The list of Broker objects representing brokers on the DXL fabric supporting DXL connections over WebSockets.
  - setWebSocketBrokers
```
public void setWebSocketBrokers(java.util.List<Broker> webSocketBrokers)
```
    Set the list of Broker objects representing brokers on the DXL fabric supporting DXL connections over WebSockets.
    
    Parameters:
    
    webSocketBrokers - The list of Broker objects representing brokers on the DXL fabric supporting DXL connections over WebSockets.
  - isUseWebSockets
```
public boolean isUseWebSockets()
```
    Returns whether the client should use WebSockets or regular MQTT over tcp when connecting to a Broker
    Defaults to false
    
    Returns:
    
    Whether the client should use WebSockets or regular MQTT over tcp when connecting to a Broker
  - setUseWebSockets
```
public void setUseWebSockets(boolean useWebSockets)
```
    Sets whether the client should use WebSockets or regular MQTT over tcp when connecting to a Broker
    
    Parameters:
    
    useWebSockets - Whether the client should use WebSockets or regular MQTT over tcp when connecting to a Broker
  - setIncomingMessageThreadPoolSize
```
public void setIncomingMessageThreadPoolSize(int size)
```
    Sets the thread pool size for incoming messages
    Defaults to 1
    
    Parameters:
    
    size - The thread pool size for incoming messages
  - getIncomingMessageThreadPoolSize
```
public int getIncomingMessageThreadPoolSize()
```
    Returns the thread pool size for incoming messages
    Defaults to 1
    
    Returns:
    
    The thread pool size for incoming messages
  - setIncomingMessageQueueSize
```
public void setIncomingMessageQueueSize(int size)
```
    Sets the queue size for incoming messages (will block when queue is full)
    Defaults to 16384
    
    Parameters:
    
    size - The queue size for incoming messages
  - getIncomingMessageQueueSize
```
public int getIncomingMessageQueueSize()
```
    Returns the queue size for incoming messages (will block when queue is full)
    Defaults to 16384
    
    Returns:
    
    The queue size for incoming messages
  - setKeepAliveInterval
```
public void setKeepAliveInterval(int keepAliveInterval)
                          throws java.lang.IllegalArgumentException
```
    Sets the maximum period in seconds between communications with a connected Broker. If no other messages are being exchanged, this controls the rate at which the client will send ping messages to the Broker.
    Defaults to 1800 seconds (30 minutes)
    
    Parameters:
    
    keepAliveInterval - The maximum period in seconds between communications with a connected Broker.
    
    Throws:
    
    java.lang.IllegalArgumentException
  - getKeepAliveInterval
```
public int getKeepAliveInterval()
```
    Returns the maximum period in seconds between communications with a connected Broker. If no other messages are being exchanged, this controls the rate at which the client will send ping messages to the Broker.
    Defaults to 1800 seconds (30 minutes)
    
    Returns:
    
    The maximum period in seconds between communications with a connected Broker.
  - setConnectRetries
```
public void setConnectRetries(int retries)
```
    Sets the maximum number of connection attempts for each Broker specified.
    A value of -1 indicates that the client will continue to retry without limit until it establishes a connection.
    
    Defaults to -1
    
    Parameters:
    
    retries - The maximum number of connection attempts for each Broker specified.
  - getConnectRetries
```
public int getConnectRetries()
```
    Returns the maximum number of connection attempts for each Broker specified.
    A value of -1 indicates that the client will continue to retry without limit until it establishes a connection.
    
    Defaults to -1
    
    Returns:
    
    The maximum number of connection attempts for each Broker specified.
  - setInfiniteReconnectRetries
```
public void setInfiniteReconnectRetries(boolean infiniteReconnect)
```
    Sets whether the client should infinitely retry to reconnect when it gets disconnected
    Defaults to true
    
    Parameters:
    
    infiniteReconnect - Whether the client should infinitely retry to reconnect when it gets disconnected
  - isInfiniteReconnectRetries
```
public boolean isInfiniteReconnectRetries()
```
    Returns whether the client should infinitely retry to reconnect when it gets disconnected
    Defaults to true
    
    Returns:
    
    Whether the client should infinitely retry to reconnect when it gets disconnected
  - isHttpsHostnameVerificationEnabled
```
public boolean isHttpsHostnameVerificationEnabled()
```
    Returns whether the client should do SSL host name verification when connecting to a broker
    
    Returns:
    
    Whether the client should do SSL host name verification when connecting to a broker
  - setHttpsHostnameVerificationEnabled
```
public void setHttpsHostnameVerificationEnabled(boolean httpsHostnameVerificationEnabled)
```
    Sets whether the client should do SSL host name verification when connecting to a broker.
    Defaults to false
    
    Parameters:
    
    httpsHostnameVerificationEnabled - Whether the client should do SSL host name verification when connecting to a broker.
  - setReconnectDelay
```
public void setReconnectDelay(int delay)
```
    The amount of time (in ms) for the first connect retry, defaults to 1000
    
    Parameters:
    
    delay - The amount of time (in ms) for the first connect retry, defaults to 1000
  - getReconnectDelay
```
public int getReconnectDelay()
```
    Returns the amount of time (in ms) for the first connect retry, defaults to 1000
    
    Returns:
    
    The amount of time (in ms) for the first connect retry, defaults to 1000
  - setReconnectDelayMax
```
public void setReconnectDelayMax(long delayMax)
```
    The maximum reconnect delay time, defaults to 60000 (one minute)
    
    Parameters:
    
    delayMax - The maximum reconnect delay time, defaults to 60000 (one minute)
  - getReconnectDelayMax
```
public long getReconnectDelayMax()
```
    Returns the maximum reconnect delay time, defaults to 60000 (one minute)
    
    Returns:
    
    The maximum reconnect delay time, defaults to 60000 (one minute)
  - setReconnectBackOffMultiplier
```
public void setReconnectBackOffMultiplier(int multiplier)
```
    The exponential reconnect back off multiplier, defaults to 2
    
    Parameters:
    
    multiplier - The exponential reconnect back off multiplier, defaults to 2
  - getReconnectBackOffMultiplier
```
public int getReconnectBackOffMultiplier()
```
    Returns the exponential reconnect back off multiplier, defaults to 2
    
    Returns:
    
    The exponential reconnect back off multiplier, defaults to 2
  - setReconnectDelayRandom
```
public void setReconnectDelayRandom(float percent)
```
    Sets a randomness delay percentage (between 0.0 and 1.0). When calculating the reconnect delay, this percentage indicates how much randomness there should be in the current delay. For example, if the current delay is 100ms, a value of .25 would mean that the actual delay would be between 100ms and 125ms. The default value is 0.25
    
    Parameters:
    
    percent - The randomness delay percentage (between 0.0 and 1.0
  - getProxyAddress
```
public java.lang.String getProxyAddress()
```
    Returns the HTTP proxy address
    
    Returns:
    
    The HTTP proxy address
  - setProxyAddress
```
public void setProxyAddress(java.lang.String proxyAddress)
```
    Sets the HTTP proxy address
    
    Parameters:
    
    proxyAddress - The HTTP proxy address
  - getProxyPort
```
public int getProxyPort()
```
    Returns the HTTP proxy port
    
    Returns:
    
    The HTTP proxy port
  - setProxyPort
```
public void setProxyPort(int proxyPort)
```
    Sets the HTTP proxy port
    
    Parameters:
    
    proxyPort - The HTTP proxy port
  - getProxyUserName
```
public java.lang.String getProxyUserName()
```
    Returns the HTTP proxy user name
    
    Returns:
    
    The HTTP proxy user name
  - setProxyUserName
```
public void setProxyUserName(java.lang.String proxyUserName)
```
    Sets the HTTP proxy user name
    
    Parameters:
    
    proxyUserName - The HTTP proxy user name
  - getProxyPassword
```
public char[] getProxyPassword()
```
    Returns the the HTTP proxy password
    
    Returns:
    
    The the HTTP proxy password
  - setProxyPassword
```
public void setProxyPassword(char[] proxyPassword)
```
    Sets the the HTTP proxy password
    
    Parameters:
    
    proxyPassword - The the HTTP proxy password
  - write
```
public void write(java.lang.String configFile)
           throws java.lang.Exception
```
    Method to write out the dxlClient.config file from the DXLClientConfig object member variables
    
    Parameters:
    
    configFile - The path to the dxlClient.config file
    
    Throws:
    
    java.lang.Exception - If there is an issue with writing the dxlClient.config file
  - getReconnectDelayRandom
```
public float getReconnectDelayRandom()
```
    Returns the randomness delay percentage (between 0.0 and 1.0). When calculating the reconnect delay, this percentage indicates how much randomness there should be in the current delay. For example, if the current delay is 100ms, a value of .25 would mean that the actual delay would be between 100ms and 125ms. The default value is 0.25
    
    Returns:
    
    The randomness delay percentage (between 0.0 and 1.0
  - setOperationTimeToWait
```
public void setOperationTimeToWait(long timeToWait)
```
    Sets the time to wait for an underlying protocol operation to complete. The default value is 2 minutes.
    
    Parameters:
    
    timeToWait - The time to wait for an underlying protocol operation to complete (in milliseconds)
  - getOperationTimeToWait
```
public long getOperationTimeToWait()
```
    Returns the time to wait for an underlying protocol operation to complete. The default value is 2 minutes.
    
    Returns:
    
    The time to wait for an underlying protocol operation to complete (in milliseconds)
  - setConnectTimeout
```
public void setConnectTimeout(int timeout)
```
    Sets the connection timeout. Defaults to 30 seconds.
    
    Parameters:
    
    timeout - The connection timeout (in seconds)
  - getConnectTimeout
```
public int getConnectTimeout()
```
    Returns the connection timeout. Defaults to 30 seconds.
    
    Returns:
    
    The connection timeout (in seconds)
  - setDisconnectTimeout
```
public void setDisconnectTimeout(int timeout)
```
    Sets the disconnection timeout. Defaults to 60 seconds.
    
    Parameters:
    
    timeout - The disconnection timeout (in seconds)
  - getDisconnectTimeout
```
public int getDisconnectTimeout()
```
    Returns the disconnection timeout. Defaults to 60 seconds.
    
    Returns:
    
    The disconnection timeout (in seconds)
  - createDxlConfigFromFile
```
public static DxlClientConfig createDxlConfigFromFile(java.lang.String fileName)
                                               throws DxlException
```
    This method allows creation of a DxlClientConfig object from a specified configuration file. The information contained in the file has a one-to-one correspondence with the DxlClientConfig constructor.
```
 [General]
 UseWebSockets=false

 [Certs]
 BrokerCertChain=c:\\certs\\brokercerts.crt
 CertFile=c:\\certs\\client.crt
 PrivateKey=c:\\certs\\client.key

 [Brokers]
 mybroker=mybroker;8883;mybroker.mcafee.com;192.168.1.12
 mybroker2=mybroker2;8883;mybroker2.mcafee.com;192.168.1.13

 [BrokersWebSockets]
 mybroker=mybroker;8883;mybroker.mcafee.com;192.168.1.12
 mybroker2=mybroker2;8883;mybroker2.mcafee.com;192.168.1.13

 [Proxy]
 Address=proxy.mycompany.com
 Port=3128
 User=proxyUser
 Password=proxyPassword

 
```
    The configuration file can be loaded as follows:
```
 DxlClientConfig.createDxlConfigFromFile("c:\\certs\\dxlclient.cfg");
 
```
    Parameters:
    
    fileName - Path to the configuration file
    
    Returns:
    
    A DxlClientConfig object corresponding to the specified configuration file
    
    Throws:
    
    DxlException - If an error occurs

Class DxlClientConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

KS_PASS

Constructor Detail

DxlClientConfig

DxlClientConfig

Method Detail

getKeyStore

getBrokerCaBundlePath

getUniqueId

setUniqueId

getBrokerList

getInUseBrokerList

getWebSocketBrokers

setWebSocketBrokers

isUseWebSockets

setUseWebSockets

setIncomingMessageThreadPoolSize

getIncomingMessageThreadPoolSize

setIncomingMessageQueueSize

getIncomingMessageQueueSize

setKeepAliveInterval

getKeepAliveInterval

setConnectRetries

getConnectRetries

setInfiniteReconnectRetries

isInfiniteReconnectRetries

isHttpsHostnameVerificationEnabled

setHttpsHostnameVerificationEnabled

setReconnectDelay

getReconnectDelay

setReconnectDelayMax

getReconnectDelayMax

setReconnectBackOffMultiplier

getReconnectBackOffMultiplier

setReconnectDelayRandom

getProxyAddress

setProxyAddress

getProxyPort

setProxyPort

getProxyUserName

setProxyUserName

getProxyPassword

setProxyPassword

write

getReconnectDelayRandom

setOperationTimeToWait

getOperationTimeToWait

setConnectTimeout

getConnectTimeout

setDisconnectTimeout

getDisconnectTimeout

createDxlConfigFromFile