com.pushtechnology.diffusion.client.types

Enum GlobalPermission

java.lang.Object

java.lang.Enum<GlobalPermission>

com.pushtechnology.diffusion.client.types.GlobalPermission

All Implemented Interfaces:

Permission, Serializable, Comparable<GlobalPermission>

public enum GlobalPermission
extends Enum<GlobalPermission>
implements Permission

Permissions that protect globally scoped, access-controlled operations. There is no related object, permission is granted globally.

Since:

5.2

Author:

DiffusionData Limited

See Also:

PathPermission

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTHENTICATE Add an authentication handler.
CONTROL_SERVER Change the server's runtime state - for example, shut it down.
MODIFY_SECURITY Change the security configuration.
MODIFY_SESSION Alter a client session.
MODIFY_TOPIC_VIEWS Modify topic views.
READ_TOPIC_VIEWS Read topic views.
REGISTER_HANDLER Required to register any server-side handler.
UNKNOWN_GLOBAL_PERMISSION A permission that is unsupported by the session.
VIEW_SECURITY Read the security configuration.
VIEW_SERVER View the server's runtime state - for example, read metrics.
VIEW_SESSION List or listen to client sessions.

Method Summary

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

AUTHENTICATE

public static final GlobalPermission AUTHENTICATE

Add an authentication handler.

VIEW_SESSION

public static final GlobalPermission VIEW_SESSION

List or listen to client sessions.

MODIFY_SESSION

public static final GlobalPermission MODIFY_SESSION

Alter a client session. This covers a range of actions including:

• subscribe session to topic
• enable conflation for session
• close session

REGISTER_HANDLER

public static final GlobalPermission REGISTER_HANDLER

Required to register any server-side handler.

This restricts clients from consuming resources by registering long lived handlers (or example, addMessageHandler). Typically these would never be called due to lack of other permissions.

VIEW_SERVER

public static final GlobalPermission VIEW_SERVER

View the server's runtime state - for example, read metrics.

CONTROL_SERVER

public static final GlobalPermission CONTROL_SERVER

Change the server's runtime state - for example, shut it down.

VIEW_SECURITY

public static final GlobalPermission VIEW_SECURITY

Read the security configuration.

MODIFY_SECURITY

public static final GlobalPermission MODIFY_SECURITY

Change the security configuration.

UNKNOWN_GLOBAL_PERMISSION

public static final GlobalPermission UNKNOWN_GLOBAL_PERMISSION

A permission that is unsupported by the session.

Since:

6.1

READ_TOPIC_VIEWS

public static final GlobalPermission READ_TOPIC_VIEWS

Read topic views.

Since:

6.3

MODIFY_TOPIC_VIEWS

public static final GlobalPermission MODIFY_TOPIC_VIEWS

Modify topic views.

Since:

6.3

Method Detail

values

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

Returns:

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

valueOf

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