com.hivemq.spi.services

Interface BlockingClientGroupService

public interface BlockingClientGroupService

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
void	addClientToGroup(String group, ClientData clientData) Adds a client to a group.
void	addClientToGroup(String group, String clientIdentifier) Adds a client to a group.
com.google.common.collect.ImmutableSet<String>	getAvailableGroups() Retrieves all available groups.
com.google.common.collect.ImmutableSet<String>	getClientsForGroup(String group) Retrieves the clients for a group.
void	removeClientFromGroup(String group, String clientIdentifier) Removes a client from a group.

Method Detail

addClientToGroup

void addClientToGroup(@NotNull
                    String group,
                    @NotNull
                    ClientData clientData)
                      throws NoSuchClientIdException

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.

Throws:

NoSuchClientIdException - if no session for the client to the given clientData exists.

IncompatibleHiveMQVersionException - if a node with a version lower than 3.3.0 exists in the cluster.

RateLimitExceededException - if the plugin service rate limit was exceeded.

addClientToGroup

void addClientToGroup(@NotNull
                    String group,
                    @NotNull
                    String clientIdentifier)
                      throws NoSuchClientIdException

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.

Throws:

NoSuchClientIdException - if no session for the client with the given identifier exists.

IncompatibleHiveMQVersionException - if a node with a version lower than 3.3.0 exists in the cluster.

RateLimitExceededException - if the plugin service rate limit was exceeded.

removeClientFromGroup

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.

Throws:

IncompatibleHiveMQVersionException - if a node with a version lower than 3.3.0 exists in the cluster.

RateLimitExceededException - if the plugin service rate limit was exceeded.

getClientsForGroup

@NotNull
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:

the clients belonging to the given group.

Throws:

IncompatibleHiveMQVersionException - if a node with a version lower than 3.3.0 exists in the cluster.

RateLimitExceededException - if the plugin service rate limit was exceeded.

getAvailableGroups

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

Retrieves all available groups.

Returns:

all available groups.

Throws:

IncompatibleHiveMQVersionException - if a node with a version lower than 3.3.0 exists in the cluster.

RateLimitExceededException - if the plugin service rate limit was exceeded.