Package com.pushtechnology.diffusion.client.types

Enum Class GlobalPermission

java.lang.Object
java.lang.Enum<GlobalPermission>
com.pushtechnology.diffusion.client.types.GlobalPermission
All Implemented Interfaces:
Permission, Serializable, Comparable<GlobalPermission>, Constable
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:

  • Enum Constant Details

    • 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 Details

    • values

      public static GlobalPermission[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static GlobalPermission valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null