com.hivemq.spi.services

Interface BlockingRetainedMessageStore

public interface BlockingRetainedMessageStore

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
void	addOrReplace(RetainedMessage retainedMessage) This method adds or replaces a retained message
void	clear() Removes all retained messages from the message store.
boolean	contains(String topic) Checks if a retained message is present in the retained message store.
boolean	containsLocally(String topic) Checks if a retained message is present in the retained message store, on this HiveMQ instance.
Set<RetainedMessage>	getLocalRetainedMessages()
RetainedMessage	getRetainedMessage(String topic)
Set<RetainedMessage>	getRetainedMessages()
Long	localSize()
void	remove(String topic) Removes the retained message from given topic.
long	size()

Method Detail

getLocalRetainedMessages

Set<RetainedMessage> getLocalRetainedMessages()

Returns:

all retained messages which are currently stored on this HiveMQ instance.

localSize

Long localSize()

Returns:

the number of all retained messages on this HiveMQ instance.

containsLocally

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:

true if there's a message for the given topic

Throws:

RateLimitExceededException - if the plugin service rate limit was exceeded.

getRetainedMessages

Set<RetainedMessage> getRetainedMessages()

Returns:

all retained messages which are currently stored

Throws:

RateLimitExceededException - if the plugin service rate limit was exceeded.

getRetainedMessage

@Nullable
RetainedMessage getRetainedMessage(String topic)

Parameters:

topic - a topic

Returns:

retained message for the specific topic or null. instance with an empty reference

Throws:

RateLimitExceededException - if the plugin service rate limit was exceeded.

remove

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

Throws:

RateLimitExceededException - if the plugin service rate limit was exceeded.

clear

void clear()

Removes all retained messages from the message store.

addOrReplace

void addOrReplace(RetainedMessage retainedMessage)

This method adds or replaces a retained message

Parameters:

retainedMessage - which should be added or replaced

Throws:

RateLimitExceededException - if the plugin service rate limit was exceeded.

contains

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:

true if there's a message for the given topic

Throws:

RateLimitExceededException - if the plugin service rate limit was exceeded.

size

long size()

Returns:

the number of all retained messages

Throws:

RateLimitExceededException - if the plugin service rate limit was exceeded.