com.hivemq.spi.services

Interface BlockingSessionAttributeStore

public interface BlockingSessionAttributeStore

Through this service a plugin can manage client session attributes with the same lifetime as the MQTT client session.

The session attribute store is only available for clients which already have a session available. When a client connects, the earliest point in time to use the session attribute store for the client is the OnSessionReadyCallback.

The session attribute store is only available when all nodes in the HiveMQ cluster are at version 3.3.0 or above.

Since:

3.3.0

Author:

Georg Held

Method Summary

Methods

Modifier and Type	Method and Description
void	clear(String clientId) Clears all session attributes for the connected client.
com.google.common.base.Optional<byte[]>	get(String clientId, String key) Retrieves the value of the session attribute with the given key for a persistent client.
com.google.common.base.Optional<com.google.common.collect.ImmutableMap<String,byte[]>>	getAll(String clientId) Retrieves all session attributes for a persistent client.
com.google.common.base.Optional<String>	getAsString(String clientId, String key) Retrieves the value of the session attribute with the given key for a persistent client.
com.google.common.base.Optional<String>	getAsString(String clientId, String key, Charset charset) Retrieves the value of the session attribute with the given key for a persistent client.
void	put(String clientId, String key, byte[] value) Sets the given session attribute for a persistent client.
void	putAsString(String clientId, String key, String value) Sets the given session attribute for a persistent client.
void	putAsString(String clientId, String key, String value, Charset charset) Sets the given session attribute for a persistent client.
OptionalAttribute	putIfNewer(String clientId, String key, byte[] value, long timestamp) Sets the given session attribute for a persistent client if the timestamp of the attribute is newer than the timestamp of the already stored attribute.
OptionalAttribute	putIfNewerOrEquals(String clientId, String key, byte[] value, long timestamp) Sets the given session attribute for a persistent client if the timestamp of the attribute is newer than or equal to the timestamp of the already stored attribute.
com.google.common.base.Optional<byte[]>	remove(String clientId, String key) Removes the session attribute with the given key for a persistent client.

Method Detail

put

void put(@NotNull
       String clientId,
       @NotNull
       String key,
       @NotNull
       byte[] value)
         throws NoSuchClientIdException

Sets the given session attribute for a persistent client.

Parameters:

clientId - the clientId of a persistent client.

key - the key of the session attribute.

value - the value of the session attribute.

Throws:

NoSuchClientIdException - if no session for the given clientId 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.

putIfNewer

@NotNull
OptionalAttribute putIfNewer(@NotNull
                                   String clientId,
                                   @NotNull
                                   String key,
                                   @NotNull
                                   byte[] value,
                                   long timestamp)
                             throws NoSuchClientIdException

Sets the given session attribute for a persistent client if the timestamp of the attribute is newer than the timestamp of the already stored attribute.

Parameters:

clientId - the clientId of a persistent client.

key - the key of the session attribute.

value - the value of the session attribute.

timestamp - the timestamp of the session attribute.

Returns:

OptionalAttribute with the previous associated value or null and a boolean if a value was replaced or not. failing with a NoSuchClientIdException if no session for the given clientId exists, failing with a IncompatibleHiveMQVersionException if a node with a version lower than 3.4.0 exists in the cluster. failing with a RateLimitExceededException if the plugin service rate limit was exceeded.

Throws:

NoSuchClientIdException

putIfNewerOrEquals

@NotNull
OptionalAttribute putIfNewerOrEquals(@NotNull
                                           String clientId,
                                           @NotNull
                                           String key,
                                           @NotNull
                                           byte[] value,
                                           long timestamp)
                                     throws NoSuchClientIdException

Sets the given session attribute for a persistent client if the timestamp of the attribute is newer than or equal to the timestamp of the already stored attribute.

Parameters:

clientId - the clientId of a persistent client.

key - the key of the session attribute.

value - the value of the session attribute.

timestamp - the timestamp of the session attribute.

Returns:

OptionalAttribute with the previous associated value or null and a boolean if a value was replaced or not. failing with a NoSuchClientIdException if no session for the given clientId exists, failing with a IncompatibleHiveMQVersionException if a node with a version lower than 3.4.0 exists in the cluster. failing with a RateLimitExceededException if the plugin service rate limit was exceeded.

Throws:

NoSuchClientIdException

putAsString

void putAsString(@NotNull
               String clientId,
               @NotNull
               String key,
               @NotNull
               String value)
                 throws NoSuchClientIdException

Sets the given session attribute for a persistent client.

Parameters:

clientId - the clientId of a persistent client.

key - the key of the session attribute.

value - the value of the session attribute as a string.

Throws:

NoSuchClientIdException - if no session for the given clientId 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.

putAsString

void putAsString(@NotNull
               String clientId,
               @NotNull
               String key,
               @NotNull
               String value,
               @NotNull
               Charset charset)
                 throws NoSuchClientIdException

Sets the given session attribute for a persistent client.

Parameters:

clientId - the clientId of a persistent client.

key - the key of the session attribute.

value - the value of the session attribute as a string.

charset - the Charset of the given value.

Throws:

NoSuchClientIdException - if no session for the given clientId 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.

get

@NotNull
com.google.common.base.Optional<byte[]> get(@NotNull
                                                  String clientId,
                                                  @NotNull
                                                  String key)
                                            throws NoSuchClientIdException

Retrieves the value of the session attribute with the given key for a persistent client.

Parameters:

clientId - the clientId of a persistent client.

key - the key of the session attribute.

Returns:

an Optional containing the value of the session attribute if present.

Throws:

NoSuchClientIdException - if no session for the given clientId 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.

getAsString

@NotNull
com.google.common.base.Optional<String> getAsString(@NotNull
                                                          String clientId,
                                                          @NotNull
                                                          String key)
                                                    throws NoSuchClientIdException

Retrieves the value of the session attribute with the given key for a persistent client.

Parameters:

clientId - the clientId of a persistent client.

key - the key of the session attribute.

Returns:

an Optional containing the value of the session attribute if present.

Throws:

NoSuchClientIdException - if no session for the given clientId 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.

getAsString

@NotNull
com.google.common.base.Optional<String> getAsString(@NotNull
                                                          String clientId,
                                                          @NotNull
                                                          String key,
                                                          @NotNull
                                                          Charset charset)
                                                    throws NoSuchClientIdException

Retrieves the value of the session attribute with the given key for a persistent client.

Parameters:

clientId - the clientId of a persistent client.

key - the key of the session attribute.

charset - the Charset of the given value.

Returns:

an Optional containing the value of the session attribute if present.

Throws:

NoSuchClientIdException - if no session for the given clientId 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.

remove

@NotNull
com.google.common.base.Optional<byte[]> remove(@NotNull
                                                     String clientId,
                                                     @NotNull
                                                     String key)
                                               throws NoSuchClientIdException

Removes the session attribute with the given key for a persistent client.

Parameters:

clientId - the clientId of a persistent client.

key - the key of the session attribute.

Returns:

an Optional containing the value of the removed session attribute if it was present.

Throws:

NoSuchClientIdException - if no session for the given clientId 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.

getAll

@NotNull
com.google.common.base.Optional<com.google.common.collect.ImmutableMap<String,byte[]>> getAll(@NotNull
                                                                                                    String clientId)
                                                                                              throws NoSuchClientIdException

Retrieves all session attributes for a persistent client.

Parameters:

clientId - the clientId of a persistent client.

Returns:

a Future of an Optional containing all session attributes as a map of key and value pairs if present.

Throws:

NoSuchClientIdException - if no session for the given clientId 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.

clear

void clear(@NotNull
         String clientId)
           throws NoSuchClientIdException

Clears all session attributes for the connected client.

Parameters:

clientId - the clientId of a persistent client.

Throws:

NoSuchClientIdException - if no session for the given clientId 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.