Package com.unboundid.ldap.sdk.unboundidds.tasks

Enum CollectSupportDataSecurityLevel

java.lang.Object
java.lang.Enum<CollectSupportDataSecurityLevel>
com.unboundid.ldap.sdk.unboundidds.tasks.CollectSupportDataSecurityLevel
All Implemented Interfaces:
Serializable, Comparable<CollectSupportDataSecurityLevel>, java.lang.constant.Constable
@ThreadSafety(level=COMPLETELY_THREADSAFE) public enum CollectSupportDataSecurityLevel extends Enum<CollectSupportDataSecurityLevel>
This enum defines the security level values that may be used in conjunction with the collect-support-data tool (and the corresponding administrative task and extended operation).
NOTE: This class, and other classes within the com.unboundid.ldap.sdk.unboundidds package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.

  • Enum Constant Details

    • NONE

      public static final CollectSupportDataSecurityLevel NONE
      The security level that indicates that no data should be obscured or redacted.

    • OBSCURE_SECRETS

      public static final CollectSupportDataSecurityLevel OBSCURE_SECRETS
      The security level that indicates that secret information (like the values of sensitive configuration properties) should be obscured, and that logs containing user data (like the data recovery log) will be excluded from the support data archive.

    • MAXIMUM

      public static final CollectSupportDataSecurityLevel MAXIMUM
      The security level that includes everything in the OBSCURE_SECRETS level, but takes even more drastic measures to avoid capturing any personally identifiable information, including excluding access logs from the archive and obscuring values in entry DNs and search filters.

  • Method Details

    • values

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

    • valueOf

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

      @NotNull public String getName()
      Retrieves the name used to identify this security level.
      Returns:
      The name used to identify this security level.

    • forName

      @Nullable public static CollectSupportDataSecurityLevel forName(@NotNull String name)
      Retrieves the collect support data security level with the given name.
      Parameters:
      name - The name for the collect support data security level to retrieve. It must not be null.
      Returns:
      The collect support data security level with the given name, or null if there is no security level with the provided name.

    • toString

      @NotNull public String toString()
      Retrieves a string representation of this collect support data security level.
      Overrides:
      toString in class Enum<CollectSupportDataSecurityLevel>
      Returns:
      A string representation of this collect support data security level.