Package 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 contains an access rule list for declaring which objects that the role provides access to.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACCESS_PATH	The dictionary key for the path in the access dictionary.
static final String	ACCESS_PERMISSION	The dictionary key for the permission list in the access dictionary.
static final String	ACCESS_REGEX	The dictionary key for the regex path in the access dictionary.
static final String	ACCESS_VIA	The dictionary key for the caller path in the access dictionary.
static final String	KEY_ACCESS	The dictionary key for the role access array.
static final String	KEY_AUTO	The dictionary key for automatic user match.
static final String	KEY_DESCRIPTION	The dictionary key for the role description.
static final String	KEY_NAME	The dictionary key for the role name.
static final Path	PATH	The role object storage path.
static final String	PERM_ALL	The permission key for full access.
static final String	PERM_INTERNAL	Deprecated, for removal: This API element is subject to removal in a future version. Internal access is now achieved by combining PERM_READ with ACCESS_VIA "procedure/**" (or preferably a more restricted pattern).
static final String	PERM_NONE	The permission key for no access.
static final String	PERM_READ	The permission key for read access.
static final String	PERM_SEARCH	The permission key for search access.
static final String	PERM_WRITE	The permission key for write access.

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

dict, KEY_ACTIVATED_TIME, KEY_CLASSNAME, KEY_ID, KEY_TYPE, PREFIX_COMPUTED, PREFIX_HIDDEN

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static Stream<Role>	all(Storage storage)	Returns a stream of all roles found in the storage.
String	auto()	Returns the automatic role attachment type.
String	description()	Returns the role description.
boolean	hasAccess(String path, String permission)	Checks if the role has access permission for a storage path.
boolean	hasAccess(String path, String via, 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.
protected void	init()	Initializes this role after loading it from a storage.
protected Pattern	initPathRegex(Dict dict)	Creates a path regex pattern from the access dictionary.
protected HashSet<String>	initPermissions(Dict dict)	Initialize the access dictionary permissions set.
protected Pattern	initViaRegex(Dict dict)	Creates a via path regex pattern from the access dictionary.
String	name()	Returns the role name.
static Dict	normalize(String id, Dict dict)	Normalizes a role data object if needed.

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

activate, activatedTime, destroy, dictKey, id, isActive, isDeleted, isModified, passivate, path, serialize, sterilize, toString, type

Methods inherited from class java.lang.Object

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

Field Details

KEY_NAME

public static final String KEY_NAME

The dictionary key for the role name.

See Also:

• Constant Field Values

KEY_DESCRIPTION

public static final String KEY_DESCRIPTION

The dictionary key for the role description.

See Also:

• Constant Field Values

KEY_AUTO

public static final String KEY_AUTO

The dictionary key for automatic user match.

See Also:

• Constant Field Values

KEY_ACCESS

public static final 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 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 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_VIA

public static final String ACCESS_VIA

The dictionary key for the caller path in the access dictionary. The value stored is a glob pattern for matching a storage object path.

See Also:

• Constant Field Values

ACCESS_PERMISSION

public static final 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 String PERM_NONE

The permission key for no access.

See Also:

• Constant Field Values

PERM_INTERNAL

@Deprecated(forRemoval=true)
public static final String PERM_INTERNAL

Deprecated, for removal: This API element is subject to removal in a future version.

Internal access is now achieved by combining PERM_READ with ACCESS_VIA "procedure/**" (or preferably a more restricted pattern).

The permission key for internal access.

See Also:

• Constant Field Values

PERM_READ

public static final String PERM_READ

The permission key for read access.

See Also:

• Constant Field Values

PERM_SEARCH

public static final String PERM_SEARCH

The permission key for search access.

See Also:

• Constant Field Values

PERM_WRITE

public static final String PERM_WRITE

The permission key for write access.

See Also:

• Constant Field Values

PERM_ALL

public static final 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 Details

Role

public Role(String id,
 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 Details

all

public static Stream<Role> all(Storage storage)

Returns a stream of all roles found in the storage.

Parameters:

storage - the storage to search

Returns:

a stream of role instances found

normalize

public static Dict normalize(String id,
 Dict dict)

Normalizes a role data object if needed. This method will modify legacy data into the proper keys and values.

Parameters:

id - the object identifier

dict - the storage data

Returns:

the storage data (possibly modified)

init

protected void init()

Initializes this role after loading it from a storage.

Overrides:

init in class StorableObject

initPathRegex

protected Pattern initPathRegex(Dict dict)

Creates a path regex pattern from the access dictionary.

Parameters:

dict - the access dictionary

Returns:

the storage path pattern regex

initViaRegex

protected Pattern initViaRegex(Dict dict)

Creates a via path regex pattern from the access dictionary.

Parameters:

dict - the access dictionary

Returns:

the via storage path pattern regex

initPermissions

protected HashSet<String> initPermissions(Dict dict)

Initialize the access dictionary permissions set.

Parameters:

dict - the access dictionary

Returns:

the permissions set

name

public String name()

Returns the role name.

Returns:

the role name.

description

public String description()

Returns the role description.

Returns:

the role description.

auto

public 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(String path,
 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 requested object storage path

permission - the requested permission

Returns:

true if the role provides access, or false otherwise

hasAccess

public boolean hasAccess(String path,
 String via,
 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 requested object storage path

via - the caller path, or null to use context

permission - the requested permission

Returns:

true if the role provides access, or false otherwise