org.rapidcontext.core.type

Class Role

java.lang.Object

org.rapidcontext.core.storage.StorableObject

org.rapidcontext.core.type.Role

public class Role
extends StorableObject

A user access role. Each role may contain an access rule list for declaring which objects that the role provides access to.

Version:

1.0

Author:

Per Cederberg

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACCESS_PATH The dictionary key for the path in the access dictionary.
static java.lang.String	ACCESS_PERMISSION The dictionary key for the permission list in the access dictionary.
static java.lang.String	ACCESS_REGEX The dictionary key for the regex path in the access dictionary.
static java.lang.String	KEY_ACCESS The dictionary key for the role access array.
static java.lang.String	KEY_AUTO The dictionary key for automatic user match.
static java.lang.String	KEY_DESCRIPTION The dictionary key for the role description.
static java.lang.String	KEY_NAME The dictionary key for the role name.
static Path	PATH The role object storage path.
static java.lang.String	PERM_ALL The permission key for full access.
static java.lang.String	PERM_INTERNAL The permission key for internal access.
static java.lang.String	PERM_NONE The permission key for no access.
static java.lang.String	PERM_READ The permission key for read access.
static java.lang.String	PERM_SEARCH The permission key for search access.
static java.lang.String	PERM_WRITE The permission key for write access.

Fields inherited from class org.rapidcontext.core.storage.StorableObject

dict, KEY_CLASSNAME, KEY_ID, KEY_TYPE

Constructor Summary

Constructors

Constructor and Description
Role(java.lang.String id, java.lang.String type, Dict dict) Creates a new role from a serialized representation.

Method Summary

Modifier and Type	Method and Description
java.lang.String	auto() Returns the automatic role attachment type.
java.lang.String	description() Returns the role description.
static Role[]	findAll(Storage storage) Searches for all roles in the storage.
boolean	hasAccess(java.lang.String path, java.lang.String permission) Checks if the role has access permission for a storage path.
boolean	hasUser(User user) Checks if the specified user has this role.
java.lang.String	name() Returns the role name.

Methods inherited from class org.rapidcontext.core.storage.StorableObject

activate, destroy, id, init, isActive, isModified, passivate, path, serialize, toString, type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

KEY_NAME

public static final java.lang.String KEY_NAME

The dictionary key for the role name.

See Also:

Constant Field Values

KEY_DESCRIPTION

public static final java.lang.String KEY_DESCRIPTION

The dictionary key for the role description.

See Also:

Constant Field Values

KEY_AUTO

public static final java.lang.String KEY_AUTO

The dictionary key for automatic user match.

See Also:

Constant Field Values

KEY_ACCESS

public static final java.lang.String KEY_ACCESS

The dictionary key for the role access array. The value stored is an array of access rules.

See Also:

Constant Field Values

ACCESS_PATH

public static final java.lang.String ACCESS_PATH

The dictionary key for the path in the access dictionary. The value stored is an absolute path to an object, with optional glob characters ('*', '**' or '?').

See Also:

Constant Field Values

ACCESS_REGEX

public static final java.lang.String ACCESS_REGEX

The dictionary key for the regex path in the access dictionary. The value stored is a regular expression matching an absolute path to an object (without leading '/' chars).

See Also:

Constant Field Values

ACCESS_PERMISSION

public static final java.lang.String ACCESS_PERMISSION

The dictionary key for the permission list in the access dictionary. The value stored is a string with permissions separated by comma (',').

See Also:

PERM_NONE, PERM_INTERNAL, PERM_READ, PERM_SEARCH, PERM_WRITE, PERM_ALL, Constant Field Values

PERM_NONE

public static final java.lang.String PERM_NONE

The permission key for no access.

See Also:

Constant Field Values

PERM_INTERNAL

public static final java.lang.String PERM_INTERNAL

The permission key for internal access.

See Also:

Constant Field Values

PERM_READ

public static final java.lang.String PERM_READ

The permission key for read access.

See Also:

Constant Field Values

PERM_SEARCH

public static final java.lang.String PERM_SEARCH

The permission key for search access.

See Also:

Constant Field Values

PERM_WRITE

public static final java.lang.String PERM_WRITE

The permission key for write access.

See Also:

Constant Field Values

PERM_ALL

public static final java.lang.String PERM_ALL

The permission key for full access.

See Also:

Constant Field Values

PATH

public static final Path PATH

The role object storage path.

Constructor Detail

Role

public Role(java.lang.String id,
            java.lang.String type,
            Dict dict)

Creates a new role from a serialized representation.

Parameters:

id - the object identifier

type - the object type name

dict - the serialized representation

Method Detail

findAll

public static Role[] findAll(Storage storage)

Searches for all roles in the storage.

Parameters:

storage - the storage to search in

Returns:

an array of all roles found

name

public java.lang.String name()

Returns the role name.

Returns:

the role name.

description

public java.lang.String description()

Returns the role description.

Returns:

the role description.

auto

public java.lang.String auto()

Returns the automatic role attachment type. The values "all" and "auth" are the only ones with defined meaning.

Returns:

the automatic role attachment type

hasUser

public boolean hasUser(User user)

Checks if the specified user has this role. The user may be null, in which case only automatic roles for "all" will be considered a match.

Parameters:

user - the user to check, or null

Returns:

true if the user has this role, or false otherwise

hasAccess

public boolean hasAccess(java.lang.String path,
                         java.lang.String permission)

Checks if the role has access permission for a storage path. The access list is processed from top to bottom to find a matching path entry. If a matching path with the PERM_NONE permission is encountered, false will be returned. Otherwise true will be returned only if the permission matches the requested one.

Parameters:

path - the object storage path

permission - the requested permission

Returns:

true if the role provides access, or false otherwise