AsyncRetainedMessageStore (HiveMQ SPI 3.4.2 API)

```
public interface AsyncRetainedMessageStore
```
The retained message store allows the management of retained messages from within plugins

Author:

Lukas Brandl

Method Summary

Methods
Modifier and Type	Method and Description
`com.google.common.util.concurrent.ListenableFuture<Void>`	`addOrReplace(RetainedMessage retainedMessage)` This method adds or replaces a retained message
`com.google.common.util.concurrent.ListenableFuture<Void>`	`clear()` Removes all retained messages from the message store.
`com.google.common.util.concurrent.ListenableFuture<Boolean>`	`contains(String topic)` Checks if a retained message is present in the retained message store.
`com.google.common.util.concurrent.ListenableFuture<Boolean>`	`containsLocally(String topic)` Checks if a retained message is present in the retained message store, on this HiveMQ instance.
`com.google.common.util.concurrent.ListenableFuture<Set<RetainedMessage>>`	`getLocalRetainedMessages()`
`com.google.common.util.concurrent.ListenableFuture<RetainedMessage>`	`getRetainedMessage(String topic)`
`com.google.common.util.concurrent.ListenableFuture<Set<RetainedMessage>>`	`getRetainedMessages()`
`com.google.common.util.concurrent.ListenableFuture<Long>`	`localSize()`
`com.google.common.util.concurrent.ListenableFuture<Void>`	`remove(String topic)` Removes the retained message from given topic.
`com.google.common.util.concurrent.ListenableFuture<Long>`	`size()`

- Method Detail
  - getLocalRetainedMessages
```
com.google.common.util.concurrent.ListenableFuture<Set<RetainedMessage>> getLocalRetainedMessages()
```
    Returns:
    a ListenableFuture which contains all retained messages which are currently stored on this HiveMQ instance.
  - localSize
```
com.google.common.util.concurrent.ListenableFuture<Long> localSize()
```
    Returns:
    a ListenableFuture which contains the number of all retained messages on this HiveMQ instance. failing with a RateLimitExceededException if the plugin service rate limit was exceeded.
  - containsLocally
```
com.google.common.util.concurrent.ListenableFuture<Boolean> containsLocally(String topic)
```
    Checks if a retained message is present in the retained message store, on this HiveMQ instance.
    
    Parameters:
    topic - the topic associated with the retained message
    
    Returns:
    a ListenableFuture which contains true if there's a message for the given topic failing with a RateLimitExceededException if the plugin service rate limit was exceeded.
  - getRetainedMessages
```
com.google.common.util.concurrent.ListenableFuture<Set<RetainedMessage>> getRetainedMessages()
```
    Returns:
    a ListenableFuture which contains all retained messages which are currently stored failing with a RateLimitExceededException if the plugin service rate limit was exceeded.
  - getRetainedMessage
```
com.google.common.util.concurrent.ListenableFuture<RetainedMessage> getRetainedMessage(String topic)
```
    Parameters:
    topic - a topic
    
    Returns:
    a ListenableFuture which contains the retained message for the specific topic or null. failing with a RateLimitExceededException if the plugin service rate limit was exceeded.
  - remove
```
com.google.common.util.concurrent.ListenableFuture<Void> remove(String topic)
```
    Removes the retained message from given topic. If there isn't any retained message on the topic yet, nothing will happen.
    
    Parameters:
    topic - from which the message should be removed
    
    Returns:
    a ListenableFuture which returns after removal failing with a RateLimitExceededException if the plugin service rate limit was exceeded.
  - clear
```
com.google.common.util.concurrent.ListenableFuture<Void> clear()
```
    Removes all retained messages from the message store.
    
    Returns:
    a ListenableFuture which returns after removal failing with a RateLimitExceededException if the plugin service rate limit was exceeded.
  - addOrReplace
```
com.google.common.util.concurrent.ListenableFuture<Void> addOrReplace(RetainedMessage retainedMessage)
```
    This method adds or replaces a retained message
    
    Parameters:
    retainedMessage - which should be added or replaced
    
    Returns:
    a ListenableFuture which returns after adding or replacing failing with a RateLimitExceededException if the plugin service rate limit was exceeded.
  - contains
```
com.google.common.util.concurrent.ListenableFuture<Boolean> contains(String topic)
```
    Checks if a retained message is present in the retained message store.
    
    Parameters:
    topic - the topic associated with the retained message
    
    Returns:
    a ListenableFuture which contains true if there's a message for the given topic failing with a RateLimitExceededException if the plugin service rate limit was exceeded.
  - size
```
com.google.common.util.concurrent.ListenableFuture<Long> size()
```
    Returns:
    a ListenableFuture which contains the number of all retained messages failing with a RateLimitExceededException if the plugin service rate limit was exceeded.

Interface AsyncRetainedMessageStore

Method Summary

Method Detail

getLocalRetainedMessages

localSize

containsLocally

getRetainedMessages

getRetainedMessage

remove

clear

addOrReplace

contains

size