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

Enum ReservedSecurityLevel

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ReservedSecurityLevel>
    public enum ReservedSecurityLevel
extends java.lang.Enum<ReservedSecurityLevel>
    Reserved Security Levels and their descriptions. These Security Levels are built into the system.

    • Method Detail

      • values

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

      • valueOf

        public static ReservedSecurityLevel valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • description

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

      • matches

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

      • find

        public java.util.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​(java.lang.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