Package com.hivemq.extension.sdk.api.packets.auth

Enum DefaultAuthorizationBehaviour

java.lang.Object

java.lang.Enum<DefaultAuthorizationBehaviour>

com.hivemq.extension.sdk.api.packets.auth.DefaultAuthorizationBehaviour

All Implemented Interfaces:

Serializable, Comparable<DefaultAuthorizationBehaviour>

public enum DefaultAuthorizationBehaviour
extends Enum<DefaultAuthorizationBehaviour>

Default behaviour when no Authorizer or TopicPermission matched for the PUBLISH/SUBSCRIBE.

Since:

4.0.0, CE 2019.1

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALLOW	When ALLOW is set and none of the default permission matches to a PUBLISH topic or topic filter in a Subscription, then the client is allowed to PUBLISH or SUBSCRIBE.
DENY	When DENY is set and none of the default permission matches to a PUBLISH topic or topic filter in a Subscription, then the client is not allowed to PUBLISH or SUBSCRIBE.

Method Summary

Modifier and Type	Method	Description
static DefaultAuthorizationBehaviour	valueOf(String name)	Returns the enum constant of this type with the specified name.
static DefaultAuthorizationBehaviour[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DENY

public static final DefaultAuthorizationBehaviour DENY

When DENY is set and none of the default permission matches to a PUBLISH topic or topic filter in a Subscription, then the client is not allowed to PUBLISH or SUBSCRIBE.

Since:

4.0.0, CE 2019.1

ALLOW

public static final DefaultAuthorizationBehaviour ALLOW

When ALLOW is set and none of the default permission matches to a PUBLISH topic or topic filter in a Subscription, then the client is allowed to PUBLISH or SUBSCRIBE.

Since:

4.0.0, CE 2019.1

Method Detail

values

public static DefaultAuthorizationBehaviour[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DefaultAuthorizationBehaviour c : DefaultAuthorizationBehaviour.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DefaultAuthorizationBehaviour valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null