Package org.ametys.core.group.directory
Interface GroupDirectory
- All Known Subinterfaces:
ModifiableGroupDirectory
- All Known Implementing Classes:
JdbcGroupDirectory
,LdapGroupDirectory
,StaticGroupDirectory
public interface GroupDirectory
Abstraction for a directory of group.
-
Method Summary
Modifier and TypeMethodDescriptionReturns a particular group.Get the id of theGroupDirectoryModel
extension pointReturns all groups.Get groupsgetId()
Get the id of the group directory.getLabel()
Get the label of the group directory.Get the values of parameters (from group directory model)getUserGroups
(UserIdentity userIdentity) Get all groups a particular user is in.void
Initialize the group directory with given parameter values.void
Set the id of the group directory.void
setLabel
(I18nizableText label) Set the label of the group directory.
-
Method Details
-
getId
Get the id of the group directory.- Returns:
- The id of the group directory
-
getLabel
Get the label of the group directory.- Returns:
- The label of the group directory
-
setId
Set the id of the group directory.- Parameters:
id
- The id
-
setLabel
Set the label of the group directory.- Parameters:
label
- The label
-
getGroupDirectoryModelId
Get the id of theGroupDirectoryModel
extension point- Returns:
- the id of extension point
-
getParameterValues
Get the values of parameters (from group directory model)- Returns:
- the parameters' values
-
init
Initialize the group directory with given parameter values.- Parameters:
groupDirectoryModelId
- The id of group directory extension pointparamValues
- The parameters' values- Throws:
Exception
- If an error occured
-
getGroup
Returns a particular group.- Parameters:
groupID
- The id of the group.- Returns:
- The group or null if the group does not exist.
-
getGroups
Returns all groups.- Returns:
- The groups as a Set of UserGroup, empty if an error occurs.
-
getUserGroups
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.
-
getGroups
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.- Returns:
- The matching groups
-