com.hivemq.spi.services

Interface AsyncClientGroupService

public interface AsyncClientGroupService

Through this client group service a plugin can add clients to groups, remove clients from groups, query groups and query clients belonging to a group.

The client group service is only available for clients which already have a session available. When a client connects, the earliest point in time to add the client to a group is the OnSessionReadyCallback.

The client group service is only available when all nodes in the HiveMQ cluster are at version 3.3.0 or above.

Since:

3.3.0

Author:

Silvio Giebl

Method Summary

Methods

Modifier and Type	Method and Description
com.google.common.util.concurrent.ListenableFuture<Void>	addClientToGroup(String group, ClientData clientData) Adds a client to a group.
com.google.common.util.concurrent.ListenableFuture<Void>	addClientToGroup(String group, String clientIdentifier) Adds a client to a group.
com.google.common.util.concurrent.ListenableFuture<com.google.common.collect.ImmutableSet<String>>	getAvailableGroups() Retrieves all available groups.
com.google.common.util.concurrent.ListenableFuture<com.google.common.collect.ImmutableSet<String>>	getClientsForGroup(String group) Retrieves the clients for a group.
com.google.common.util.concurrent.ListenableFuture<Void>	removeClientFromGroup(String group, String clientIdentifier) Removes a client from a group.

Method Detail

addClientToGroup

@NotNull
com.google.common.util.concurrent.ListenableFuture<Void> addClientToGroup(@NotNull
                                                                                String group,
                                                                                @NotNull
                                                                                ClientData clientData)

Adds a client to a group.

Parameters:

group - the group the client will be added to.

clientData - the clientData of the client which will be added to the group.

Returns:

a ListenableFuture succeeding when the client is added to the group, failing with a NoSuchClientIdException if no session for the client to the given clientData exists, failing with a IncompatibleHiveMQVersionException if a node with a version lower than 3.3.0 exists in the cluster. failing with a RateLimitExceededException if the plugin service rate limit was exceeded.

addClientToGroup

@NotNull
com.google.common.util.concurrent.ListenableFuture<Void> addClientToGroup(@NotNull
                                                                                String group,
                                                                                @NotNull
                                                                                String clientIdentifier)

Adds a client to a group.

Parameters:

group - the group the client will be added to.

clientIdentifier - the identifier of the client which will be added to the group.

Returns:

a ListenableFuture succeeding when the client is added to the group, failing with a NoSuchClientIdException if no session for the client with the given identifier exists, failing with a IncompatibleHiveMQVersionException if a node with a version lower than 3.3.0 exists in the cluster. failing with a RateLimitExceededException if the plugin service rate limit was exceeded.

removeClientFromGroup

@NotNull
com.google.common.util.concurrent.ListenableFuture<Void> removeClientFromGroup(@NotNull
                                                                                     String group,
                                                                                     @NotNull
                                                                                     String clientIdentifier)

Removes a client from a group.

Parameters:

group - the group the client will be removed from.

clientIdentifier - the identifier of the client which will be added to the group.

Returns:

a ListenableFuture succeeding when the client is removed from the group, failing with a IncompatibleHiveMQVersionException if a node with a version lower than 3.3.0 exists in the cluster. failing with a RateLimitExceededException if the plugin service rate limit was exceeded.

getClientsForGroup

@NotNull
com.google.common.util.concurrent.ListenableFuture<com.google.common.collect.ImmutableSet<String>> getClientsForGroup(@NotNull
                                                                                                                            String group)

Retrieves the clients for a group.

Parameters:

group - the group the clients will be retrieved of.

Returns:

a ListenableFuture succeeding with the clients belonging to the given group, failing with a IncompatibleHiveMQVersionException if a node with a version lower than 3.3.0 exists in the cluster. failing with a RateLimitExceededException if the plugin service rate limit was exceeded.

getAvailableGroups

@NotNull
com.google.common.util.concurrent.ListenableFuture<com.google.common.collect.ImmutableSet<String>> getAvailableGroups()

Retrieves all available groups.

Returns:

a ListenableFuture succeeding with the all available groups, failing with a IncompatibleHiveMQVersionException if a node with a version lower than 3.3.0 exists in the cluster. failing with a RateLimitExceededException if the plugin service rate limit was exceeded.