Package com.inductiveautomation.ignition.common.auth.security.level

Enum Class ReservedSecurityLevel

java.lang.Object
java.lang.Enum<ReservedSecurityLevel>
com.inductiveautomation.ignition.common.auth.security.level.ReservedSecurityLevel
All Implemented Interfaces:
Serializable, Comparable<ReservedSecurityLevel>, Constable
public enum ReservedSecurityLevel extends Enum<ReservedSecurityLevel>
Reserved Security Levels and their descriptions. These Security Levels are built into the system.

  • Enum Constant Details

  • Method Details

    • values

      public static ReservedSecurityLevel[] 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 ReservedSecurityLevel 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

    • description

      public String description()
      Returns:
      the description for this built-in security level

    • matches

      public boolean matches(@Nullable String str)
      Parameters:
      str - the String to test
      Returns:
      if the given String matches the name of this ReservedSecurityLevel
      See Also:

    • find

      public Optional<SecurityLevelConfig> find(com.google.common.collect.ImmutableCollection<SecurityLevelConfig> securityLevelConfigs)
      Find the reserved security level from the given ImmutableCollection of SecurityLevelConfigs.
      Parameters:
      securityLevelConfigs - the children of the root security level
      Returns:
      an Optional SecurityLevelConfig representing the reserved security level if the given tree contains it

    • withChildren

      public SecurityLevelConfig withChildren(String... childNames)
      Create a reserved new security level node containing children with the given names
      Parameters:
      childNames - the names of the children
      Returns:
      the new reserved security level tree node containing children with the given names

    • withChildren

      public SecurityLevelConfig withChildren(SecurityLevelConfig... children)
      Create a reserved security level node containing the given children
      Parameters:
      children - the children
      Returns:
      the new reserved security level tree node containing the given children