+MqttConnectOptions (MQTT v3 Client API) +

From cc8ace92f17c8e5aef7d68ff316e5cd038cd36b5 Mon Sep 17 00:00:00 2001 From: Nathan Lasseter Date: Wed, 22 May 2013 15:34:00 +0100 Subject: Initial Commit --- .../paho/client/mqttv3/MqttConnectOptions.html | 726 +++++++++++++++++++++ 1 file changed, 726 insertions(+) create mode 100644 libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttConnectOptions.html (limited to 'libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttConnectOptions.html') diff --git a/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttConnectOptions.html b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttConnectOptions.html new file mode 100644 index 0000000..8f221a8 --- /dev/null +++ b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttConnectOptions.html @@ -0,0 +1,726 @@ + + + + + + +MqttConnectOptions (MQTT v3 Client API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ + + + + + + + + + + + +

Package

Class

Use

Tree

Serialized

Deprecated

Index

Help

+ +

+ PREV CLASS + NEXT CLASS

+ FRAMES + NO FRAMES + + + +

+ SUMMARY: NESTED | FIELD | CONSTR | METHOD

+DETAIL: FIELD | CONSTR | METHOD

+ + + +

+ + +

+ +org.eclipse.paho.client.mqttv3 +
+Class MqttConnectOptions

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

public class MqttConnectOptions
extends java.lang.Object

+ +

+Stores options used when connecting to a server. +

+ +

+ + + + + + + + + + + + + + + + +
+Constructor Summary
MqttConnectOptions() + +
+          Constructs a new MqttConnectOptions object using the + default values. + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ int getConnectionTimeout() + +
+          Returns the connection timeout value.
+ int getKeepAliveInterval() + +
+          Returns the "keep alive" interval.
+ char[] getPassword() + +
+          Returns the password to use for the connection.
+ 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.
+ MqttTopic 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 isCleanSession() + +
+          Returns whether the server should remember state for the client across reconnects.
+ void setCleanSession(boolean cleanSession) + +
+          Sets whether the server should remember state for the client across reconnects. +
+ void setConnectionTimeout(int connectionTimeout) + +
+          Sets the connection timeout value. +
+ void setKeepAliveInterval(int keepAliveInterval) + +
+          Sets the "keep alive" interval. +
+ void setPassword(char[] password) + +
+          Sets the password to use for the connection.
+ 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. +
+ + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+ +

+Constructor Summary
`MqttConnectOptions()` + + + Constructs a new `MqttConnectOptions` object using the + default values. + +

+Method Summary
+ `int`	`getConnectionTimeout()` + + + Returns the connection timeout value.
+ `int`	`getKeepAliveInterval()` + + + Returns the "keep alive" interval.
+ `char[]`	`getPassword()` + + + Returns the password to use for the connection.
+ `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.
+ `MqttTopic`	`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`	`isCleanSession()` + + + Returns whether the server should remember state for the client across reconnects.
+ `void`	`setCleanSession(boolean cleanSession)` + + + Sets whether the server should remember state for the client across reconnects. +
+ `void`	`setConnectionTimeout(int connectionTimeout)` + + + Sets the connection timeout value. +
+ `void`	`setKeepAliveInterval(int keepAliveInterval)` + + + Sets the "keep alive" interval. +
+ `void`	`setPassword(char[] password)` + + + Sets the password to use for the connection.
+ `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. +

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

+ + + + + + + + + + + +
+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.

+ +

+getKeepAliveInterval

+public int getKeepAliveInterval()

Returns the "keep alive" interval. +

Returns:: the keep alive interval.
See Also:: setKeepAliveInterval(int)

+ +

+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 that if the server is no longer available, without + having to wait for the long 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. +

The default value is 60 seconds

Parameters:: keepAliveInterval - the interval, measured in seconds.

+ +

+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 calls to connect, + subscribe and + unsubscribe to complete. + The default timeout is 30 seconds. +

Parameters:: connectionTimeout - the timeout value, measured in seconds.

+ +

+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 MqttTopic 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 server should remember state for the client across reconnects. +

Returns:: the clean session flag

+ +

+setCleanSession

+public void setCleanSession(boolean cleanSession)

Sets whether the server should remember state for the client across reconnects. + This includes subscriptions and the state of any in-flight messages. +

+ +