com.hivemq.spi.security

Enum RestrictionType

java.lang.Object

java.lang.Enum<RestrictionType>

com.hivemq.spi.security.RestrictionType

All Implemented Interfaces:

Serializable, Comparable<RestrictionType>

public enum RestrictionType
extends Enum<RestrictionType>

The different types of restrictions which are available.

Since:

1.4

Author:

Dominik Obermaier, Georg Held, Lukas Brandl, Florian Limpöck

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLIENT_SESSION_TTL The time to live of the session of this client.
DISCARD_STRATEGY The strategy to apply when messages are dropped because the maximum size of the offline queue is exceeded.
INFLIGHT_QUEUE_SIZE The maximum size of the inflight message queue for this client.
MAX_INCOMING_BYTES The throttling for receiving messages from the client.
MAX_OUTGOING_BYTES_SEC The throttling for sending messages out to the client.
MAX_PUBLISH_MESSAGE_SIZE The maximum size of a message the user can send.
MAX_QUEUED_MESSAGES The maximum size of the offline message queue for this client.
WRITE_BUFFER_HIGH_THRESHOLD The high fill state of the write buffer for this client, measured in bytes.
WRITE_BUFFER_LOW_THRESHOLD The low fill state of the write buffer for this client, measured in bytes.

Method Summary

Methods

Modifier and Type	Method and Description
static RestrictionType	valueOf(String name) Returns the enum constant of this type with the specified name.
static RestrictionType[]	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

MAX_PUBLISH_MESSAGE_SIZE

public static final RestrictionType MAX_PUBLISH_MESSAGE_SIZE

The maximum size of a message the user can send.

MAX_OUTGOING_BYTES_SEC

public static final RestrictionType MAX_OUTGOING_BYTES_SEC

The throttling for sending messages out to the client. This is broker -> client

MAX_INCOMING_BYTES

public static final RestrictionType MAX_INCOMING_BYTES

The throttling for receiving messages from the client. This is client -> broker

WRITE_BUFFER_HIGH_THRESHOLD

public static final RestrictionType WRITE_BUFFER_HIGH_THRESHOLD

The high fill state of the write buffer for this client, measured in bytes. If this state is reached HiveMQ will prevent additional buffering of writes. QoS 0 messages may be dropped. If this restriction is set WRITE_BUFFER_LOW_THRESHOLD must be set as well and the Restriction value for this must be equal or greater than the value for WRITE_BUFFER_LOW_THRESHOLD.

Since:

3.3

WRITE_BUFFER_LOW_THRESHOLD

public static final RestrictionType WRITE_BUFFER_LOW_THRESHOLD

The low fill state of the write buffer for this client, measured in bytes. If the write buffer previously exceeded the WRITE_BUFFER_HIGH_THRESHOLD, buffering of writes will resume once it drops below this. If this restriction is set WRITE_BUFFER_HIGH_THRESHOLD must be set as well and the Restriction value for this must be greater than zero.

Since:

3.3

MAX_QUEUED_MESSAGES

public static final RestrictionType MAX_QUEUED_MESSAGES

The maximum size of the offline message queue for this client. This only takes effect for clients with clean-session set to false

Since:

3.3

DISCARD_STRATEGY

public static final RestrictionType DISCARD_STRATEGY

The strategy to apply when messages are dropped because the maximum size of the offline queue is exceeded. You can use the constants from QueuedMessageStrategy as values.

Since:

3.3

CLIENT_SESSION_TTL

public static final RestrictionType CLIENT_SESSION_TTL

The time to live of the session of this client.

A value of 0 for the TTL means that the session is immediately invalidated after the client disconnects. A value of -1 for the TTL means that session expiry is disabled.

Since:

3.4

INFLIGHT_QUEUE_SIZE

public static final RestrictionType INFLIGHT_QUEUE_SIZE

The maximum size of the inflight message queue for this client. This only takes effect for online clients.

Since:

3.4

Method Detail

values

public static RestrictionType[] 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 (RestrictionType c : RestrictionType.values())
    System.out.println(c);

Returns:

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

valueOf

public static RestrictionType 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