public class GroupManager extends AbstractEntityManager
Modifier and Type | Method and Description |
---|---|
java.security.Principal |
createGroup(java.util.List<Attribute> attrVals, CreateOptions opts)
Creates group in the repository with given list of attribute values
|
void |
deleteGroup(java.security.Principal principal, DeleteOptions opts)
Deletes the group from repository for given user principal
|
void |
deleteGroup(java.lang.String id, DeleteOptions opts)
Deletes the group from repository for given id attribute value
|
void |
deleteGroup(java.lang.String attrName, java.lang.String attrVal, DeleteOptions opts)
Deletes the group from repository for given unique attrname and value
|
EntityCapabilities |
getCapabilities()
Gets Group entity capabilities
|
Group |
getGroup(java.security.Principal principal, ReadOptions opts)
Get group for the given principal identifier
|
Group |
searchGroup(java.lang.String id, ReadOptions opts)
Search for group matching given id attribute value that uniquely identifies the user
|
Group |
searchGroup(java.lang.String attrName, java.lang.String attrVal, ReadOptions opts)
Finds group matching given attribute name and value
|
Group |
searchGroupByGuid(java.lang.String guid, ReadOptions opts)
Search for group matching given GUID value that uniquely identifies the group
|
ResultSet<Group> |
searchGroups(SearchFilter filter, SearchOptions opts)
Searches the repository and returns list of group matching the given filter condition.
|
compareEntityAttr, compareEntityAttr, getAttributeDef, getAttributeRef, getEntityAttributes, getEntityDef, getEntityRelationships, getGlobalCommonIdAttribute, getIdAttribute, modify, modify, modify, rename
public java.security.Principal createGroup(java.util.List<Attribute> attrVals, CreateOptions opts) throws IDSException, EntityAlreadyExistsException, OperationNotSupportedException, AuthorizationException, InvalidAttributesException
attrVals
- List of attribute valuesopts
- Create operation optionsIDSException
- Generic Identity Directory Service exceptionEntityAlreadyExistsException
- When the group to be created already existsOperationNotSupportedException
- If the group create operation is not supportedInvalidAttributesException
- When the add attributes list is invalidAuthorizationException
- If user does not have sufficient privilegespublic Group getGroup(java.security.Principal principal, ReadOptions opts) throws EntityNotFoundException, IDSException, AuthorizationException, InvalidAttributesException
principal
- Principal identifier of the groupopts
- Read operation optionsEntityNotFoundException
- When there is no group in the repository for given group principalIDSException
- Generic Identity Directory Service exceptionInvalidAttributesException
- If the requested attributes is invalidAuthorizationException
- If user does not have sufficient privilegespublic Group searchGroup(java.lang.String id, ReadOptions opts) throws IDSException, EntityNotFoundException, EntityNotUniqueException, AuthorizationException, InvalidAttributesException
id
- Value of the group's id attributeopts
- Read operation optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- When there is no group found for given ID valueEntityNotUniqueException
- When the given filter condition does not uniquely identify the groupInvalidAttributesException
- If the requested attributes is invalidAuthorizationException
- If user does not have sufficient privilegespublic Group searchGroup(java.lang.String attrName, java.lang.String attrVal, ReadOptions opts) throws IDSException, EntityNotFoundException, EntityNotUniqueException, InvalidFilterException, AuthorizationException, InvalidAttributesException
attrName
- Name of the attributeattrVal
- Attribute valueopts
- Read operation optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- When no group found for given search filterEntityNotUniqueException
- When the given filter condition does not uniquely identify the groupInvalidFilterException
- If the attribute is invalid filter attributeInvalidAttributesException
- If the requested attributes is invalidAuthorizationException
- If user does not have sufficient privilegespublic Group searchGroupByGuid(java.lang.String guid, ReadOptions opts) throws IDSException, EntityNotFoundException, EntityNotUniqueException, AuthorizationException, InvalidAttributesException
guid
- guid value of groupopts
- Read operation optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- When there is no group found for given GUID valueEntityNotUniqueException
- When the given GUID values does not uniquely identify the groupInvalidAttributesException
- If the requested attributes is invalidAuthorizationException
- If user does not have sufficient privilegespublic ResultSet<Group> searchGroups(SearchFilter filter, SearchOptions opts) throws IDSException, InvalidFilterException, OperationNotSupportedException, AuthorizationException, InvalidAttributesException
filter
- Search filteropts
- Search operation optionsIDSException
- Generic Identity Directory Service exceptionInvalidFilterException
- When the input search filter is not validOperationNotSupportedException
- When this user search operation is not supportedInvalidAttributesException
- When the requested attributes or the attributes in the search filter are invalidAuthorizationException
- If user does not have sufficient privilegespublic void deleteGroup(java.security.Principal principal, DeleteOptions opts) throws EntityNotFoundException, IDSException, AuthorizationException, OperationNotSupportedException
principal
- Group principalopts
- Delete operation optionsEntityNotFoundException
- When there is no group in the repository for given group principalIDSException
- Generic Identity Directory Service exceptionOperationNotSupportedException
- If the group delete operation is not supportedAuthorizationException
- If user does not have sufficient privilegespublic void deleteGroup(java.lang.String id, DeleteOptions opts) throws EntityNotFoundException, IDSException, AuthorizationException, OperationNotSupportedException
id
- id valueopts
- Delete operation optionsEntityNotFoundException
- When there is no group in the repository for given id valueIDSException
- Generic Identity Directory Service exceptionOperationNotSupportedException
- If the group delete operation is not supportedAuthorizationException
- If user does not have sufficient privilegespublic void deleteGroup(java.lang.String attrName, java.lang.String attrVal, DeleteOptions opts) throws EntityNotFoundException, IDSException, AuthorizationException, OperationNotSupportedException
attrName
- Name of the attributeattrVal
- Attribute valueopts
- Delete operation optionsEntityNotFoundException
- When there is no group in the repository for given group principalIDSException
- Generic Identity Directory Service exceptionOperationNotSupportedException
- If the group delete operation is not supportedAuthorizationException
- If user does not have sufficient privilegespublic EntityCapabilities getCapabilities()