Package org.ametys.core.group

Class GroupManager

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.group.GroupManager

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class GroupManager
extends AbstractLogEnabled
implements Component, Serviceable

Component for getting group list.

Field Summary

Fields

Modifier and Type	Field	Description
protected GroupDirectoryContextHelper	_directoryContextHelper	The helper for the associations group directory/context
protected GroupDirectoryDAO	_groupDirectoryDAO	The DAO for group directories
static String	ROLE	Avalon Role

Constructor Summary

Constructors

Constructor	Description
GroupManager()

Method Summary

Modifier and Type	Method	Description
Group	getGroup(String groupDirectoryId, String groupId)	Get a particular group of the given GroupDirectory by its id
Group	getGroup(GroupDirectory groupDirectory, String groupId)	Get a particular group of the given GroupDirectory by its id
Group	getGroup(GroupIdentity groupIdentity)	Get a particular group of the given GroupDirectory by its id
Group	getGroupByContext(String context, String groupId)	Get a particular group on a given context
Set<Group>	getGroups(String groupDirectoryId)	Get all the groups of a given GroupDirectory
Set<Group>	getGroups(GroupDirectory groupDirectory)	Get all the groups of a given GroupDirectory
Set<Group>	getGroupsByContext(String context)	Get all the groups on a given context
Set<String>	getUserGroups(String groupDirectoryId, UserIdentity userIdentity)	Get all the groups of a GroupDirectory the given user is in
Set<String>	getUserGroups(GroupDirectory groupDirectory, UserIdentity userIdentity)	Get all the groups of a GroupDirectory the given user is in
Set<GroupIdentity>	getUserGroups(UserIdentity userIdentity)	Get all the groups the given user is in
void	service(ServiceManager manager)

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Detail

ROLE

public static final String ROLE

Avalon Role

_groupDirectoryDAO

protected GroupDirectoryDAO _groupDirectoryDAO

The DAO for group directories

_directoryContextHelper

protected GroupDirectoryContextHelper _directoryContextHelper

The helper for the associations group directory/context

Constructor Detail

GroupManager

public GroupManager()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getGroup

public Group getGroup(GroupIdentity groupIdentity)

Get a particular group of the given GroupDirectory by its id

Parameters:

groupIdentity - The group identity

Returns:

The group or null if not found

getGroup

public Group getGroup(GroupDirectory groupDirectory,
                      String groupId)

Get a particular group of the given GroupDirectory by its id

Parameters:

groupDirectory - The group directory

groupId - The id of the group

Returns:

The group or null if not found

getGroup

public Group getGroup(String groupDirectoryId,
                      String groupId)

Get a particular group of the given GroupDirectory by its id

Parameters:

groupDirectoryId - The id of the group directory

groupId - The id of the group

Returns:

The group or null if not found

getGroupByContext

public Group getGroupByContext(String context,
                               String groupId)

Get a particular group on a given context

Parameters:

context - The context

groupId - The id of the group

Returns:

The group or null if not found

getGroups

public Set<Group> getGroups(GroupDirectory groupDirectory)

Get all the groups of a given GroupDirectory

Parameters:

groupDirectory - The group directory

Returns:

The set of groups of the group directory

getGroups

public Set<Group> getGroups(String groupDirectoryId)

Get all the groups of a given GroupDirectory

Parameters:

groupDirectoryId - The id of the group directory

Returns:

The set of groups of the group directory

getGroupsByContext

public Set<Group> getGroupsByContext(String context)

Get all the groups on a given context

Parameters:

context - The context

Returns:

The set of groups

getUserGroups

public Set<GroupIdentity> getUserGroups(UserIdentity userIdentity)

Get all the groups the given user is in

Parameters:

userIdentity - The user identity.

Returns:

The set of groups the user is in

getUserGroups

public Set<String> getUserGroups(GroupDirectory groupDirectory,
                                 UserIdentity userIdentity)

Get all the groups of a GroupDirectory the given user is in

Parameters:

groupDirectory - The group directory

userIdentity - The user identity.

Returns:

A set of groups the user is in

getUserGroups

public Set<String> getUserGroups(String groupDirectoryId,
                                 UserIdentity userIdentity)

Get all the groups of a GroupDirectory the given user is in

Parameters:

groupDirectoryId - The id of the group directory

userIdentity - The user identity.

Returns:

A set of groups the user is in