cz.ues.platform.security.authz

Enum Mode

java.lang.Object

java.lang.Enum<Mode>

cz.ues.platform.security.authz.Mode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Mode>

public enum Mode
extends java.lang.Enum<Mode>

Authorization mode determines the result scope of authorized roles.

Since:

UES6-00

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL_ROLES This mode authorizes all roles and groups where is the access role casted.
ALLOW_ALL This is the mode for "disabling" authorization.
FIRST_ROLE The authorization will stop after first successful (authorized) role.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	value Mode value.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	value() Returns mode value.
static Mode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Mode[]	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

FIRST_ROLE

public static final Mode FIRST_ROLE

The authorization will stop after first successful (authorized) role. This is much faster than Mode.ALL_ROLES.

This mode is used as default for authorization process.

ALL_ROLES

public static final Mode ALL_ROLES

This mode authorizes all roles and groups where is the access role casted. The result of authorization process is set of all authorized subjects. This mode should be used only when you need to fill some ListBox in form with set of authorized roles, to provide selection possibility for user, which role he/she want to use. But attention, this mode is slower than the default one -Mode.FIRST_ROLE, because each role must be checked for access permissions.

ALLOW_ALL

public static final Mode ALLOW_ALL

This is the mode for "disabling" authorization. All user roles are used as authorized without authorization process. So this mode should be used very carefully ! In case you don't need to authorize but need existing authorization context, use authorization propagation mode Propagation.SUPPORTS

Field Detail

value

private final value

Mode value.

Method Detail

values

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

Returns:

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

valueOf

public static Mode valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

value

public java.lang.String value()

Returns mode value.

Returns:

Mode value