com.hivemq.spi.services

Interface ClientService

Deprecated.

Use BlockingClientService or AsyncClientService instead.

@Deprecated
public interface ClientService

Through this client service a plugin can query details about connected or disconnected clients (with a persistent session) from the HiveMQ core.

Since:

3.0

Author:

Lukas Brandl

Method Summary

Methods

Modifier and Type	Method and Description
com.google.common.util.concurrent.ListenableFuture<com.google.common.base.Optional<ClientData>>	getClientDataForClientId(String clientId) Deprecated. Use BlockingClientService or AsyncClientService instead.
com.google.common.util.concurrent.ListenableFuture<Set<String>>	getConnectedClients() Deprecated. Use BlockingClientService or AsyncClientService instead.
com.google.common.util.concurrent.ListenableFuture<Set<String>>	getDisconnectedClients() Deprecated. Use BlockingClientService or AsyncClientService instead.
com.google.common.base.Optional<ClientData>	getLocalClientDataForClientId(String clientId) Deprecated. Use BlockingClientService or AsyncClientService instead.
Set<String>	getLocalConnectedClients() Deprecated. Use BlockingClientService or AsyncClientService instead.
Set<String>	getLocalDisconnectedClients() Deprecated. Use BlockingClientService or AsyncClientService instead.
com.google.common.util.concurrent.ListenableFuture<Boolean>	isClientConnected(String clientId) Deprecated. Use BlockingClientService or AsyncClientService instead.
boolean	isClientConnectedLocal(String clientId) Deprecated. Use BlockingClientService or AsyncClientService instead.

Method Detail

getLocalConnectedClients

@Deprecated
Set<String> getLocalConnectedClients()

Deprecated. Use BlockingClientService or AsyncClientService instead.

Returns all identifiers of connected clients of this HiveMQ Node. You won't receive client identifiers of connected clients from other HiveMQ nodes if HiveMQ runs in a cluster.

If you have many client connections, please not that calling this method frequently could have negative performance effects.

Returns:

client identifiers of all connected clients

getLocalDisconnectedClients

@Deprecated
Set<String> getLocalDisconnectedClients()

Deprecated. Use BlockingClientService or AsyncClientService instead.

Returns all disconnected clients which have a persistent MQTT session on this instance of HiveMQ (MQTT clean session=false).

Disconnected MQTT clients which don't have a persistent session won't be returned by this method

Returns:

all disconnected clients with a persistent MQTT session

isClientConnectedLocal

@Deprecated
boolean isClientConnectedLocal(String clientId)

Deprecated. Use BlockingClientService or AsyncClientService instead.

Check if a client with a given identifier is currently connected to this HiveMQ instance.

Parameters:

clientId - client, which should be checked

Returns:

true, if a certain client is currently connected and false otherwise

getLocalClientDataForClientId

@Deprecated
com.google.common.base.Optional<ClientData> getLocalClientDataForClientId(String clientId)

Deprecated. Use BlockingClientService or AsyncClientService instead.

Returns client information for clients that are connected to this broker instance.

If the client isn't connected, you will receive an Optional with absent data.

Parameters:

clientId - the client identifier of the client

Returns:

ClientData for a specific client.

getConnectedClients

@Deprecated
com.google.common.util.concurrent.ListenableFuture<Set<String>> getConnectedClients()

Deprecated. Use BlockingClientService or AsyncClientService instead.

Returns all identifiers of connected clients of this HiveMQ instance and all other nodes in a HiveMQ cluster

Calling this method frequently in a clustered environment could have negative performance effects.

Returns:

client identifiers of all connected clients

getDisconnectedClients

@Deprecated
com.google.common.util.concurrent.ListenableFuture<Set<String>> getDisconnectedClients()

Deprecated. Use BlockingClientService or AsyncClientService instead.

Returns all disconnected clients which have a persistent MQTT session on this broker or any other cluster node.

Disconnected MQTT clients which don't have a persistent session won't be returned by this method

Returns:

all disconnected clients with a persistent MQTT session

isClientConnected

@Deprecated
com.google.common.util.concurrent.ListenableFuture<Boolean> isClientConnected(String clientId)

Deprecated. Use BlockingClientService or AsyncClientService instead.

Check if a client with a given identifier is currently connected to this HiveMQ broker instance or any other instance in the cluster.

Parameters:

clientId - client, which should be checked

Returns:

true, if a certain client is currently connected and false otherwise

getClientDataForClientId

@Deprecated
com.google.common.util.concurrent.ListenableFuture<com.google.common.base.Optional<ClientData>> getClientDataForClientId(String clientId)

Deprecated. Use BlockingClientService or AsyncClientService instead.

Returns additional client information about a given client with a given client identifier.

This method will also get client information from other cluster nodes if needed.

If the client isn't connected, you will receive an Optional with absent data.

Parameters:

clientId - the client identifier of the client

Returns:

ClientData for a specific client.