com.hivemq.spi.topic.sys

Interface SYSTopicEntry

public interface SYSTopicEntry

An implementation of this interface representa a concrete $SYS topic entry which can be added to the SYSTopicService.

Since:

2.0

Author:

Dominik Obermaier

Method Summary

Methods

Modifier and Type	Method and Description
String	description() Returns a description of this $SYS topic
com.google.common.base.Supplier<byte[]>	payload() Returns a Supplier for the payload of this $SYS topic.
String	topic() Returns the topic of the $SYS Topic Entry.
Type	type() Returns the Type of this $SYS topic

Method Detail

topic

String topic()

Returns the topic of the $SYS Topic Entry.

Must start with '$SYS/'

Returns:

the topic of the entry

payload

com.google.common.base.Supplier<byte[]> payload()

Returns a Supplier for the payload of this $SYS topic. The supplier will be called every time the broker publishes on the $SYS topics.

If the payload is static or if you need to cache, you can consider using the utility methods in the Suppliers util class.

Returns:

a supplier for the payload of this $SYS topic

type

Type type()

Returns the Type of this $SYS topic

Returns:

the Type of this $SYS topics

description

String description()

Returns a description of this $SYS topic

Returns:

a textual description of this $SYS topic