Index

A B C E G H I K M O P Q R S T U V W
All Classes|All Packages

A

AT_LEAST_ONCE - cool.mqtt.hooks.QoS

The singleton instance for At least once level.

AT_MOST_ONCE - cool.mqtt.hooks.QoS

The singleton instance for At most once level.

B

build() - Method in class cool.mqtt.hooks.utils.MqttBrokerConfigBuilder

Returns a new MqttBrokerConfig instance initialized with all parameters provided to this builder.

C

canConnect(String, String, String, MqttConnectOptions) - Method in interface cool.mqtt.hooks.MQTTCoolHook

Checks whether the client is authorized to connect to the MQTT broker hosted at the specified address.

canConnect(String, String, String, MqttConnectOptions) - Method in class cool.mqtt.hooks.SimpleCoolHook

This implementation always returns true.

canOpenSession(String, String, String, Map, String) - Method in interface cool.mqtt.hooks.MQTTCoolHook

Checks whether the client is authorized to open a new session against MQTT.Cool.

canOpenSession(String, String, String, Map, String) - Method in class cool.mqtt.hooks.SimpleCoolHook

This implementation always returns true.

canPublish(String, String, String, MqttMessage) - Method in interface cool.mqtt.hooks.MQTTCoolHook

Checks whether the client is authorized to publish the given message to the specified MQTT broker.

canPublish(String, String, String, MqttMessage) - Method in class cool.mqtt.hooks.SimpleCoolHook

This implementation always returns true.

canSubscribe(String, String, String, MqttSubscription) - Method in interface cool.mqtt.hooks.MQTTCoolHook

Checks whether the client is authorized to send the given subscription to the specified MQTT broker.

canSubscribe(String, String, String, MqttSubscription) - Method in class cool.mqtt.hooks.SimpleCoolHook

This implementation always returns true.

clientIdPrefix(String) - Method in class cool.mqtt.hooks.utils.MqttBrokerConfigBuilder

Sets the ClientId prefix (to be used for shared connection) on this builder.

connectionTimeout(int) - Method in class cool.mqtt.hooks.utils.MqttBrokerConfigBuilder

Sets the connection timeout expressed in seconds on this builder.

cool.mqtt.hooks - package cool.mqtt.hooks

cool.mqtt.hooks.utils - package cool.mqtt.hooks.utils

E

EXACTLY_ONCE - cool.mqtt.hooks.QoS

The singleton instance for Exactly once level.

G

getAddress() - Method in interface cool.mqtt.hooks.MqttBrokerConfig

Gets the address of the MQTT broker to connect to.

getApplicationMessage() - Method in interface cool.mqtt.hooks.MqttMessage

Gets the Application Message carried by this message.

getClientIdPrefix() - Method in interface cool.mqtt.hooks.MqttBrokerConfig

Gets the ClientId prefix to be used for shared connections.

getCode() - Method in exception cool.mqtt.hooks.HookException

Returns the error code.

getConnectionTimeout() - Method in interface cool.mqtt.hooks.MqttBrokerConfig

Gets the connection timeout expressed in seconds.

getConnectionTimeout() - Method in interface cool.mqtt.hooks.MqttConnectOptions

Gets the connection timeout expressed in seconds.

getKeepAlive() - Method in interface cool.mqtt.hooks.MqttBrokerConfig

Gets the keep alive interval expressed in seconds.

getKeepAlive() - Method in interface cool.mqtt.hooks.MqttConnectOptions

Gets the keep alive interval expressed in seconds.

getKeystorePassword() - Method in interface cool.mqtt.hooks.SecurityParams

The password for the JKS keystore.

getKeystorePath() - Method in interface cool.mqtt.hooks.SecurityParams

The absolute path to the JKS keystore, which contains the client certificate and the private key to be used in the case the target MQTT broker requires client authentication.

getPassword() - Method in interface cool.mqtt.hooks.MqttBrokerConfig

Gets the password for authenticating with the MQTT broker.

getPassword() - Method in interface cool.mqtt.hooks.MqttConnectOptions

Gets the password to be used for authenticating with the target MQTT broker.

getPrivateKeyPassword() - Method in interface cool.mqtt.hooks.SecurityParams

The password for the private key stored into the JSK keystore.

getQos() - Method in interface cool.mqtt.hooks.MqttMessage

Gets the Quality of Service level with which this message has been delivered.

getQos() - Method in interface cool.mqtt.hooks.MqttSubscription

Gets the maximum Quality Of Service level which the target MQTT broker is allowed to send Application Messages.

getSecurityParams() - Method in interface cool.mqtt.hooks.MqttBrokerConfig

Gets the SecureParams instance to be used for supporting the setting up of encrypted connections to the MQTT broker.

getSecurityProtocol() - Method in interface cool.mqtt.hooks.SecurityParams

The standard name of the security protocol to be used, as specified in the Java Cryptography Architecture Standard Algorithm Name.

getTopicFilter() - Method in interface cool.mqtt.hooks.MqttSubscription

Gets the topic filter indicating one or more topics to which the client subscribe.

getTopicName() - Method in interface cool.mqtt.hooks.MqttMessage

Gets the name of the topic to which this message is being published.

getTruststorePassword() - Method in interface cool.mqtt.hooks.SecurityParams

The password for the JKS truststore.

getTruststorePath() - Method in interface cool.mqtt.hooks.SecurityParams

The absolute path to the JKS truststore, which contains the MQTT broker certificate to trust.

getUsername() - Method in interface cool.mqtt.hooks.MqttBrokerConfig

Gets the username for authenticating with the MQTT broker.

getUsername() - Method in interface cool.mqtt.hooks.MqttConnectOptions

Gets the username to be used for authenticating with the target MQTT broker.

getValue() - Method in enum cool.mqtt.hooks.QoS

Gets the Quality of Service level int value.

getWillMessage() - Method in interface cool.mqtt.hooks.MqttBrokerConfig

Gets the Will Message to be stored by the MQTT broker.

getWillMessage() - Method in interface cool.mqtt.hooks.MqttConnectOptions

Gets the Will Message to be stored by the MQTT broker.

H

HookException - Exception in cool.mqtt.hooks

Exception class used by the Hook to signal an error condition.

HookException(int, String) - Constructor for exception cool.mqtt.hooks.HookException

Constructs an HookException with the specified error code and detail message.

I

init(File) - Method in interface cool.mqtt.hooks.MQTTCoolHook

Called during the MQTT.Cool initialization process.

init(File) - Method in class cool.mqtt.hooks.SimpleCoolHook

This implementation is void.

isCleanSession() - Method in interface cool.mqtt.hooks.MqttConnectOptions

Gets the clean session flag specified by the client on connection establishment.

isDuplicate() - Method in interface cool.mqtt.hooks.MqttMessage

Gets the duplicate flag of this message.

isRetained() - Method in interface cool.mqtt.hooks.MqttMessage

Gets the retained flag of this message.

K

keepAlive(int) - Method in class cool.mqtt.hooks.utils.MqttBrokerConfigBuilder

Sets the keep alive interval expressed in seconds on this builder.

keystorePassword(char[]) - Method in class cool.mqtt.hooks.utils.MqttBrokerConfigBuilder

Sets the password for the JKS keystore on this builder.

keystorePath(Path) - Method in class cool.mqtt.hooks.utils.MqttBrokerConfigBuilder

Sets the absolute path to the JKS keystore on this builder.

M

MqttBrokerConfig - Interface in cool.mqtt.hooks

An encapsulation of the MQTT broker configuration corresponding to the connection alias provided by a client on connection establishment with MQTT.Cool.

MqttBrokerConfigBuilder - Class in cool.mqtt.hooks.utils

Simple builder class to simplify the making of an MqttBrokerConfig instance.

MqttBrokerConfigBuilder(String) - Constructor for class cool.mqtt.hooks.utils.MqttBrokerConfigBuilder

Creates an MqttBrokerConfigBuilder initialized with the specified MQTT broker address.

MqttConnectOptions - Interface in cool.mqtt.hooks

A wrapper of the connection parameters actually used by the MQTT.Cool server while establishing the end-to-end connection between the client and the target MQTT broker.

MQTTCoolHook - Interface in cool.mqtt.hooks

Interface that defines an MQTT.Cool Hook.

MqttMessage - Interface in cool.mqtt.hooks

An abstraction of the PUBLISH Control Packet, sent by a client and then passed to the Hook, before being encoded and finally delivered to the target MQTT broker.

MqttSubscription - Interface in cool.mqtt.hooks

An abstraction of the SUBSCRIBE Control Packet, sent by the client and passed to the Hook, before being encoded and finally submitted to the target MQTT broker.

O

onDisconnection(String, String, String) - Method in interface cool.mqtt.hooks.MQTTCoolHook

Called to notify the Hook that a client has been disconnected from the specified MQTT broker.

onDisconnection(String, String, String) - Method in class cool.mqtt.hooks.SimpleCoolHook

This implementation is void.

onSessionClose(String) - Method in interface cool.mqtt.hooks.MQTTCoolHook

Called to notify the Hook that a session opened against MQTT.Cool has been closed.

onSessionClose(String) - Method in class cool.mqtt.hooks.SimpleCoolHook

This implementation is void.

onUnsubscribe(String, String, String, String) - Method in interface cool.mqtt.hooks.MQTTCoolHook

Called to notify the Hook that a client, connected to the specified MQTT broker, has been unsubscribed from the given topic filter.

onUnsubscribe(String, String, String, String) - Method in class cool.mqtt.hooks.SimpleCoolHook

This implementation is void.

P

password(String) - Method in class cool.mqtt.hooks.utils.MqttBrokerConfigBuilder

Sets the password on this builder.

privateKeyPassword(char[]) - Method in class cool.mqtt.hooks.utils.MqttBrokerConfigBuilder

Sets the password for the private key (stored into the JSK keystore) on this builder.

Q

QoS - Enum in cool.mqtt.hooks

The Quality of Service.

R

resolveAlias(String) - Method in interface cool.mqtt.hooks.MQTTCoolHook

Gets an MqttBrokerConfig instance corresponding to the connection alias provided by the client while connecting to MQTT.Cool, if no other static entries have been provided in the mqtt_master_connector_conf.xml file for the given alias.

resolveAlias(String) - Method in class cool.mqtt.hooks.SimpleCoolHook

This implementation always returns null.

S

SecurityParams - Interface in cool.mqtt.hooks

A wrapper of the parameters used to support the setting up of encrypted connections between the MQTT.Cool server and the target MQTT broker.

securityProtocol(String) - Method in class cool.mqtt.hooks.utils.MqttBrokerConfigBuilder

Sets the standard name of the security protocol on this builder.

SimpleCoolHook - Class in cool.mqtt.hooks

Simple skeletal implementation of the MQTTCoolHook interface, meant as a base class to be extended in order to minimize the effort required to provide a full implementation of a custom Hook.

SimpleCoolHook() - Constructor for class cool.mqtt.hooks.SimpleCoolHook

T

truststorePassword(char[]) - Method in class cool.mqtt.hooks.utils.MqttBrokerConfigBuilder

Sets the password for the JKS truststore on this builder.

truststorePath(Path) - Method in class cool.mqtt.hooks.utils.MqttBrokerConfigBuilder

Sets the absolute path to the JKS truststore on this builder.

U

username(String) - Method in class cool.mqtt.hooks.utils.MqttBrokerConfigBuilder

Sets the username on this builder.

V

valueOf(String) - Static method in enum cool.mqtt.hooks.QoS

Returns the enum constant of this type with the specified name.

values() - Static method in enum cool.mqtt.hooks.QoS

Returns an array containing the constants of this enum type, in the order they are declared.

W

willMessage(String, byte[], QoS, boolean) - Method in class cool.mqtt.hooks.utils.MqttBrokerConfigBuilder

Sets the Will Message on this builder.

A B C E G H I K M O P Q R S T U V W
All Classes|All Packages