com.hivemq.spi.services

Interface SYSTopicService

public interface SYSTopicService

This Service allows plugin developers to

* Add custom $SYS topics at runtime
* Remove existing $SYS topics at runtime
* Query for existing $SYS topics at runtime

Since:

2.0

Author:

Dominik Obermaier, Christoph Schäbel

Method Summary

Methods

Modifier and Type	Method and Description
void	addEntry(SYSTopicEntry entry) Adds a new $SYS topic entry.
boolean	contains(SYSTopicEntry entry) Checks if the SYSTopicService contains a given SYSTopicEntry.
Collection<SYSTopicEntry>	getAllEntries(Type... types) Returns a Collection of all SYSTopicEntrys topics available.
com.google.common.base.Optional<SYSTopicEntry>	getEntry(String topic) Returns the SYSTopicEntry for a given topic.
boolean	removeEntry(SYSTopicEntry entry) Removes a SYSTopicEntry
void	triggerStandardSysTopicPublish() Triggers a PUBLISH of all registered SYSTopicEntries with Type STANDARD to all clients which are subscribed to the SYSTopics
void	triggerStandardSysTopicPublishToClient(String clientId) Triggers a PUBLISH of all registered SYSTopicEntries with Type STANDARD to a specified client.
void	triggerStaticSysTopicPublishToClient(String clientId) Triggers a PUBLISH of all registered SYSTopicEntries with Type STATIC to a specified client.

Method Detail

getAllEntries

Collection<SYSTopicEntry> getAllEntries(Type... types)

Returns a Collection of all SYSTopicEntrys topics available. It is possible to filter the returned list by Type. By default, this method will return all SYSTopicEntrys.

Parameters:

types - the Types to filter

Returns:

a Collection of all $SYS topics registered to HiveMQ of the given Types

contains

boolean contains(SYSTopicEntry entry)

Checks if the SYSTopicService contains a given SYSTopicEntry.

Parameters:

entry - the SYSTopicEntry to check

Returns:

true if the Service contains the given SYSTopicEntry, false otherwise

getEntry

com.google.common.base.Optional<SYSTopicEntry> getEntry(String topic)

Returns the SYSTopicEntry for a given topic.

Parameters:

topic - the topic

Returns:

an Optional of a SYSTopicEntry

addEntry

void addEntry(SYSTopicEntry entry)

Adds a new $SYS topic entry. The topic of the given SYSTopicEntry must start with '$SYS'.

Parameters:

entry - a new SYSTopicEntry to add

removeEntry

boolean removeEntry(SYSTopicEntry entry)

Removes a SYSTopicEntry

Parameters:

entry - the entry to remove

Returns:

true if the SYSTopicEntry could be removed, false otherwise

triggerStandardSysTopicPublish

void triggerStandardSysTopicPublish()

Triggers a PUBLISH of all registered SYSTopicEntries with Type STANDARD to all clients which are subscribed to the SYSTopics

Since:

3.0

triggerStaticSysTopicPublishToClient

void triggerStaticSysTopicPublishToClient(String clientId)

Triggers a PUBLISH of all registered SYSTopicEntries with Type STATIC to a specified client. The client receives all messages from topics it is subscribed on.

Parameters:

clientId - The clientid for which to trigger the publishes

Since:

3.0

triggerStandardSysTopicPublishToClient

void triggerStandardSysTopicPublishToClient(String clientId)

Triggers a PUBLISH of all registered SYSTopicEntries with Type STANDARD to a specified client. The client receives all messages from topics it is subscribed on.

Parameters:

clientId - The clientid for which to trigger the publishes

Since:

3.0