Package org.keycloak.representations.idm.authorization

Enum Logic

java.lang.Object

java.lang.Enum<Logic>

org.keycloak.representations.idm.authorization.Logic

All Implemented Interfaces:

Serializable, Comparable<Logic>, EnumWithStableIndex

public enum Logic
extends Enum<Logic>
implements EnumWithStableIndex

The decision strategy dictates how the policies associated with a given policy are evaluated and how a final decision is obtained.

Author:

Pedro Igor

Enum Constant Summary

Enum Constants

Enum Constant	Description
NEGATIVE	Defines that this policy uses a logical negation.
POSITIVE	Defines that this policy follows a positive logic.

Method Summary

Modifier and Type	Method	Description
int	getStableIndex()
static Logic	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Logic	valueOfInteger(Integer id)
static Logic[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

POSITIVE

public static final Logic POSITIVE

Defines that this policy follows a positive logic. In other words, the final decision is the policy outcome.

NEGATIVE

public static final Logic NEGATIVE

Defines that this policy uses a logical negation. In other words, the final decision would be a negative of the policy outcome.

Method Detail

values

public static Logic[] 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 (Logic c : Logic.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Logic valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getStableIndex

public int getStableIndex()

Specified by:

getStableIndex in interface EnumWithStableIndex

Returns:

Unique numeric index which is stable in time and identifies an instance. Reusing the same index for two distinct entries of the same class is forbidden even if they cannot exist at the same time (e.g. one is deleted before other is introduced).

valueOfInteger

public static Logic valueOfInteger(Integer id)