com.esf.net.mqtt.client.service

Interface IEsfMqttService

public interface IEsfMqttService

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLOUD_ACCOUNT_NAME
static java.lang.String	CLOUD_BIRTH_MESSAGE
static java.lang.String	CLOUD_BIRTH_QOS
static java.lang.String	CLOUD_BIRTH_RETAIN
static java.lang.String	CLOUD_BIRTH_TOPIC
static java.lang.String	CLOUD_BIRTH_TOPIC_SUFFIX
static java.lang.String	CLOUD_BROKER_URL
static java.lang.String	CLOUD_CLEAN_START
static java.lang.String	CLOUD_CONTROL_SUB_QOS
static java.lang.String	CLOUD_CONTROL_SUB_TOPIC
static java.lang.String	CLOUD_CONTROL_TOPIC
static java.lang.String	CLOUD_DATA_PUB_QOS
static java.lang.String	CLOUD_DATA_PUB_RETAIN
static java.lang.String	CLOUD_DATA_SUB_QOS
static java.lang.String	CLOUD_DATA_TOPIC_PREFIX
static java.lang.String	CLOUD_DISCONNECT_MESSAGE
static java.lang.String	CLOUD_DISCONNECT_QOS
static java.lang.String	CLOUD_DISCONNECT_RETAIN
static java.lang.String	CLOUD_DISCONNECT_TOPIC
static java.lang.String	CLOUD_DISCONNECT_TOPIC_SUFFIX
static java.lang.String	CLOUD_DISPLAY_NAME
static java.lang.String	CLOUD_KEEP_ALIVE
static java.lang.String	CLOUD_MASTER_AUTOCONNECT
static java.lang.String	CLOUD_MASTER_CONNECTION_LOST_TIMEOUT
static java.lang.String	CLOUD_MASTER_ENABLED
static java.lang.String	CLOUD_PASSWORD
static java.lang.String	CLOUD_RECONNECT_INTERVAL
static java.lang.String	CLOUD_USERNAME
static java.lang.String	CLOUD_WAIT_INTERVAL
static java.lang.String	CLOUD_WILL_MESSAGE
static java.lang.String	CLOUD_WILL_QOS
static java.lang.String	CLOUD_WILL_RETAIN
static java.lang.String	CLOUD_WILL_TOPIC
static java.lang.String	CLOUD_WILL_TOPIC_SUFFIX
static java.lang.String	SERVICE_NAME

Method Summary

Methods

Modifier and Type	Method and Description
void	connectEsfMqttMasterClient() Connects the ESF MQtt Master Client if auto-connect is disabled.
IEsfMqttCloudClient	createCloudIEsfMqttClient(java.lang.String clientId) Returns a IEsfMqttCloudClient implementation.
void	disconnectEsfMqttMasterClient() Disconnects the ESF MQtt Master Client if auto-connect is disabled.
IEsfMqttMasterClient	getEsfMqttMasterClient() Returns an interface to the ESF MQtt Master Client.
IEsfMqttMasterClient	getEsfMqttMasterClient(java.lang.String appId) Returns an interface to the ESF MQtt Master Client.

Field Detail

SERVICE_NAME

static final java.lang.String SERVICE_NAME

CLOUD_ACCOUNT_NAME

static final java.lang.String CLOUD_ACCOUNT_NAME

See Also:

Constant Field Values

CLOUD_DISPLAY_NAME

static final java.lang.String CLOUD_DISPLAY_NAME

See Also:

Constant Field Values

CLOUD_USERNAME

static final java.lang.String CLOUD_USERNAME

See Also:

Constant Field Values

CLOUD_PASSWORD

static final java.lang.String CLOUD_PASSWORD

See Also:

Constant Field Values

CLOUD_BROKER_URL

static final java.lang.String CLOUD_BROKER_URL

See Also:

Constant Field Values

CLOUD_MASTER_ENABLED

static final java.lang.String CLOUD_MASTER_ENABLED

See Also:

Constant Field Values

CLOUD_MASTER_AUTOCONNECT

static final java.lang.String CLOUD_MASTER_AUTOCONNECT

See Also:

Constant Field Values

CLOUD_KEEP_ALIVE

static final java.lang.String CLOUD_KEEP_ALIVE

See Also:

Constant Field Values

CLOUD_CLEAN_START

static final java.lang.String CLOUD_CLEAN_START

See Also:

Constant Field Values

CLOUD_RECONNECT_INTERVAL

static final java.lang.String CLOUD_RECONNECT_INTERVAL

See Also:

Constant Field Values

CLOUD_WAIT_INTERVAL

static final java.lang.String CLOUD_WAIT_INTERVAL

See Also:

Constant Field Values

CLOUD_MASTER_CONNECTION_LOST_TIMEOUT

static final java.lang.String CLOUD_MASTER_CONNECTION_LOST_TIMEOUT

See Also:

Constant Field Values

CLOUD_CONTROL_TOPIC

static final java.lang.String CLOUD_CONTROL_TOPIC

See Also:

Constant Field Values

CLOUD_CONTROL_SUB_TOPIC

static final java.lang.String CLOUD_CONTROL_SUB_TOPIC

See Also:

Constant Field Values

CLOUD_CONTROL_SUB_QOS

static final java.lang.String CLOUD_CONTROL_SUB_QOS

See Also:

Constant Field Values

CLOUD_WILL_TOPIC_SUFFIX

static final java.lang.String CLOUD_WILL_TOPIC_SUFFIX

See Also:

Constant Field Values

CLOUD_WILL_TOPIC

static final java.lang.String CLOUD_WILL_TOPIC

See Also:

Constant Field Values

CLOUD_WILL_MESSAGE

static final java.lang.String CLOUD_WILL_MESSAGE

See Also:

Constant Field Values

CLOUD_WILL_QOS

static final java.lang.String CLOUD_WILL_QOS

See Also:

Constant Field Values

CLOUD_WILL_RETAIN

static final java.lang.String CLOUD_WILL_RETAIN

See Also:

Constant Field Values

CLOUD_DISCONNECT_TOPIC_SUFFIX

static final java.lang.String CLOUD_DISCONNECT_TOPIC_SUFFIX

See Also:

Constant Field Values

CLOUD_DISCONNECT_TOPIC

static final java.lang.String CLOUD_DISCONNECT_TOPIC

See Also:

Constant Field Values

CLOUD_DISCONNECT_MESSAGE

static final java.lang.String CLOUD_DISCONNECT_MESSAGE

See Also:

Constant Field Values

CLOUD_DISCONNECT_QOS

static final java.lang.String CLOUD_DISCONNECT_QOS

See Also:

Constant Field Values

CLOUD_DISCONNECT_RETAIN

static final java.lang.String CLOUD_DISCONNECT_RETAIN

See Also:

Constant Field Values

CLOUD_BIRTH_TOPIC_SUFFIX

static final java.lang.String CLOUD_BIRTH_TOPIC_SUFFIX

See Also:

Constant Field Values

CLOUD_BIRTH_TOPIC

static final java.lang.String CLOUD_BIRTH_TOPIC

See Also:

Constant Field Values

CLOUD_BIRTH_MESSAGE

static final java.lang.String CLOUD_BIRTH_MESSAGE

See Also:

Constant Field Values

CLOUD_BIRTH_QOS

static final java.lang.String CLOUD_BIRTH_QOS

See Also:

Constant Field Values

CLOUD_BIRTH_RETAIN

static final java.lang.String CLOUD_BIRTH_RETAIN

See Also:

Constant Field Values

CLOUD_DATA_TOPIC_PREFIX

static final java.lang.String CLOUD_DATA_TOPIC_PREFIX

See Also:

Constant Field Values

CLOUD_DATA_PUB_QOS

static final java.lang.String CLOUD_DATA_PUB_QOS

See Also:

Constant Field Values

CLOUD_DATA_PUB_RETAIN

static final java.lang.String CLOUD_DATA_PUB_RETAIN

See Also:

Constant Field Values

CLOUD_DATA_SUB_QOS

static final java.lang.String CLOUD_DATA_SUB_QOS

See Also:

Constant Field Values

Method Detail

createCloudIEsfMqttClient

IEsfMqttCloudClient createCloudIEsfMqttClient(java.lang.String clientId)
                                              throws EsfMqttException

Returns a IEsfMqttCloudClient implementation. If the method fails, an exception will be thrown indicating the cause of the failure.

Parameters:

clientId - A String object specifying the client ID.

Returns:

An IEsfMqttCloudClient implementation.

Throws:

EsfMqttException

getEsfMqttMasterClient

IEsfMqttMasterClient getEsfMqttMasterClient()
                                            throws EsfMqttException

Returns an interface to the ESF MQtt Master Client. This method will generate a random unique application ID that will change with each instance that is return. This method should only be used by applications that are using the MQtt clean start option, i.e., clean start is set to true. If an application needs subscriptions persisted it will need to use the getESfMqttMasterClient(String appId) method and specify its own unique application ID.

Returns:

An IEsfMqttMasterClient implementation.

Throws:

EsfMqttException

getEsfMqttMasterClient

IEsfMqttMasterClient getEsfMqttMasterClient(java.lang.String appId)
                                            throws EsfMqttException

Returns an interface to the ESF MQtt Master Client. The specified application ID must be unique or an exception will be thrown. This method should be used by applications that are NOT using the MQtt cleans start option, i.e., clean start is set to false. An application ID may not contain the character "." and consist of only valid ASCII text.

Parameters:

appId - A String object specifying a unique application ID.

Returns:

An IEsfMqttMasterClient implementation.

Throws:

EsfMqttException

connectEsfMqttMasterClient

void connectEsfMqttMasterClient()
                                throws EsfMqttException

Connects the ESF MQtt Master Client if auto-connect is disabled.

Throws:

EsfMqttException

disconnectEsfMqttMasterClient

void disconnectEsfMqttMasterClient()
                                   throws EsfMqttException

Disconnects the ESF MQtt Master Client if auto-connect is disabled.

Throws:

EsfMqttException