Package org.opencastproject.userdirectory.moodle

Class MoodleUserProviderInstance

java.lang.Object

org.opencastproject.userdirectory.moodle.MoodleUserProviderInstance

All Implemented Interfaces:

CachingUserProviderMXBean, RoleProvider, UserProvider

public class MoodleUserProviderInstance
extends Object
implements UserProvider, RoleProvider, CachingUserProviderMXBean

A UserProvider that reads user roles from Moodle.

Field Summary

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

ALL_ORGANIZATIONS

Constructor Summary

Constructors

Constructor	Description
MoodleUserProviderInstance(String pid, MoodleWebService client, Organization organization, String coursePattern, String userPattern, String groupPattern, boolean groupRoles, int cacheSize, int cacheExpiration, String adminUserName, boolean lowercaseUsername, String contextRolePrefix)	Constructs an Moodle 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

MoodleUserProviderInstance

public MoodleUserProviderInstance(String pid,
 MoodleWebService client,
 Organization organization,
 String coursePattern,
 String userPattern,
 String groupPattern,
 boolean groupRoles,
 int cacheSize,
 int cacheExpiration,
 String adminUserName,
 boolean lowercaseUsername,
 String contextRolePrefix)

Constructs an Moodle user provider with the needed settings.

Parameters:

pid - The pid of this service.

client - The Moodle web service client.

organization - The organization.

coursePattern - The pattern of a Moodle course ID.

userPattern - The pattern of a Moodle user ID.

groupPattern - The pattern of a Moodle group ID.

groupRoles - Whether to activate groupRoles

cacheSize - The number of users to cache.

cacheExpiration - The number of minutes to cache users.

adminUserName - Name of the global admin user.

contextRolePrefix - Prefix to prepend to context roles like 1234_Learner

Method Details

getCacheHitRatio

public float getCacheHitRatio()

Gets the ratio of cache hits to total requests.

Specified by:

getCacheHitRatio in interface CachingUserProviderMXBean

Returns:

the hit ratio

See Also:

• CachingUserProviderMXBean.getCacheHitRatio()

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)

Discards any cached value for given user name.

Specified by:

invalidate in interface UserProvider

Parameters:

userName - the user name

See Also:

• UserProvider.invalidate(java.lang.String)

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(java.lang.String)

findRoles

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

Return the found roles as an iterator.

We search for COURSEID, COURSEID_Learner, COURSEID_Instructor

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