Package org.ow2.authzforce.xacml.identifiers

Enum XacmlResourceScope

java.lang.Object

java.lang.Enum<XacmlResourceScope>

org.ow2.authzforce.xacml.identifiers.XacmlResourceScope

All Implemented Interfaces:

Serializable, Comparable<XacmlResourceScope>

public enum XacmlResourceScope
extends Enum<XacmlResourceScope>

XACML Resource scopes, as defined in XACML v3.0 Multiple Decision Profile Version 1.0, §6.1. The actual value

Enum Constant Summary

Enum Constants

Enum Constant	Description
CHILDREN	Resource scope of Children (the given resource and its direct children)
DESCENDANTS	Resource scope of Descendants (the given resource and all descendants at any depth or distance)
IMMEDIATE	Resource scope of Immediate (only the given resource)

Method Summary

Modifier and Type	Method	Description
static XacmlResourceScope	fromValue(String scopeId)	Get resource scope constant from value
String	value()	Get standard name (string), e.g.
static XacmlResourceScope	valueOf(String name)	Returns the enum constant of this type with the specified name.
static XacmlResourceScope[]	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

IMMEDIATE

public static final XacmlResourceScope IMMEDIATE

Resource scope of Immediate (only the given resource)

CHILDREN

public static final XacmlResourceScope CHILDREN

Resource scope of Children (the given resource and its direct children)

DESCENDANTS

public static final XacmlResourceScope DESCENDANTS

Resource scope of Descendants (the given resource and all descendants at any depth or distance)

Method Detail

values

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

Returns:

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

valueOf

public static XacmlResourceScope 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

value

public String value()

Get standard name (string), e.g. "Immediate" for IMMEDIATE

Returns:

scope name

fromValue

public static XacmlResourceScope fromValue(String scopeId)

Get resource scope constant from value

Parameters:

scopeId - resource scope identifier

Returns:

Resource scope enum