Package org.opencastproject.userdirectory

Class InMemoryUserAndRoleProvider

java.lang.Object

org.opencastproject.userdirectory.InMemoryUserAndRoleProvider

All Implemented Interfaces:

RoleProvider, UserProvider, org.osgi.service.cm.ManagedService

public class InMemoryUserAndRoleProvider
extends Object
implements UserProvider, RoleProvider, org.osgi.service.cm.ManagedService

An in-memory user directory containing the users and roles used by the system.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CAPTURE_AGENT_ROLES_PREFIX	Configuration key for optional additional roles for the capture agent user
static final String	CAPTURE_AGENT_USER_NAME
static final String	CAPTURE_AGENT_USER_PREFIX
static final String	DIGEST_PASSWORD_KEY	Configuration key for the digest password
static final String	DIGEST_USER_KEY	Configuration key for the digest users
static final String	DIGEST_USER_NAME	The digest users
static final String	PROVIDER_NAME
protected SecurityService	securityService	The security service

Fields inherited from interface org.opencastproject.security.api.UserProvider

ALL_ORGANIZATIONS

Constructor Summary

Constructors

Constructor	Description
InMemoryUserAndRoleProvider()

Method Summary

Modifier and Type	Method	Description
protected void	activate(org.osgi.service.component.ComponentContext cc)	Callback to activate the component.
long	countUsers()	Returns the number of users in the provider
Iterator<Role>	findRoles(String query, Role.Target target, int offset, int limit)	Return the found roles as an iterator.
Iterator<User>	findUsers(String query, int offset, int limit)	Return the found user's as an iterator.
String	getName()	Gets the provider name
String	getOrganization()	Returns the identifier for the organization that is associated with this user provider.
List<Role>	getRolesForUser(String userName)	Returns the roles for this user or an empty array if no roles are applicable.
Iterator<User>	getUsers()	Gets all known users.
void	invalidate(String userName)	Discards any cached value for given user name.
User	loadUser(String userName)	Loads a user by username, or returns null if this user is not known to this provider.
String	toString()
void	updated(Dictionary<String,?> properties)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opencastproject.security.api.UserProvider

findUsers

Field Details

PROVIDER_NAME

public static final String PROVIDER_NAME

See Also:

• Constant Field Values

DIGEST_USER_NAME

public static final String DIGEST_USER_NAME

The digest users

See Also:

• Constant Field Values

CAPTURE_AGENT_USER_NAME

public static final String CAPTURE_AGENT_USER_NAME

See Also:

• Constant Field Values

DIGEST_USER_KEY

public static final String DIGEST_USER_KEY

Configuration key for the digest users

See Also:

• Constant Field Values

CAPTURE_AGENT_USER_PREFIX

public static final String CAPTURE_AGENT_USER_PREFIX

See Also:

• Constant Field Values

DIGEST_PASSWORD_KEY

public static final String DIGEST_PASSWORD_KEY

Configuration key for the digest password

See Also:

• Constant Field Values

CAPTURE_AGENT_ROLES_PREFIX

public static final String CAPTURE_AGENT_ROLES_PREFIX

Configuration key for optional additional roles for the capture agent user

See Also:

• Constant Field Values

securityService

protected SecurityService securityService

The security service

Constructor Details

InMemoryUserAndRoleProvider

public InMemoryUserAndRoleProvider()

Method Details

activate

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

Callback to activate the component.

Parameters:

cc - the declarative services component context

updated

public void updated(Dictionary<String,?> properties)
             throws org.osgi.service.cm.ConfigurationException

Specified by:

updated in interface org.osgi.service.cm.ManagedService

Throws:

org.osgi.service.cm.ConfigurationException

getName

public String getName()

Description copied from interface: UserProvider

Gets the provider name

Specified by:

getName in interface UserProvider

Returns:

the provider name

getUsers

public Iterator<User> getUsers()

Description copied from interface: UserProvider

Gets all known users.

Specified by:

getUsers in interface UserProvider

Returns:

the users

loadUser

public User loadUser(String userName)

Loads a user by username, or returns null if this user is not known to this provider.

Specified by:

loadUser in interface UserProvider

Parameters:

userName - the username

Returns:

the user

See Also:

• UserProvider.loadUser(java.lang.String)

toString

public String toString()

Overrides:

toString in class Object

See Also:

• Object.toString()

getOrganization

public String getOrganization()

Returns the identifier for the organization that is associated with this user provider. If equal to UserProvider.ALL_ORGANIZATIONS, this provider will always be consulted, regardless of the organization.

Specified by:

getOrganization in interface RoleProvider

Specified by:

getOrganization in interface UserProvider

Returns:

the defining organization

See Also:

• UserProvider.getOrganization()

getRolesForUser

public List<Role> getRolesForUser(String userName)

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)

findUsers

public Iterator<User> findUsers(String query,
 int offset,
 int limit)

Description copied from interface: UserProvider

Return the found user's as an iterator.

Specified by:

findUsers in interface UserProvider

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 user's

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

countUsers

public long countUsers()

Description copied from interface: UserProvider

Returns the number of users in the provider

Specified by:

countUsers in interface UserProvider

Returns:

the count of users in the provider

invalidate

public void invalidate(String userName)

Description copied from interface: UserProvider

Discards any cached value for given user name.

Specified by:

invalidate in interface UserProvider

Parameters:

userName - the user name