com.hivemq.spi.topic

Class MqttTopicPermission

java.lang.Object

com.hivemq.spi.topic.MqttTopicPermission

public class MqttTopicPermission
extends Object

A Permission which represents the concept of a topic which can be restricted in the following parts:

• Topic (name)
• Quality of Service
• Activity (Publish/Subscribe)

Since:

1.4

Author:

Christian Goetz, Dominik Obermaier, Christoph Schäbel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MqttTopicPermission.ACTIVITY Represents the allowed/denied activity on a topic
static class	MqttTopicPermission.QOS Represents the allowed/denied Quality of Service levels for a MqttTopicPermission
static class	MqttTopicPermission.RETAIN
static class	MqttTopicPermission.TYPE

Constructor Summary

Constructors

Constructor and Description
MqttTopicPermission(String topic, MqttTopicPermission.TYPE type) Creates a topic permission where publishing and subscribing on all QoS level is allowed on a given topic
MqttTopicPermission(String topic, MqttTopicPermission.TYPE type, MqttTopicPermission.ACTIVITY activity) Creates a topic where a given activity is allowed on all QoS levels on a given topic
MqttTopicPermission(String topic, MqttTopicPermission.TYPE type, MqttTopicPermission.QOS qos) Creates a topic where publishing and subscribing on a given QoS is allowed for a given topic
MqttTopicPermission(String topic, MqttTopicPermission.TYPE type, MqttTopicPermission.QOS qos, MqttTopicPermission.ACTIVITY activity) Creates a topic where a given activity is allowed on a given QoS for a given topic
MqttTopicPermission(String topic, MqttTopicPermission.TYPE type, MqttTopicPermission.QOS qos, MqttTopicPermission.ACTIVITY activity, MqttTopicPermission.RETAIN publishRetain) Creates a topic where a given activity is allowed on a given QoS for a given topic

Method Summary

Methods

Modifier and Type	Method and Description
MqttTopicPermission.ACTIVITY	getActivity()
MqttTopicPermission.RETAIN	getPublishRetain()
MqttTopicPermission.QOS	getQos()
String	getTopic()
MqttTopicPermission.TYPE	getType()
boolean	implies(MqttTopicPermission other) Checks the MqttTopicPermission implies a given MqttTopicPermission
boolean	implies(String topic, MqttTopicPermission.QOS qoS, MqttTopicPermission.ACTIVITY activity)
boolean	implies(String topic, QoS qoS, MqttTopicPermission.ACTIVITY activity) Checks the MqttTopicPermission implies a given topic, qos and activity combination
boolean	implies(String topic, QoS qoS, MqttTopicPermission.ACTIVITY activity, boolean retained) Checks the MqttTopicPermission implies a given topic, qos and activity combination
boolean	implies(String topic, QoS qoS, MqttTopicPermission.ACTIVITY activity, MqttTopicPermission.RETAIN RETAIN) Checks the MqttTopicPermission implies a given topic, qos and activity combination
boolean	implies(String topic, String[] splitTopic, MqttTopicPermission.QOS qoS, MqttTopicPermission.ACTIVITY activity) Checks the MqttTopicPermission implies a given topic, qos and activity combination
boolean	implies(String topic, String[] splitTopic, QoS qoS, MqttTopicPermission.ACTIVITY activity) Checks the MqttTopicPermission implies a given topic, qos and activity combination
boolean	implies(String topic, String[] splitTopic, QoS qoS, MqttTopicPermission.ACTIVITY activity, boolean retained) Checks the MqttTopicPermission implies a given topic, qos and activity combination
boolean	implies(String topic, String[] splitTopic, QoS qoS, MqttTopicPermission.ACTIVITY activity, MqttTopicPermission.RETAIN RETAIN) Checks the MqttTopicPermission implies a given topic, qos and activity combination

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MqttTopicPermission

public MqttTopicPermission(String topic,
                   MqttTopicPermission.TYPE type)

Creates a topic permission where publishing and subscribing on all QoS level is allowed on a given topic

Parameters:

topic - the topic

type - the type of this permission (allow / deny)

MqttTopicPermission

public MqttTopicPermission(String topic,
                   MqttTopicPermission.TYPE type,
                   MqttTopicPermission.ACTIVITY activity)

Creates a topic where a given activity is allowed on all QoS levels on a given topic

Parameters:

topic - the topic

type - the type of this permission (allow / deny)

activity - the activity

MqttTopicPermission

public MqttTopicPermission(String topic,
                   MqttTopicPermission.TYPE type,
                   MqttTopicPermission.QOS qos)

Creates a topic where publishing and subscribing on a given QoS is allowed for a given topic

Parameters:

topic - the topic

type - the type of this permission (allow / deny)

qos - the QoS level

MqttTopicPermission

public MqttTopicPermission(String topic,
                   MqttTopicPermission.TYPE type,
                   MqttTopicPermission.QOS qos,
                   MqttTopicPermission.ACTIVITY activity)

Creates a topic where a given activity is allowed on a given QoS for a given topic

Parameters:

topic - the topic

type - the type of this permission (allow / deny)

qos - the QoS

activity - the activity

MqttTopicPermission

public MqttTopicPermission(String topic,
                   MqttTopicPermission.TYPE type,
                   MqttTopicPermission.QOS qos,
                   MqttTopicPermission.ACTIVITY activity,
                   MqttTopicPermission.RETAIN publishRetain)

Creates a topic where a given activity is allowed on a given QoS for a given topic

Parameters:

topic - the topic

type - the type of this permission (allow / deny)

qos - the QoS

activity - the activity

publishRetain - if the client is allowed/denied to publish retained messages to this topic

Method Detail

implies

public boolean implies(MqttTopicPermission other)

Checks the MqttTopicPermission implies a given MqttTopicPermission

Parameters:

other - the MqttTopicPermission which should be checked if it is implied by the current MqttTopicPermission

Returns:

true if the given MqttTopicPermission is implied

implies

public boolean implies(String topic,
              String[] splitTopic,
              QoS qoS,
              MqttTopicPermission.ACTIVITY activity,
              boolean retained)

Checks the MqttTopicPermission implies a given topic, qos and activity combination

Parameters:

topic - the topic to check

qoS - the QoS to check

activity - the activity to check

Returns:

true if the given topic, qos and activity combination is implied

implies

public boolean implies(String topic,
              QoS qoS,
              MqttTopicPermission.ACTIVITY activity,
              boolean retained)

Checks the MqttTopicPermission implies a given topic, qos and activity combination

Parameters:

topic - the topic to check

qoS - the QoS to check

activity - the activity to check

Returns:

true if the given topic, qos and activity combination is implied

implies

public boolean implies(String topic,
              String[] splitTopic,
              QoS qoS,
              MqttTopicPermission.ACTIVITY activity,
              MqttTopicPermission.RETAIN RETAIN)

Checks the MqttTopicPermission implies a given topic, qos and activity combination

Parameters:

topic - the topic to check

qoS - the QoS to check

activity - the activity to check

Returns:

true if the given topic, qos and activity combination is implied

implies

public boolean implies(String topic,
              QoS qoS,
              MqttTopicPermission.ACTIVITY activity,
              MqttTopicPermission.RETAIN RETAIN)

Checks the MqttTopicPermission implies a given topic, qos and activity combination

Parameters:

topic - the topic to check

qoS - the QoS to check

activity - the activity to check

Returns:

true if the given topic, qos and activity combination is implied

implies

public boolean implies(String topic,
              String[] splitTopic,
              QoS qoS,
              MqttTopicPermission.ACTIVITY activity)

Checks the MqttTopicPermission implies a given topic, qos and activity combination

Parameters:

topic - the topic to check

qoS - the QoS to check

activity - the activity to check

Returns:

true if the given topic, qos and activity combination is implied

implies

public boolean implies(String topic,
              QoS qoS,
              MqttTopicPermission.ACTIVITY activity)

Checks the MqttTopicPermission implies a given topic, qos and activity combination

Parameters:

topic - the topic to check

qoS - the QoS to check

activity - the activity to check

Returns:

true if the given topic, qos and activity combination is implied

implies

public boolean implies(String topic,
              String[] splitTopic,
              MqttTopicPermission.QOS qoS,
              MqttTopicPermission.ACTIVITY activity)

Checks the MqttTopicPermission implies a given topic, qos and activity combination

Parameters:

topic - the topic to check

qoS - the QoS to check

activity - the activity to check

Returns:

true if the given topic, qos and activity combination is implied

implies

public boolean implies(String topic,
              MqttTopicPermission.QOS qoS,
              MqttTopicPermission.ACTIVITY activity)

getTopic

public String getTopic()

getType

public MqttTopicPermission.TYPE getType()

getQos

public MqttTopicPermission.QOS getQos()

getActivity

public MqttTopicPermission.ACTIVITY getActivity()

getPublishRetain

public MqttTopicPermission.RETAIN getPublishRetain()