org.ametys.core.group.directory

Interface GroupDirectory

All Known Subinterfaces:

ModifiableGroupDirectory

All Known Implementing Classes:

JdbcGroupDirectory, LdapGroupDirectory

public interface GroupDirectory

Abstraction for a directory of group.

Method Summary

Modifier and Type	Method and Description
Group	getGroup(String groupID) Returns a particular group.
String	getGroupDirectoryModelId() Get the id of the GroupDirectoryModel extension point
Set<Group>	getGroups() Returns all groups.
String	getId() Get the id of the group directory.
I18nizableText	getLabel() Get the label of the group directory.
Map<String,Object>	getParameterValues() Get the values of parameters (from group directory model)
Set<String>	getUserGroups(UserIdentity userIdentity) Get all groups a particular user is in.
Map<String,Object>	group2JSON(String id, boolean withUsers) Get group
List<Map<String,Object>>	groups2JSON(int count, int offset, Map parameters, boolean withUsers) Get groups
void	init(String groupDirectoryModelId, Map<String,Object> paramValues) Initialize the group directory with given parameter values.
void	setId(String id) Set the id of the group directory.
void	setLabel(I18nizableText label) Set the label of the group directory.

Method Detail

getId

String getId()

Get the id of the group directory.

Returns:

The id of the group directory

getLabel

I18nizableText getLabel()

Get the label of the group directory.

Returns:

The label of the group directory

setId

void setId(String id)

Set the id of the group directory.

Parameters:

id - The id

setLabel

void setLabel(I18nizableText label)

Set the label of the group directory.

Parameters:

label - The label

getGroupDirectoryModelId

String getGroupDirectoryModelId()

Get the id of the GroupDirectoryModel extension point

Returns:

the id of extension point

getParameterValues

Map<String,Object> getParameterValues()

Get the values of parameters (from group directory model)

Returns:

the parameters' values

init

void init(String groupDirectoryModelId,
          Map<String,Object> paramValues)
   throws Exception

Initialize the group directory with given parameter values.

Parameters:

groupDirectoryModelId - The id of group directory extension point

paramValues - The parameters' values

Throws:

Exception - If an error occured

getGroup

Group getGroup(String groupID)

Returns a particular group.

Parameters:

groupID - The id of the group.

Returns:

The group or null if the group does not exist.

getGroups

Set<Group> getGroups()

Returns all groups.

Returns:

The groups as a Set of UserGroup, empty if an error occurs.

getUserGroups

Set<String> getUserGroups(UserIdentity userIdentity)

Get all groups a particular user is in.

Parameters:

userIdentity - The identity of the user

Returns:

The groups as a Set of String (group ID), empty if the login does not match.

groups2JSON

List<Map<String,Object>> groups2JSON(int count,
                                     int offset,
                                     Map parameters,
                                     boolean withUsers)

Get groups

Parameters:

count - The maximum number of groups to sax. (-1 to sax all)

offset - The offset to start with, first is 0.

parameters - Parameters for saxing user list differently, see implementation.

withUsers - true to also have the users of the groups

Returns:

The matching groups as a json object

group2JSON

Map<String,Object> group2JSON(String id,
                              boolean withUsers)

Get group

Parameters:

id - The group's id

withUsers - true to also have the users of the group

Returns:

The matching group as a json object