pl.edu.icm.unity.engine.api

Interface GroupsManagement

public interface GroupsManagement

Internal engine API for groups management.

Author:

K. Benedyczak

Method Summary

Modifier and Type	Method and Description
void	addGroup(pl.edu.icm.unity.types.basic.Group toAdd) Adds a new group
void	addMemberFromParent(String path, pl.edu.icm.unity.types.basic.EntityParam entity) As addMemberFromParent(String, EntityParam, List) with an empty list of attribute classes.
void	addMemberFromParent(String path, pl.edu.icm.unity.types.basic.EntityParam entity, List<pl.edu.icm.unity.types.basic.Attribute> attributes) Adds a new member to the group.
void	addMemberFromParent(String path, pl.edu.icm.unity.types.basic.EntityParam entity, List<pl.edu.icm.unity.types.basic.Attribute> attributes, String idp, String translationProfile) Adds a new member to the group.
Set<String>	getChildGroups(String root)
pl.edu.icm.unity.types.basic.GroupContents	getContents(String path, int filter) Allows to retrieve group's contents and metadata.
List<pl.edu.icm.unity.types.basic.Group>	getGroupsByWildcard(String pathWildcard) Retrieves list of all groups matching a given ant-style wildcard
boolean	isPresent(String group)
void	removeGroup(String path, boolean recursive) Removes a given group.
void	removeMember(String path, pl.edu.icm.unity.types.basic.EntityParam entity) Removes from the group and all subgroups if the user is in any.
void	updateGroup(String path, pl.edu.icm.unity.types.basic.Group group) Updates the group.

Method Detail

isPresent

boolean isPresent(String group)
           throws pl.edu.icm.unity.exceptions.AuthorizationException

Parameters:

group -

Returns:

true if the given group exists

Throws:

pl.edu.icm.unity.exceptions.AuthorizationException

addGroup

void addGroup(pl.edu.icm.unity.types.basic.Group toAdd)
       throws pl.edu.icm.unity.exceptions.EngineException

Adds a new group

Parameters:

toAdd - group to add

Throws:

pl.edu.icm.unity.exceptions.EngineException

removeGroup

void removeGroup(String path,
                 boolean recursive)
          throws pl.edu.icm.unity.exceptions.EngineException

Removes a given group. Doesn't work for '/' path.

Parameters:

path -

recursive -

Throws:

pl.edu.icm.unity.exceptions.EngineException

addMemberFromParent

void addMemberFromParent(String path,
                         pl.edu.icm.unity.types.basic.EntityParam entity,
                         List<pl.edu.icm.unity.types.basic.Attribute> attributes,
                         String idp,
                         String translationProfile)
                  throws pl.edu.icm.unity.exceptions.EngineException

Adds a new member to the group. The entity must be a member of a parent group. This method should be used when adding to a group in effect of remote account mapping.

Parameters:

path -

entity -

attributes - an optional list of attributes to be assigned to the member in this group scope. It is especially useful in the case when group's AttributesClasses require some attributes from all members.

idp - Id of Idp responsible (typically implicitly via translation profile) for addition to the group

translationProfile - name of an input translation profile which created the membership

Throws:

pl.edu.icm.unity.exceptions.EngineException

addMemberFromParent

void addMemberFromParent(String path,
                         pl.edu.icm.unity.types.basic.EntityParam entity,
                         List<pl.edu.icm.unity.types.basic.Attribute> attributes)
                  throws pl.edu.icm.unity.exceptions.EngineException

Adds a new member to the group. The entity must be a member of a parent group. This method must be used when adding to a group manually.

Parameters:

path -

entity -

attributes - an optional list of attributes to be assigned to the member in this group scope. It is especially useful in the case when group's AttributesClasses require some attributes from all members.

Throws:

pl.edu.icm.unity.exceptions.EngineException

addMemberFromParent

void addMemberFromParent(String path,
                         pl.edu.icm.unity.types.basic.EntityParam entity)
                  throws pl.edu.icm.unity.exceptions.EngineException

As addMemberFromParent(String, EntityParam, List) with an empty list of attribute classes.

Throws:

pl.edu.icm.unity.exceptions.EngineException

removeMember

void removeMember(String path,
                  pl.edu.icm.unity.types.basic.EntityParam entity)
           throws pl.edu.icm.unity.exceptions.EngineException

Removes from the group and all subgroups if the user is in any. Entity can not be removed from the group == '/'

Parameters:

path -

entity -

Throws:

pl.edu.icm.unity.exceptions.EngineException

getContents

pl.edu.icm.unity.types.basic.GroupContents getContents(String path,
                                                       int filter)
                                                throws pl.edu.icm.unity.exceptions.EngineException

Allows to retrieve group's contents and metadata.

Parameters:

path - group to be queried.

filter - what should be retrieved. Flags are defined in GroupContents class. Can be OR-ed.

Returns:

Throws:

pl.edu.icm.unity.exceptions.EngineException

getGroupsByWildcard

List<pl.edu.icm.unity.types.basic.Group> getGroupsByWildcard(String pathWildcard)

Retrieves list of all groups matching a given ant-style wildcard

getChildGroups

Set<String> getChildGroups(String root)
                    throws pl.edu.icm.unity.exceptions.EngineException

Parameters:

root -

Returns:

all groups which are children of the root group (including grand children). The root group is also in the returned set.

Throws:

pl.edu.icm.unity.exceptions.EngineException

updateGroup

void updateGroup(String path,
                 pl.edu.icm.unity.types.basic.Group group)
          throws pl.edu.icm.unity.exceptions.EngineException

Updates the group.

Parameters:

path -

group - new group's metadata

Throws:

pl.edu.icm.unity.exceptions.EngineException