Package org.ametys.plugins.core.group

Class GroupDAO

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.plugins.core.group.GroupDAO

All Implemented Interfaces:

Component, LogEnabled, Serviceable

public class GroupDAO
extends AbstractLogEnabled
implements Serviceable, Component

DAO for manipulating Group

Field Summary

Fields

Modifier and Type	Field	Description
protected CurrentUserProvider	_currentUserProvider	The current user provider.
protected GroupDirectoryDAO	_groupDirectoryDAO	The DAO for group directories
protected GroupManager	_groupManager	The group manager
protected ServiceManager	_smanager	The service manager
protected UserHelper	_userHelper	The user helper

Constructor Summary

Constructors

Constructor	Description
GroupDAO()

Method Summary

Modifier and Type	Method	Description
protected UserIdentity	_getCurrentUser()	Provides the current user.
Map<String,Object>	addGroup(String groupDirectoryId, String name)	Creates a new group
Map<String,Object>	addUsersGroup(String groupDirectoryId, String groupId, List<Map<String,String>> users)	Add users to group
void	deleteGroups(String groupDirectoryId, List<String> groupIds)	Deletes groups
Map<String,Object>	getGroup(String groupDirectoryId, String id)	Get group's information
List<Map<String,Object>>	getUsersGroup(Map<String,String> user)	Get the list of groups of a user
protected Map<String,Object>	group2Json(Group group)	Get the JSON representation of a group
boolean	isModifiable(String groupDirectoryId, String id)	Checks if the group is modifiable
Map<String,Object>	removeUsersGroup(String groupDirectoryId, String groupId, List<Map<String,String>> users)	Remove users from group
Map<String,Object>	renameGroup(String groupDirectoryId, String groupId, String name)	Renames a group
void	service(ServiceManager smanager)
Map<String,Object>	setUsersGroup(String groupDirectoryId, String groupId, List<Map<String,String>> users)	Set the users' group

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Detail

_smanager

protected ServiceManager _smanager

The service manager

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider.

_groupManager

protected GroupManager _groupManager

The group manager

_groupDirectoryDAO

protected GroupDirectoryDAO _groupDirectoryDAO

The DAO for group directories

_userHelper

protected UserHelper _userHelper

The user helper

Constructor Detail

GroupDAO

public GroupDAO()

Method Detail

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

addGroup

public Map<String,Object> addGroup(String groupDirectoryId,
                                         String name)
                                  throws InvalidModificationException

Creates a new group

Parameters:

groupDirectoryId - The id of the group directory

name - The group's name

Returns:

The group's information

Throws:

InvalidModificationException - If modification are not possible

setUsersGroup

public Map<String,Object> setUsersGroup(String groupDirectoryId,
                                              String groupId,
                                              List<Map<String,String>> users)
                                       throws InvalidModificationException

Set the users' group

Parameters:

groupDirectoryId - The id of the group directory

groupId - The group's id

users - The group's users

Returns:

The group's information

Throws:

InvalidModificationException - If modification are not possible

addUsersGroup

public Map<String,Object> addUsersGroup(String groupDirectoryId,
                                              String groupId,
                                              List<Map<String,String>> users)
                                       throws InvalidModificationException

Add users to group

Parameters:

groupDirectoryId - The id of the group directory

groupId - The group's id

users - The users to add

Returns:

The group's information

Throws:

InvalidModificationException - If modification are not possible

removeUsersGroup

public Map<String,Object> removeUsersGroup(String groupDirectoryId,
                                                 String groupId,
                                                 List<Map<String,String>> users)
                                          throws InvalidModificationException

Remove users from group

Parameters:

groupDirectoryId - The id of the group directory

groupId - The group's id

users - The users to add

Returns:

The group's information

Throws:

InvalidModificationException - If modification are not possible

getUsersGroup

public List<Map<String,Object>> getUsersGroup(Map<String,String> user)

Get the list of groups of a user

Parameters:

user - The user (using the format of UserHelper.json2userIdentity(Map)

Returns:

The list of groups information

renameGroup

public Map<String,Object> renameGroup(String groupDirectoryId,
                                            String groupId,
                                            String name)
                                     throws InvalidModificationException

Renames a group

Parameters:

groupDirectoryId - The id of the group directory

groupId - The group'sid

name - The new name

Returns:

The group's information

Throws:

InvalidModificationException - If modification are not possible

deleteGroups

public void deleteGroups(String groupDirectoryId,
                         List<String> groupIds)
                  throws InvalidModificationException

Deletes groups

Parameters:

groupDirectoryId - The id of the group directory

groupIds - The ids of groups to delete

Throws:

InvalidModificationException - If modification are not possible

getGroup

public Map<String,Object> getGroup(String groupDirectoryId,
                                         String id)

Get group's information

Parameters:

groupDirectoryId - The id of the group directory

id - the group id

Returns:

group's information

isModifiable

public boolean isModifiable(String groupDirectoryId,
                            String id)

Checks if the group is modifiable

Parameters:

groupDirectoryId - The id of the group directory

id - The group id

Returns:

True if the group is modifiable

group2Json

protected Map<String,Object> group2Json(Group group)

Get the JSON representation of a group

Parameters:

group - The group

Returns:

The group

_getCurrentUser

protected UserIdentity _getCurrentUser()

Provides the current user.

Returns:

the user which cannot be null.