Package pl.edu.icm.unity.types.basic

Enum Class EntityState

java.lang.Object

java.lang.Enum<EntityState>

pl.edu.icm.unity.types.basic.EntityState

All Implemented Interfaces:

Serializable, Comparable<EntityState>, Constable

public enum EntityState
extends Enum<EntityState>

Overall entity status.

Author:

K. Benedyczak

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
authenticationDisabled	The entity is fully valid, but it can not authenticate itself.
disabled	The entity is disabled.
onlyLoginPermitted	This state is the same as disabled with one exception: it is possible to authenticate as this entity and what's more, immediately after logging the state is changed to valid.
valid	No restrictions.

Method Summary

Modifier and Type	Method	Description
static EntityState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EntityState[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

valid

public static final EntityState valid

No restrictions.

authenticationDisabled

public static final EntityState authenticationDisabled

The entity is fully valid, but it can not authenticate itself. It is still possible to query for entity's attributes etc.

disabled

public static final EntityState disabled

The entity is disabled. It is not possible to authenticate as this entity. What is more it is only possible to get the attributes of the entity using the privileged getAllAttribtues operation. Therefore such entity can not be used as a subject of SAML queries, etc. All other management operations are still possible. It is also possible to get other information about the entity, assuming that authZ level permits.

onlyLoginPermitted

public static final EntityState onlyLoginPermitted

This state is the same as disabled with one exception: it is possible to authenticate as this entity and what's more, immediately after logging the state is changed to valid. This state is used to implement scheduled account removal with a grace time, which controlled by end-user. During the grace time this status is used and authentication is re-enabling the account.

Method Details

values

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