com.hivemq.spi.services

Interface SubscriptionStore

Deprecated.

Use BlockingSubscriptionStore or AsyncSubscriptionStore instead.

@Deprecated
public interface SubscriptionStore

The subscription store allows the management of all client subscriptions from within a plugin

Since:

1.5

Author:

Lukas Brandl, Dominik Obermaier

Method Summary

Methods

Modifier and Type	Method and Description
com.google.common.util.concurrent.ListenableFuture<Void>	addSubscription(String clientID, Topic topic) Deprecated. Use BlockingSubscriptionStore or AsyncSubscriptionStore instead.
Set<String>	getLocalSubscribers(String topic) Deprecated. Use BlockingSubscriptionStore or AsyncSubscriptionStore instead.
com.google.common.collect.Multimap<String,Topic>	getLocalSubscriptions() Deprecated. Use BlockingSubscriptionStore or AsyncSubscriptionStore instead.
Set<Topic>	getLocalTopics(String clientID) Deprecated. Use BlockingSubscriptionStore or AsyncSubscriptionStore instead.
com.google.common.util.concurrent.ListenableFuture<Set<String>>	getSubscribers(String topic) Deprecated. Use BlockingSubscriptionStore or AsyncSubscriptionStore instead.
com.google.common.util.concurrent.ListenableFuture<com.google.common.collect.Multimap<String,Topic>>	getSubscriptions() Deprecated. Use BlockingSubscriptionStore or AsyncSubscriptionStore instead.
com.google.common.util.concurrent.ListenableFuture<Set<Topic>>	getTopics(String clientID) Deprecated. Use BlockingSubscriptionStore or AsyncSubscriptionStore instead.
com.google.common.util.concurrent.ListenableFuture<Void>	removeSubscription(String clientID, String topic) Deprecated. Use BlockingSubscriptionStore or AsyncSubscriptionStore instead.

Method Detail

getLocalSubscriptions

@ReadOnly
@Deprecated
com.google.common.collect.Multimap<String,Topic> getLocalSubscriptions()

Deprecated. Use BlockingSubscriptionStore or AsyncSubscriptionStore instead.

This method returns all subscriptions on this HiveMQ Node as a Multimap of client identifiers and topics. You won't receive subscriptions of connected clients from other HiveMQ nodes if HiveMQ runs in a cluster.

Please be aware that calling this method on HiveMQ instances with many subscriptions could have negative performance effects.

The returned Multimap is read-only and must not be modified.

Returns:

a Multimap of client identifiers and their topic subscriptions

getLocalSubscribers

@ReadOnly
@Deprecated
Set<String> getLocalSubscribers(@NotNull
                                                  String topic)

Deprecated. Use BlockingSubscriptionStore or AsyncSubscriptionStore instead.

Returns all MQTT client subscriber identifiers for a given topic, for this HiveMQ instance. MQTT Wildcards are allowed.

Don't pass null as topic. This method is lenient, so it will just return an empty Set.

The returned Set is read-only and must not be modified.

Parameters:

topic - the topic

Returns:

client identifiers of all subscribers that subscribed to the topic

getLocalTopics

@ReadOnly
@Deprecated
Set<Topic> getLocalTopics(@NotNull
                                            String clientID)

Deprecated. Use BlockingSubscriptionStore or AsyncSubscriptionStore instead.

Returns all topics a client is subscribed to, on this HiveMQ instance.

If the client does not exist, an empty Set is returned.

Don't pass null as clientId. This method is lenient, so it will just return an empty Set.

The returned Set is read-only and must not be modified.

Parameters:

clientID - of the client

Returns:

all topics the client subscribed to

addSubscription

@Deprecated
com.google.common.util.concurrent.ListenableFuture<Void> addSubscription(@NotNull
                                                                                  String clientID,
                                                                                  @NotNull
                                                                                  Topic topic)

Deprecated. Use BlockingSubscriptionStore or AsyncSubscriptionStore instead.

This method adds a subscription for a certain client to a certain topic. If HiveMQ is connected to a cluster, the subscription will be broadcast to all other Cluster Nodes.

This method is lenient, so if the clientId or the topic is null, nothing will happen.

Parameters:

clientID - client, which should be subscribed

topic - topic to which the client should be subscribed

Returns:

A ListenableFuture object that will succeed, as soon es the subscription was added by all Cluster Nodes.

removeSubscription

@Deprecated
com.google.common.util.concurrent.ListenableFuture<Void> removeSubscription(@NotNull
                                                                                     String clientID,
                                                                                     @NotNull
                                                                                     String topic)

Deprecated. Use BlockingSubscriptionStore or AsyncSubscriptionStore instead.

This method removes a subscription for a certain client and a certain topic. If HiveMQ is connected to a cluster, the subscription will be removed by other Cluster Nodes as well.

Parameters:

clientID - client, which should get unsubscribed

topic - topic from which the client should get unsubscribed

Returns:

A ListenableFuture object that will succeed, as soon es the subscription was removed by all Cluster Nodes.

getSubscriptions

@ReadOnly
@Deprecated
com.google.common.util.concurrent.ListenableFuture<com.google.common.collect.Multimap<String,Topic>> getSubscriptions()

Deprecated. Use BlockingSubscriptionStore or AsyncSubscriptionStore instead.

This method returns all subscriptions this HiveMQ instance and all other nodes in a HiveMQ cluster, as a Multimap of client identifiers and topics.

Please be aware that calling this method on HiveMQ instances with many subscriptions could have negative performance effects.

The returned Multimap is read-only and must not be modified.

Returns:

a Multimap of client identifiers and their topic subscriptions

getSubscribers

@ReadOnly
@Deprecated
com.google.common.util.concurrent.ListenableFuture<Set<String>> getSubscribers(@NotNull
                                                                                                 String topic)

Deprecated. Use BlockingSubscriptionStore or AsyncSubscriptionStore instead.

Returns all MQTT client subscriber identifiers for a given topic, this HiveMQ instance and all other nodes in a HiveMQ cluster. MQTT Wildcards are allowed.

Don't pass null as topic. This method is lenient, so it will just return an empty Set.

The returned Set is read-only and must not be modified.

Parameters:

topic - the topic

Returns:

client identifiers of all subscribers that subscribed to the topic

getTopics

@ReadOnly
@Deprecated
com.google.common.util.concurrent.ListenableFuture<Set<Topic>> getTopics(@NotNull
                                                                                           String clientID)

Deprecated. Use BlockingSubscriptionStore or AsyncSubscriptionStore instead.

Returns all topics a client is subscribed to, on this HiveMQ instance and all other nodes in a HiveMQ cluster.

If the client does not exist, an empty Set is returned.

Don't pass null as clientId. This method is lenient, so it will just return an empty Set.

The returned Set is read-only and must not be modified.

Parameters:

clientID - of the client

Returns:

all topics the client subscribed to