Package org.opencastproject.userdirectory

Class JpaGroupRoleProvider

java.lang.Object

org.opencastproject.userdirectory.JpaGroupRoleProvider

All Implemented Interfaces:

GroupProvider, RoleProvider, AAIRoleProvider, GroupRoleProvider

public class JpaGroupRoleProvider
extends Object
implements AAIRoleProvider, GroupProvider, GroupRoleProvider

Manages and locates users 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
protected OrganizationDirectoryService	organizationDirectoryService	The organization directory service
static final String	PERSISTENCE_UNIT	The JPA persistence unit name
protected SecurityService	securityService	The security service
protected UserDirectoryService	userDirectoryService	The user directory service

Constructor Summary

Constructors

Constructor	Description
JpaGroupRoleProvider()

Method Summary

Modifier and Type	Method	Description
void	activate(org.osgi.service.component.ComponentContext cc)	Callback for activation of this component.
void	addGroup(JpaGroup group)	Adds or updates a group to the persistence.
boolean	addMemberToGroup(String groupId, String member)	Add member to group.
long	countTotalGroups(Optional<String> nameFilter, Optional<String> roleFilter, Optional<String> textFilter)	Count groups that fit the filter criteria in total.
void	createGroup(String name, String description, String roles, String users)	Create a new group
Iterator<Role>	findRoles(String query, Role.Target target, int offset, int limit)	Return the found roles as an iterator.
JpaGroup	getGroup(String groupId)	Get group.
Iterator<Group>	getGroups()	Getting all groups
JaxbGroupList	getGroups(int limit, int offset)	Returns a XML representation of the list of groups available the current user's organization.
List<JpaGroup>	getGroups(Optional<Integer> limit, Optional<Integer> offset, Optional<String> nameFilter, Optional<String> roleFilter, Optional<String> textFilter, ArrayList<SortCriterion> sortCriteria)	Get groups by the defined filter and sorting criteria.
String	getOrganization()	Returns the identifier for the organization that is defining this set of roles.
Iterator<Role>	getRoles()	Return the roles
List<Role>	getRolesForGroup(String groupName)	Returns the roles for this group or an empty array if no roles are applicable.
List<Role>	getRolesForUser(String userName)	Returns the roles for this user or an empty array if no roles are applicable.
JpaGroup	loadGroup(String groupId, String orgId)	Loads a group from persistence
void	removeGroup(String groupId)	Remove a group by id
void	removeMemberFromAllGroups(String userName, String orgId)	Removes a user from all groups
boolean	removeMemberFromGroup(String groupId, String member)	Remove member from group.
void	setDBSessionFactory(DBSessionFactory dbSessionFactory)
void	setEntityManagerFactory(javax.persistence.EntityManagerFactory emf)	OSGi DI
void	setOrganizationDirectoryService(OrganizationDirectoryService organizationDirectoryService)
void	setSecurityService(SecurityService securityService)
void	setUserDirectoryService(UserDirectoryService userDirectoryService)	Sets the user directory service
void	updateGroup(String groupId, String name, String description, String roles, String users)	Update a group
void	updateGroupMembershipFromRoles(String userName, String orgId, List<String> roleList)	Updates a user's group membership
void	updateGroupMembershipFromRoles(String userName, String orgId, List<String> roleList, String prefix)	Updates a user's group membership

Methods inherited from class java.lang.Object

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

Field Details

PERSISTENCE_UNIT

public static final String PERSISTENCE_UNIT

The JPA persistence unit name

See Also:

• Constant Field Values

securityService

protected SecurityService securityService

The security service

emf

protected javax.persistence.EntityManagerFactory emf

The factory used to generate the entity manager

dbSessionFactory

protected DBSessionFactory dbSessionFactory

db

protected DBSession db

organizationDirectoryService

protected OrganizationDirectoryService organizationDirectoryService

The organization directory service

userDirectoryService

protected UserDirectoryService userDirectoryService

The user directory service

Constructor Details

JpaGroupRoleProvider

public JpaGroupRoleProvider()

Method Details

setEntityManagerFactory

public void setEntityManagerFactory(javax.persistence.EntityManagerFactory emf)

OSGi DI

setDBSessionFactory

public void setDBSessionFactory(DBSessionFactory dbSessionFactory)

setUserDirectoryService

public void setUserDirectoryService(UserDirectoryService userDirectoryService)

Sets the user directory service

Parameters:

userDirectoryService - the userDirectoryService to set

setSecurityService

public void setSecurityService(SecurityService securityService)

Parameters:

securityService - the securityService to set

setOrganizationDirectoryService

public void setOrganizationDirectoryService(OrganizationDirectoryService organizationDirectoryService)

Parameters:

organizationDirectoryService - the organizationDirectoryService to set

activate

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

Callback for activation of this component.

Parameters:

cc - the component context

getRoles

public Iterator<Role> getRoles()

Return the roles

Specified by:

getRoles in interface AAIRoleProvider

Returns:

the roles

See Also:

• AAIRoleProvider.getRoles()

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 GroupRoleProvider

Specified by:

getRolesForUser in interface RoleProvider

Parameters:

userName - the user id

Returns:

the set of roles

See Also:

• RoleProvider.getRolesForUser(String)

getRolesForGroup

public List<Role> getRolesForGroup(String groupName)

Returns the roles for this group or an empty array if no roles are applicable.

Specified by:

getRolesForGroup in interface GroupProvider

Specified by:

getRolesForGroup in interface GroupRoleProvider

Parameters:

groupName - the group id

Returns:

the set of roles

See Also:

• RoleProvider.getRolesForUser(String)

getOrganization

public String getOrganization()

Returns the identifier for the organization that is defining this set of roles.

Specified by:

getOrganization in interface GroupRoleProvider

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)

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)

updateGroupMembershipFromRoles

public void updateGroupMembershipFromRoles(String userName,
 String orgId,
 List<String> roleList)

Updates a user's group membership

Specified by:

updateGroupMembershipFromRoles in interface GroupRoleProvider

Parameters:

userName - the username

orgId - the user's organization

roleList - the list of group role names

updateGroupMembershipFromRoles

public void updateGroupMembershipFromRoles(String userName,
 String orgId,
 List<String> roleList,
 String prefix)

Updates a user's group membership

Parameters:

userName - the username

orgId - the user's organization

roleList - the list of group role names

prefix - handle only roles with given prefix

removeMemberFromAllGroups

public void removeMemberFromAllGroups(String userName,
 String orgId)

Removes a user from all groups

Parameters:

userName - the username

orgId - the user's organization

loadGroup

public JpaGroup loadGroup(String groupId,
 String orgId)

Loads a group from persistence

Parameters:

groupId - the group id

orgId - the organization id

Returns:

the loaded group or null if not found

getGroup

public JpaGroup getGroup(String groupId)

Get group.

Parameters:

groupId -

Returns:

the group

addGroup

public void addGroup(JpaGroup group)
              throws UnauthorizedException

Adds or updates a group to the persistence.

Specified by:

addGroup in interface GroupRoleProvider

Parameters:

group - the group to add

Throws:

UnauthorizedException

getGroups

public Iterator<Group> getGroups()

Description copied from interface: GroupRoleProvider

Getting all groups

Specified by:

getGroups in interface GroupRoleProvider

Returns:

Iterator<Group> persisted groups

getGroups

public JaxbGroupList getGroups(int limit,
 int offset)
                        throws IOException

Returns a XML representation of the list of groups available the current user's organization.

Parameters:

limit - the int amount to limit the results

offset - the offset to start this result set at

Returns:

the JaxbGroupList of results

Throws:

IOException - if unexpected IO exception occurs

getGroups

public List<JpaGroup> getGroups(Optional<Integer> limit,
 Optional<Integer> offset,
 Optional<String> nameFilter,
 Optional<String> roleFilter,
 Optional<String> textFilter,
 ArrayList<SortCriterion> sortCriteria)

Get groups by the defined filter and sorting criteria.

Parameters:

limit - how many groups to get (optional)

offset - where to start the list for pagination (optional)

nameFilter - filter by group name (optional)

textFilter - fulltext filter (optional)

sortCriteria - the sorting criteria

Returns:

a list of groups

countTotalGroups

public long countTotalGroups(Optional<String> nameFilter,
 Optional<String> roleFilter,
 Optional<String> textFilter)

Count groups that fit the filter criteria in total.

Parameters:

nameFilter - filter by group name (optional)

textFilter - fulltext filter (optional)

Returns:

a list of groups

removeGroup

public void removeGroup(String groupId)
                 throws NotFoundException,
UnauthorizedException,
Exception

Remove a group by id

Parameters:

groupId - the id of the group to remove

Throws:

Exception - unexpected error occurred

UnauthorizedException - user is not authorized to remove this group

NotFoundException - the group was not found

createGroup

public void createGroup(String name,
 String description,
 String roles,
 String users)
                 throws IllegalArgumentException,
UnauthorizedException,
ConflictException

Create a new group

Parameters:

name - the name of the group

description - a description of the group

roles - the roles of the group

users - the users in the group

Throws:

IllegalArgumentException - if missing or bad parameters

UnauthorizedException - if user does not have rights to create group

ConflictException - if group already exists

removeMemberFromGroup

public boolean removeMemberFromGroup(String groupId,
 String member)
                              throws NotFoundException,
UnauthorizedException

Remove member from group.

Parameters:

groupId -

member -

Returns:

true if we updated the group, false otherwise

Throws:

NotFoundException

UnauthorizedException

addMemberToGroup

public boolean addMemberToGroup(String groupId,
 String member)
                         throws NotFoundException,
UnauthorizedException

Add member to group.

Parameters:

groupId -

member -

Returns:

true if we updated the group, false otherwise

Throws:

NotFoundException

UnauthorizedException

updateGroup

public void updateGroup(String groupId,
 String name,
 String description,
 String roles,
 String users)
                 throws NotFoundException,
UnauthorizedException

Update a group

Specified by:

updateGroup in interface GroupRoleProvider

Parameters:

groupId - the id of the group to update

name - the name to update

description - the description to update

roles - the roles to update

users - the users to update

Throws:

NotFoundException - if the group is not found

UnauthorizedException - if the user does not have rights to update the group

See Also:

• GroupRoleProvider.updateGroup(String, String, String, String, String)