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

Class SecurityLevelPath

java.lang.Object

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

All Implemented Interfaces:

java.io.Serializable

public class SecurityLevelPath
extends java.lang.Object
implements java.io.Serializable

Represents a hierarchical path to a security level in a Security Level Tree. Provides methods to parse from a unix-style String path to a SecurityLevelPath object and vice-versa. All security level paths look like absolute unix-style filesystem paths (i.e. /foo/bar/baz). There is no concept at this time of relative paths. Each node / part in the path may only contain alphanumeric characters, hyphen, and underscore.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static SecurityLevelPath	AUTHENTICATED Path to the "Authenticated" Security level
static SecurityLevelPath	ROLES Path to the "/Authenticated/Roles" Security level
static SecurityLevelPath	SECURITY_ZONES Path to the "/SecurityZones" Security level

Method Summary

Modifier and Type	Method and Description
SecurityLevelPath	append(java.lang.String part) Append a new security level name (path part) to this SecurityLevelPath
boolean	equals(java.lang.Object obj)
java.lang.String	format()
static SecurityLevelPath	fromRootLevel(java.lang.String rootLevelName) Parses the given root security level name into a SecurityLevelPath with only the given root part of the path
int	hashCode()
static SecurityLevelPath	parse(java.lang.String path) Parse the given String into a SecurityLevelPath
java.lang.String[]	parts()
java.lang.String[]	partsSansRoot()
SecurityLevelPath	prepend(java.lang.String part) Append a new security level name (path part) to the beginning of this SecurityLevelPath
java.lang.String	root()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

AUTHENTICATED

public static final SecurityLevelPath AUTHENTICATED

Path to the "Authenticated" Security level

ROLES

public static final SecurityLevelPath ROLES

Path to the "/Authenticated/Roles" Security level

SECURITY_ZONES

public static final SecurityLevelPath SECURITY_ZONES

Path to the "/SecurityZones" Security level

Method Detail

parse

@Nonnull
public static SecurityLevelPath parse(@Nonnull
                                               java.lang.String path)

Parse the given String into a SecurityLevelPath

Parameters:

path - the String to parse into a SecurityLevelPath

Returns:

the parsed SecurityLevelPath

Throws:

java.lang.IllegalArgumentException - if the given String does not conform to the expected format

fromRootLevel

@Nonnull
public static SecurityLevelPath fromRootLevel(@Nonnull
                                                       java.lang.String rootLevelName)

Parses the given root security level name into a SecurityLevelPath with only the given root part of the path

Parameters:

rootLevelName - the security level name of the root

Returns:

the parsed SecurityLevelPath containing only the given root part

Throws:

java.lang.IllegalArgumentException - if the given String does not conform to the expected format

format

@Nonnull
public java.lang.String format()

Returns:

the String form of this SecurityLevelPath

toString

@Nonnull
public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

parts

@Nonnull
public java.lang.String[] parts()

Returns:

this SecurityLevelPath's parts (i.e. /foo/bar/baz => ["foo", "bar", "baz"])

partsSansRoot

@Nonnull
public java.lang.String[] partsSansRoot()

Returns:

this SecurityLevelPath's parts without the root (i.e. /foo/bar/baz => ["bar", "baz"])

append

@Nonnull
public SecurityLevelPath append(@Nonnull
                                         java.lang.String part)

Append a new security level name (path part) to this SecurityLevelPath

Parameters:

part - the path part to append to the end of this path

Returns:

a new SecurityLevelPath starting with this path and with the given path part at the end

Throws:

java.lang.IllegalArgumentException - if the new security level path part does not conform to the expected format

prepend

@Nonnull
public SecurityLevelPath prepend(@Nonnull
                                          java.lang.String part)

Append a new security level name (path part) to the beginning of this SecurityLevelPath

Parameters:

part - the path part to prepend to the beginning of this path

Returns:

a new SecurityLevelPath starting with this path and with the given path part at the beginning

Throws:

java.lang.IllegalArgumentException - if the new security level path part does not conform to the expected format

root

@Nonnull
public java.lang.String root()

Returns:

the root security level name of this SecurityLevelPath (i.e. /foo/bar/baz => foo)