Package org.opencastproject.external.userdirectory

Class ExternalApiRoleProvider

java.lang.Object

org.opencastproject.external.userdirectory.ExternalApiRoleProvider

All Implemented Interfaces:

RoleProvider

public class ExternalApiRoleProvider
extends Object
implements RoleProvider

The External API role provider.

Field Summary

Fields

Modifier and Type	Field	Description
protected SecurityService	securityService	The security service

Constructor Summary

Constructors

Constructor	Description
ExternalApiRoleProvider()

Method Summary

Modifier and Type	Method	Description
protected void	activate(org.osgi.service.component.ComponentContext cc)
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

securityService

protected SecurityService securityService

The security service

Constructor Details

ExternalApiRoleProvider

public ExternalApiRoleProvider()

Method Details

setSecurityService

public void setSecurityService(SecurityService securityService)

Parameters:

securityService - the securityService to set

activate

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

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)

getOrganization

public String getOrganization()

Description copied from interface: RoleProvider

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:

• RoleProvider.getOrganization()

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)