Enum Privilege

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      BACKEND_BACKUP
      The privilege that provides the ability to perform backend backup or backup purge operations.
      BACKEND_RESTORE
      The privilege that provides the ability to perform backend restore operations.
      BYPASS_ACL
      The privilege that provides the ability to bypass access control evaluation.
      BYPASS_LOCKDOWN
      The privilege that provides the ability to bypass server lockdown mode.
      CANCEL_REQUEST
      The privilege that provides the ability to cancel arbitrary client requests.
      CHANGELOG_READ
      The privilege that provides the ability to perform read operations on the changelog.
      CONFIG_READ
      The privilege that provides the ability to read the server configuration.
      CONFIG_WRITE
      The privilege that provides the ability to update the server configuration.
      DATA_SYNC
      The privilege that provides the ability to participate in a data synchronization environment.
      DISCONNECT_CLIENT
      The privilege that provides the ability to terminate arbitrary client connections.
      JMX_NOTIFY
      The privilege that provides the ability to subscribe to JMX notifications.
      JMX_READ
      The privilege that provides the ability to perform read operations via JMX.
      JMX_WRITE
      The privilege that provides the ability to perform write operations via JMX.
      LDIF_EXPORT
      The privilege that provides the ability to perform LDIF export operations.
      LDIF_IMPORT
      The privilege that provides the ability to perform LDIF import operations.
      MODIFY_ACL
      The privilege that provides the ability to modify access control rules.
      MONITOR_READ
      The privilege that provides the ability to read the server monitoring information.
      PASSWORD_RESET
      The privilege that provides the ability to reset user passwords.
      PRIVILEGE_CHANGE
      The privilege that provides the ability to change the set of privileges for a user, or to change the set of privileges automatically assigned to a root user.
      PROXIED_AUTH
      The privilege that provides the ability to perform proxied authorization or request an alternate authorization identity.
      SERVER_LOCKDOWN
      The privilege that provides the ability to lockdown a server.
      SERVER_RESTART
      The privilege that provides the ability to request a server restart.
      SERVER_SHUTDOWN
      The privilege that provides the ability to request a server shutdown.
      SUBENTRY_WRITE
      The privilege that provides the ability to perform write operations on LDAP subentries.
      UNINDEXED_SEARCH
      The privilege that provides the ability to perform an unindexed search in the JE backend.
      UPDATE_SCHEMA
      The privilege that provides the ability to update the server schema.
    • Enum Constant Detail

      • BYPASS_ACL

        public static final Privilege BYPASS_ACL
        The privilege that provides the ability to bypass access control evaluation.
      • BYPASS_LOCKDOWN

        public static final Privilege BYPASS_LOCKDOWN
        The privilege that provides the ability to bypass server lockdown mode.
      • MODIFY_ACL

        public static final Privilege MODIFY_ACL
        The privilege that provides the ability to modify access control rules.
      • CONFIG_READ

        public static final Privilege CONFIG_READ
        The privilege that provides the ability to read the server configuration.
      • CONFIG_WRITE

        public static final Privilege CONFIG_WRITE
        The privilege that provides the ability to update the server configuration.
      • JMX_READ

        public static final Privilege JMX_READ
        The privilege that provides the ability to perform read operations via JMX.
      • JMX_WRITE

        public static final Privilege JMX_WRITE
        The privilege that provides the ability to perform write operations via JMX.
      • JMX_NOTIFY

        public static final Privilege JMX_NOTIFY
        The privilege that provides the ability to subscribe to JMX notifications.
      • LDIF_IMPORT

        public static final Privilege LDIF_IMPORT
        The privilege that provides the ability to perform LDIF import operations.
      • LDIF_EXPORT

        public static final Privilege LDIF_EXPORT
        The privilege that provides the ability to perform LDIF export operations.
      • BACKEND_BACKUP

        public static final Privilege BACKEND_BACKUP
        The privilege that provides the ability to perform backend backup or backup purge operations.
      • BACKEND_RESTORE

        public static final Privilege BACKEND_RESTORE
        The privilege that provides the ability to perform backend restore operations.
      • SERVER_LOCKDOWN

        public static final Privilege SERVER_LOCKDOWN
        The privilege that provides the ability to lockdown a server.
      • SERVER_SHUTDOWN

        public static final Privilege SERVER_SHUTDOWN
        The privilege that provides the ability to request a server shutdown.
      • SERVER_RESTART

        public static final Privilege SERVER_RESTART
        The privilege that provides the ability to request a server restart.
      • PROXIED_AUTH

        public static final Privilege PROXIED_AUTH
        The privilege that provides the ability to perform proxied authorization or request an alternate authorization identity.
      • DISCONNECT_CLIENT

        public static final Privilege DISCONNECT_CLIENT
        The privilege that provides the ability to terminate arbitrary client connections.
      • CANCEL_REQUEST

        public static final Privilege CANCEL_REQUEST
        The privilege that provides the ability to cancel arbitrary client requests.
      • PASSWORD_RESET

        public static final Privilege PASSWORD_RESET
        The privilege that provides the ability to reset user passwords.
      • DATA_SYNC

        public static final Privilege DATA_SYNC
        The privilege that provides the ability to participate in a data synchronization environment.
      • UPDATE_SCHEMA

        public static final Privilege UPDATE_SCHEMA
        The privilege that provides the ability to update the server schema.
      • PRIVILEGE_CHANGE

        public static final Privilege PRIVILEGE_CHANGE
        The privilege that provides the ability to change the set of privileges for a user, or to change the set of privileges automatically assigned to a root user.
      • UNINDEXED_SEARCH

        public static final Privilege UNINDEXED_SEARCH
        The privilege that provides the ability to perform an unindexed search in the JE backend.
      • SUBENTRY_WRITE

        public static final Privilege SUBENTRY_WRITE
        The privilege that provides the ability to perform write operations on LDAP subentries.
      • CHANGELOG_READ

        public static final Privilege CHANGELOG_READ
        The privilege that provides the ability to perform read operations on the changelog.
      • MONITOR_READ

        public static final Privilege MONITOR_READ
        The privilege that provides the ability to read the server monitoring information.
    • Method Detail

      • values

        public static Privilege[] 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 (Privilege c : Privilege.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static Privilege 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
      • getName

        public String getName()
        Retrieves the name for this privilege.
        Returns:
        The name for this privilege.
      • privilegeForName

        public static Privilege privilegeForName​(String lowerPrivName)
        Retrieves the privilege with the specified name.
        Parameters:
        lowerPrivName - The name of the privilege to retrieve, formatted in all lowercase characters.
        Returns:
        The requested privilege, or null if the provided value is not the name of a valid privilege.
      • toString

        public String toString()
        Retrieves the human-readable name for this privilege.
        Overrides:
        toString in class Enum<Privilege>
        Returns:
        The human-readable name for this privilege.
      • getDefaultRootPrivileges

        public static Set<Privilege> getDefaultRootPrivileges()
        Retrieves the set of privileges that should be automatically granted to root users if the root privilege set is not specified in the configuration.
        Returns:
        The set of privileges that should be automatically granted to root users if the root privilege set is not specified in the configuration.