Package com.inductiveautomation.ignition.common.auth.permissions

Class PermissionsConfig

java.lang.Object

com.inductiveautomation.ignition.common.auth.permissions.PermissionsConfig

All Implemented Interfaces:

java.io.Serializable

public abstract class PermissionsConfig
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PermissionsConfig.Builder
static class	PermissionsConfig.GsonAdapter
static class	PermissionsConfig.PathGsonAdapter
static class	PermissionsConfig.Type

Field Summary

Fields

Modifier and Type	Field	Description
static PermissionsConfig	DEFAULT

Method Summary

Modifier and Type	Method	Description
static PermissionsConfig.Builder	builder(PermissionsConfig.Type type)
boolean	equals(java.lang.Object o)
static PermissionsConfig	fromJsonTree(com.inductiveautomation.ignition.common.gson.JsonElement json)
com.google.common.collect.ImmutableSet<SecurityLevelConfig>	getSecurityLevels()
abstract PermissionsConfig.Type	getType()
int	hashCode()
boolean	isAuthorized(com.google.common.collect.ImmutableCollection<SecurityLevelConfig> securityLevels)	Checks if the given security levels are authorized against the security levels contained in this PermissionsConfig.
boolean	isEmpty()
static PermissionsConfig	of()
static PermissionsConfig	of(PermissionsConfig.Type type)
static PermissionsConfig	of(PermissionsConfig.Type type, com.google.common.collect.ImmutableCollection<SecurityLevelConfig> securityLevels)
com.inductiveautomation.ignition.common.gson.JsonElement	toJsonTree()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final PermissionsConfig DEFAULT

Method Detail

getType

public abstract PermissionsConfig.Type getType()

getSecurityLevels

public com.google.common.collect.ImmutableSet<SecurityLevelConfig> getSecurityLevels()

isEmpty

public boolean isEmpty()

Returns:

true if the security levels are empty

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toJsonTree

public com.inductiveautomation.ignition.common.gson.JsonElement toJsonTree()

fromJsonTree

public static PermissionsConfig fromJsonTree(com.inductiveautomation.ignition.common.gson.JsonElement json)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

of

public static PermissionsConfig of()

of

public static PermissionsConfig of(PermissionsConfig.Type type)

of

public static PermissionsConfig of(PermissionsConfig.Type type,
                                   com.google.common.collect.ImmutableCollection<SecurityLevelConfig> securityLevels)

builder

public static PermissionsConfig.Builder builder(PermissionsConfig.Type type)

isAuthorized

public boolean isAuthorized(com.google.common.collect.ImmutableCollection<SecurityLevelConfig> securityLevels)

Checks if the given security levels are authorized against the security levels contained in this PermissionsConfig. If this PermissionsConfig is type AllOf, each of the security levels in this PermissionsConfig must be an ancestor of one of the given security levels. If this PermissionsConfig is type AnyOf, at least one of the security levels in this PermissionsConfig must be an ancestor of one of the given security levels.