com.hivemq.spi.services

Interface RetainedMessageStore

Deprecated.

Use BlockingRetainedMessageStore or AsyncRetainedMessageStore instead.

@Deprecated
public interface RetainedMessageStore

The retained message store allows the management of retained messages from within plugins

Since:

1.5

Author:

Lukas Brandl

Method Summary

Methods

Modifier and Type	Method and Description
void	addOrReplace(RetainedMessage retainedMessage) Deprecated. Use BlockingRetainedMessageStore or AsyncRetainedMessageStore instead.
void	clear() Deprecated. Use BlockingRetainedMessageStore or AsyncRetainedMessageStore instead.
boolean	contains(RetainedMessage retainedMessage) Deprecated. Use BlockingRetainedMessageStore or AsyncRetainedMessageStore instead.
com.google.common.base.Optional<RetainedMessage>	getRetainedMessage(String topic) Deprecated. Use RetainedMessageStoreLocal or RetainedMessageStoreCluster instead.
Set<RetainedMessage>	getRetainedMessages() Deprecated.
void	remove(RetainedMessage retainedMessage) Deprecated. Use BlockingRetainedMessageStore or AsyncRetainedMessageStore instead.
void	remove(String topic) Deprecated. Use BlockingRetainedMessageStore or AsyncRetainedMessageStore instead.
int	size() Deprecated. Use BlockingRetainedMessageStore or AsyncRetainedMessageStore instead.

Method Detail

getRetainedMessages

@Deprecated
Set<RetainedMessage> getRetainedMessages()

Deprecated.

Returns:

all retained messages which are currently stored

getRetainedMessage

@Deprecated
com.google.common.base.Optional<RetainedMessage> getRetainedMessage(String topic)

Deprecated. Use RetainedMessageStoreLocal or RetainedMessageStoreCluster instead.

Parameters:

topic - a topic

Returns:

retained message for the specific topic, otherwise an Optional instance with an empty reference

remove

@Deprecated
void remove(String topic)

Deprecated. Use BlockingRetainedMessageStore or AsyncRetainedMessageStore instead.

Removes the retained message from given topic. null values are ignored. If there isn't any retained message on the topic yet, nothing will happen.

Parameters:

topic - from which the message should be removed

remove

@Deprecated
void remove(RetainedMessage retainedMessage)

Deprecated. Use BlockingRetainedMessageStore or AsyncRetainedMessageStore instead.

Removes a given retained message. null values are ignored. If the given retained message doesn't exist, nothing will happen.

Parameters:

retainedMessage - which should be removed

clear

@Deprecated
void clear()

Deprecated. Use BlockingRetainedMessageStore or AsyncRetainedMessageStore instead.

Removes all retained messages from the message store.

addOrReplace

@Deprecated
void addOrReplace(RetainedMessage retainedMessage)

Deprecated. Use BlockingRetainedMessageStore or AsyncRetainedMessageStore instead.

This method adds or replaces a retained message

Parameters:

retainedMessage - which should be added or replaced

contains

@Deprecated
boolean contains(RetainedMessage retainedMessage)

Deprecated. Use BlockingRetainedMessageStore or AsyncRetainedMessageStore instead.

Checks if the retained message is present in the retained message store. Only the topic is of a retained message is considered for this check, QoS and message are ignored.

Parameters:

retainedMessage - to check if it's already in the message store

Returns:

true if there's already a message on the topic of the given retained message

size

@Deprecated
int size()

Deprecated. Use BlockingRetainedMessageStore or AsyncRetainedMessageStore instead.

Returns:

the number of all retained messages