public interface GroupsManagement
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.
|
void |
updateGroup(String path,
pl.edu.icm.unity.types.basic.Group group,
String changedProperty,
String newValue)
Updates the group and pass information: changed property and new value.
|
boolean isPresent(String group) throws pl.edu.icm.unity.exceptions.AuthorizationException
group
- pl.edu.icm.unity.exceptions.AuthorizationException
void addGroup(pl.edu.icm.unity.types.basic.Group toAdd) throws pl.edu.icm.unity.exceptions.EngineException
toAdd
- group to addpl.edu.icm.unity.exceptions.EngineException
void removeGroup(String path, boolean recursive) throws pl.edu.icm.unity.exceptions.EngineException
path
- recursive
- pl.edu.icm.unity.exceptions.EngineException
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
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 AttributesClass
es require some attributes
from all members.idp
- Id of Idp responsible (typically implicitly via translation profile) for addition to the grouptranslationProfile
- name of an input translation profile which created the membershippl.edu.icm.unity.exceptions.EngineException
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
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 AttributesClass
es require some attributes
from all members.pl.edu.icm.unity.exceptions.EngineException
void addMemberFromParent(String path, pl.edu.icm.unity.types.basic.EntityParam entity) throws pl.edu.icm.unity.exceptions.EngineException
addMemberFromParent(String, EntityParam, List)
with an empty list of attribute classes.pl.edu.icm.unity.exceptions.EngineException
void removeMember(String path, pl.edu.icm.unity.types.basic.EntityParam entity) throws pl.edu.icm.unity.exceptions.EngineException
path
- entity
- pl.edu.icm.unity.exceptions.EngineException
pl.edu.icm.unity.types.basic.GroupContents getContents(String path, int filter) throws pl.edu.icm.unity.exceptions.EngineException
path
- group to be queried.filter
- what should be retrieved. Flags are defined in GroupContents
class.
Can be OR-ed.pl.edu.icm.unity.exceptions.EngineException
List<pl.edu.icm.unity.types.basic.Group> getGroupsByWildcard(String pathWildcard)
Set<String> getChildGroups(String root) throws pl.edu.icm.unity.exceptions.EngineException
root
- pl.edu.icm.unity.exceptions.EngineException
void updateGroup(String path, pl.edu.icm.unity.types.basic.Group group) throws pl.edu.icm.unity.exceptions.EngineException
path
- group
- new group's metadatapl.edu.icm.unity.exceptions.EngineException
void updateGroup(String path, pl.edu.icm.unity.types.basic.Group group, String changedProperty, String newValue) throws pl.edu.icm.unity.exceptions.EngineException
path
- group
- new group's metadatachangedProperty
- description of changenewValue
- value that was setpl.edu.icm.unity.exceptions.EngineException
Copyright © 2019 Unity. All rights reserved.