Package org.opencastproject.userdirectory

Class JpaUserReferenceProvider

java.lang.Object

org.opencastproject.userdirectory.JpaUserReferenceProvider

All Implemented Interfaces:

RoleProvider, UserProvider, UserReferenceProvider

public class JpaUserReferenceProvider
extends Object
implements UserReferenceProvider, UserProvider, RoleProvider

Manages and locates users references using JPA.

Field Summary

Fields

Modifier and Type	Field	Description
protected DBSession	db
protected DBSessionFactory	dbSessionFactory
protected javax.persistence.EntityManagerFactory	emf	The factory used to generate the entity manager
static final String	ENCODING	Encoding expected from all inputs
protected JpaGroupRoleProvider	groupRoleProvider	Group Role provider
protected final Object	nullToken	A token to store in the miss cache
static final String	PROVIDER_NAME
protected AAIRoleProvider	roleProvider	Role provider
static final String	ROLES	Role constant used in JSON formatted users
protected SecurityService	securityService	The security service
static final String	USERNAME	Username constant used in JSON formatted users

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

ALL_ORGANIZATIONS

Constructor Summary

Constructors

Constructor	Description
JpaUserReferenceProvider()

Method Summary

Modifier and Type	Method	Description
void	activate(org.osgi.service.component.ComponentContext cc)	Callback for activation of this component.
void	addUserReference(JpaUserReference user, String mechanism)	Add a user reference
long	countUsers()	Returns the number of users in the provider
void	deleteUser(String username, String orgId)	Delete the given user
Iterator<Role>	findRoles(String query, Role.Target target, int offset, int limit)	Return the found roles as an iterator.
JpaUserReference	findUserReference(String userName, String organizationId)	Returns the persisted user reference by the user name and organization id
Iterator<User>	findUsers(String query, int offset, int limit)	Return the found user's as an iterator.
Iterator<User>	findUsers(Collection<String> userNames)	Find a list of users by their user names Note that the default implementation of this might be slow, as it calls loadUser on every single user.
String	getName()	Gets the provider name
String	getOrganization()	Returns the identifier for the organization that is associated with this user provider.
Iterator<Role>	getRoles()	Return the roles
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)	Load a user by userName
void	setDBSessionFactory(DBSessionFactory dbSessionFactory)
void	setGroupRoleProvider(JpaGroupRoleProvider groupRoleProvider)
void	setRoleProvider(RoleProvider roleProvider)	Set an optional roleProvider that takes care about resolving roles
void	setSecurityService(SecurityService securityService)
String	toString()
void	updateUserReference(JpaUserReference user)	Update an existing user reference

Methods inherited from class java.lang.Object

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

Field Details

PROVIDER_NAME

public static final String PROVIDER_NAME

See Also:

• Constant Field Values

USERNAME

public static final String USERNAME

Username constant used in JSON formatted users

See Also:

• Constant Field Values

ROLES

public static final String ROLES

Role constant used in JSON formatted users

See Also:

• Constant Field Values

ENCODING

public static final String ENCODING

Encoding expected from all inputs

See Also:

• Constant Field Values

securityService

protected SecurityService securityService

The security service

groupRoleProvider

protected JpaGroupRoleProvider groupRoleProvider

Group Role provider

roleProvider

protected AAIRoleProvider roleProvider

Role provider

nullToken

protected final Object nullToken

A token to store in the miss cache

emf

protected javax.persistence.EntityManagerFactory emf

The factory used to generate the entity manager

dbSessionFactory

protected DBSessionFactory dbSessionFactory

db

protected DBSession db

Constructor Details

JpaUserReferenceProvider

public JpaUserReferenceProvider()

Method Details

setDBSessionFactory

public void setDBSessionFactory(DBSessionFactory dbSessionFactory)

setSecurityService

public void setSecurityService(SecurityService securityService)

Parameters:

securityService - the securityService to set

setGroupRoleProvider

public void setGroupRoleProvider(JpaGroupRoleProvider groupRoleProvider)

Parameters:

groupRoleProvider - the GroupRoleProvider to set

activate

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

Callback for activation of this component.

Parameters:

cc - the component context

getName

public String getName()

Description copied from interface: UserProvider

Gets the provider name

Specified by:

getName in interface UserProvider

Returns:

the provider name

toString

public String toString()

Overrides:

toString in class Object

See Also:

• Object.toString()

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)

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(String, int, int)

findUsers

public Iterator<User> findUsers(Collection<String> userNames)

Description copied from interface: UserProvider

Find a list of users by their user names Note that the default implementation of this might be slow, as it calls loadUser on every single user.

Specified by:

findUsers in interface UserProvider

Parameters:

userNames - A list of user names

Returns:

A list of resolved user objects

findRoles

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

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)

loadUser

public User loadUser(String userName)

Load a user by userName

Specified by:

loadUser in interface UserProvider

Specified by:

loadUser in interface UserReferenceProvider

Parameters:

userName -

Returns:

the user or null if not found

See Also:

• UserProvider.loadUser(java.lang.String)

getUsers

public Iterator<User> getUsers()

Description copied from interface: UserProvider

Gets all known users.

Specified by:

getUsers in interface UserProvider

Returns:

the users

getRoles

public Iterator<Role> getRoles()

Return the roles

Returns:

the roles

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

addUserReference

public void addUserReference(JpaUserReference user,
 String mechanism)

Add a user reference

Specified by:

addUserReference in interface UserReferenceProvider

Parameters:

user - the user reference to be added

mechanism - the mechanism that adds the user reference

updateUserReference

public void updateUserReference(JpaUserReference user)

Update an existing user reference

Specified by:

updateUserReference in interface UserReferenceProvider

Parameters:

user - the user reference to be updated

findUserReference

public JpaUserReference findUserReference(String userName,
 String organizationId)

Returns the persisted user reference by the user name and organization id

Specified by:

findUserReference in interface UserReferenceProvider

Parameters:

userName - the user name

organizationId - the organization id

Returns:

the user or null if not found

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

deleteUser

public void deleteUser(String username,
 String orgId)
                throws NotFoundException,
UnauthorizedException,
Exception

Delete the given user

Parameters:

username - the name of the user to delete

orgId - the organization id

Throws:

NotFoundException - if the requested user is not exist

UnauthorizedException - if you havn't permissions to delete an admin user (only admins may do that)

Exception

setRoleProvider

public void setRoleProvider(RoleProvider roleProvider)

Description copied from interface: UserReferenceProvider

Set an optional roleProvider that takes care about resolving roles

Specified by:

setRoleProvider in interface UserReferenceProvider

Parameters:

roleProvider -