Package de.iip_ecosphere.platform.transport.spring.binder.hivemqv5

Class HivemqV5Client

java.lang.Object

de.iip_ecosphere.platform.transport.spring.binder.hivemqv5.HivemqV5Client

@Component
public class HivemqV5Client
extends java.lang.Object

A HiveMq client for all a single binder instance. Typically, different binders subscribe to different topics. Partially public for testing. Initial implementation, not optimized.

Author:

Holger Eichelberger, SSE

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	HivemqV5Client.ArrivedCallback	Called when a message for a topic arrives.

Field Summary

Fields

Modifier and Type	Field	Description
private com.hivemq.client.mqtt.mqtt5.Mqtt5AsyncClient	client
private HivemqV5Configuration	configuration
private static HivemqV5Client	lastInstance
private static org.slf4j.Logger	LOGGER
private com.hivemq.client.mqtt.datatypes.MqttQos	qos
private java.util.Set<java.lang.String>	topics

Constructor Summary

Constructors

Constructor	Description
HivemqV5Client()	Creates and registers an instance.

Method Summary

Modifier and Type	Method	Description
void	createClient(HivemqV5Configuration config)	Creates the client based on a given MQTT client configuration.
HivemqV5Configuration	getConfiguration()	Returns the actual configuration.
static HivemqV5Client	getLastInstance()	Returns the last instance created for this class.
(package private) void	send(java.lang.String topic, byte[] payload)	Sends payload to topic.
void	stopClient()	Stops the client.
(package private) boolean	subscribeTo(java.lang.String topic, HivemqV5Client.ArrivedCallback arrivedCallback)	Subscribes to topic if topic is not blacklisted by HivemqV5Configuration.isFilteredTopic(String).
(package private) boolean	unsubscribeFrom(java.lang.String topic)	Unsubscribes from topic if topic is not blacklisted by HivemqV5Configuration.isFilteredTopic(String).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOGGER

private static final org.slf4j.Logger LOGGER

lastInstance

private static HivemqV5Client lastInstance

client

private com.hivemq.client.mqtt.mqtt5.Mqtt5AsyncClient client

configuration

private HivemqV5Configuration configuration

qos

private com.hivemq.client.mqtt.datatypes.MqttQos qos

topics

private java.util.Set<java.lang.String> topics

Constructor Detail

HivemqV5Client

public HivemqV5Client()

Creates and registers an instance.

Method Detail

getLastInstance

public static HivemqV5Client getLastInstance()

Returns the last instance created for this class. [testing]

Returns:

the last instance

getConfiguration

public HivemqV5Configuration getConfiguration()

Returns the actual configuration. [for testing]

Returns:

the configuration, may be null

createClient

public void createClient(HivemqV5Configuration config)

Creates the client based on a given MQTT client configuration.

Parameters:

config - the MQTT configuration to take the connection information from

stopClient

public void stopClient()

Stops the client.

subscribeTo

boolean subscribeTo(java.lang.String topic,
                    HivemqV5Client.ArrivedCallback arrivedCallback)

Subscribes to topic if topic is not blacklisted by HivemqV5Configuration.isFilteredTopic(String).

Parameters:

topic - the topic to unsubscribe from

arrivedCallback - the callback to be called when a message arrived

Returns:

true if done/successful, false else

unsubscribeFrom

boolean unsubscribeFrom(java.lang.String topic)

Unsubscribes from topic if topic is not blacklisted by HivemqV5Configuration.isFilteredTopic(String).

Parameters:

topic - the topic to unsubscribe from

Returns:

true if done/successful, false else

send

void send(java.lang.String topic,
          byte[] payload)

Sends payload to topic.

Parameters:

topic - the topic to send to

payload - the payload to send