Package org.opencastproject.userdirectory.brightspace

Class BrightspaceUserProviderInstance

java.lang.Object

org.opencastproject.userdirectory.brightspace.BrightspaceUserProviderInstance

All Implemented Interfaces:

CachingUserProviderMXBean, RoleProvider, UserProvider

public class BrightspaceUserProviderInstance
extends Object
implements UserProvider, RoleProvider, CachingUserProviderMXBean

Field Summary

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

ALL_ORGANIZATIONS

Constructor Summary

Constructors

Constructor	Description
BrightspaceUserProviderInstance(String pid, BrightspaceClient client, Organization organization, int cacheSize, int cacheExpiration, Set instructorRoles, Set ignoredUsernames)	Constructs a Brighspace user provider with the needed settings

Method Summary

Modifier and Type	Method	Description
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.
float	getCacheHitRatio()	Gets the ratio of cache hits to total requests.
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.

Methods inherited from class java.lang.Object

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

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

findUsers

Constructor Details

BrightspaceUserProviderInstance

public BrightspaceUserProviderInstance(String pid,
 BrightspaceClient client,
 Organization organization,
 int cacheSize,
 int cacheExpiration,
 Set instructorRoles,
 Set ignoredUsernames)

Constructs a Brighspace user provider with the needed settings

Parameters:

pid - The PID of this service.

client - The Brightspace rest service client.

organization - The organisation.

cacheSize - The number of users to cache.

cacheExpiration - The number of minutes to cache users.

Method Details

getCacheHitRatio

public float getCacheHitRatio()

Description copied from interface: CachingUserProviderMXBean

Gets the ratio of cache hits to total requests.

Specified by:

getCacheHitRatio in interface CachingUserProviderMXBean

Returns:

the hit ratio

getName

public String getName()

Gets the provider name

Specified by:

getName in interface UserProvider

Returns:

the provider name

See Also:

• UserProvider.getName()

getUsers

public Iterator<User> getUsers()

Gets all known users.

Specified by:

getUsers in interface UserProvider

Returns:

the users

See Also:

• UserProvider.getUsers()

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)

countUsers

public long countUsers()

Returns the number of users in the provider

Specified by:

countUsers in interface UserProvider

Returns:

the count of users in the provider

See Also:

• UserProvider.countUsers()

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()

findUsers

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

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

See Also:

• UserProvider.findUsers(java.lang.String, int, int)

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

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

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