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
Reserved Security Levels and their descriptions. These Security Levels are built into the system.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum Constants -
Method Summary
Modifier and TypeMethodDescriptionfind
(com.google.common.collect.ImmutableCollection<SecurityLevelConfig> securityLevelConfigs) Find the reserved security level from the givenImmutableCollection
ofSecurityLevelConfig
s.boolean
static ReservedSecurityLevel
Returns the enum constant of this class with the specified name.static ReservedSecurityLevel[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.withChildren
(SecurityLevelConfig... children) Create a reserved security level node containing the given childrenwithChildren
(String... childNames) Create a reserved new security level node containing children with the given names
-
Enum Constant Details
-
Authenticated
-
Roles
-
SecurityZones
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
description
- Returns:
- the description for this built-in security level
-
matches
- Parameters:
str
- theString
to test- Returns:
- if the given
String
matches the name of thisReservedSecurityLevel
- See Also:
-
find
public Optional<SecurityLevelConfig> find(com.google.common.collect.ImmutableCollection<SecurityLevelConfig> securityLevelConfigs) Find the reserved security level from the givenImmutableCollection
ofSecurityLevelConfig
s.- 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
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
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
-