Package org.opencastproject.userdirectory

Class CustomRoleProvider

java.lang.Object

org.opencastproject.userdirectory.CustomRoleProvider

All Implemented Interfaces:

RoleProvider

public class CustomRoleProvider
extends Object
implements RoleProvider

An in-memory role provider containing administratively-defined custom roles

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CUSTOM_ROLES_KEY	Configuration key for the custom role list
static final String	CUSTOM_ROLES_PATTERN_KEY	Configuration key for the custom role pattern
protected SecurityService	securityService	The security service

Constructor Summary

Constructors

Constructor	Description
CustomRoleProvider()

Method Summary

Modifier and Type	Method	Description
protected void	activate(org.osgi.service.component.ComponentContext cc)	Callback to activate the component.
Iterator<Role>	findRoles(String query, Role.Target target, int offset, int limit)	Return the found roles as an iterator.
String	getOrganization()	Returns the identifier for the organization that is defining this set of roles.
List<Role>	getRolesForUser(String userName)	Returns the roles for this user or an empty array if no roles are applicable.
void	setSecurityService(SecurityService securityService)

Methods inherited from class java.lang.Object

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

Field Details

CUSTOM_ROLES_KEY

public static final String CUSTOM_ROLES_KEY

Configuration key for the custom role list

See Also:

• Constant Field Values

CUSTOM_ROLES_PATTERN_KEY

public static final String CUSTOM_ROLES_PATTERN_KEY

Configuration key for the custom role pattern

See Also:

• Constant Field Values

securityService

protected SecurityService securityService

The security service

Constructor Details

CustomRoleProvider

public CustomRoleProvider()

Method Details

setSecurityService

public void setSecurityService(SecurityService securityService)

Parameters:

securityService - the securityService to set

activate

protected void activate(org.osgi.service.component.ComponentContext cc)

Callback to activate the component.

Parameters:

cc - the declarative services component context

getOrganization

public String getOrganization()

Returns the identifier for the organization that is defining this set of roles.

Specified by:

getOrganization in interface RoleProvider

Returns:

the defining organization

See Also:

• UserProvider.getOrganization()

getRolesForUser

public List<Role> getRolesForUser(String userName)

Description copied from interface: RoleProvider

Returns the roles for this user or an empty array if no roles are applicable.

Specified by:

getRolesForUser in interface RoleProvider

Parameters:

userName - the user id

Returns:

the set of roles

See Also:

• RoleProvider.getRolesForUser(String)

findRoles

public Iterator<Role> findRoles(String query,
 Role.Target target,
 int offset,
 int limit)

Description copied from interface: RoleProvider

Return the found roles as an iterator.

Specified by:

findRoles in interface RoleProvider

Parameters:

query - the query. Use the wildcards "_" to match any single character and "%" to match an arbitrary number of characters (including zero characters).

offset - the offset

limit - the limit. 0 means no limit

Returns:

an iterator of role's

See Also:

• RoleProvider.findRoles(String, Role.Target, int, int)