oracle.igf.ids

Class GroupManager

java.lang.Object

oracle.igf.ids.AbstractEntityManager

oracle.igf.ids.GroupManager

Direct Known Subclasses:

CustomGroupManager

public class GroupManager
extends AbstractEntityManager

Class for handling operations like read, create and search of group entity

Method Summary

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.

Methods inherited from class oracle.igf.ids.AbstractEntityManager

compareEntityAttr, compareEntityAttr, getAttributeDef, getAttributeRef, getEntityAttributes, getEntityDef, getEntityRelationships, getGlobalCommonIdAttribute, getIdAttribute, modify, modify, modify, rename

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createGroup

public java.security.Principal createGroup(java.util.List<Attribute> attrVals,
                                           CreateOptions opts)
                                    throws IDSException,
                                           EntityAlreadyExistsException,
                                           OperationNotSupportedException,
                                           AuthorizationException,
                                           InvalidAttributesException

Creates group in the repository with given list of attribute values

Parameters:

attrVals - List of attribute values

opts - Create operation options

Returns:

Principal identifier of the gruop created

Throws:

IDSException - Generic Identity Directory Service exception

EntityAlreadyExistsException - When the group to be created already exists

OperationNotSupportedException - If the group create operation is not supported

InvalidAttributesException - When the add attributes list is invalid

AuthorizationException - If user does not have sufficient privileges

getGroup

public Group getGroup(java.security.Principal principal,
                      ReadOptions opts)
               throws EntityNotFoundException,
                      IDSException,
                      AuthorizationException,
                      InvalidAttributesException

Get group for the given principal identifier

Parameters:

principal - Principal identifier of the group

opts - Read operation options

Returns:

Group for the requested principal identifier

Throws:

EntityNotFoundException - When there is no group in the repository for given group principal

IDSException - Generic Identity Directory Service exception

InvalidAttributesException - If the requested attributes is invalid

AuthorizationException - If user does not have sufficient privileges

searchGroup

public Group searchGroup(java.lang.String id,
                         ReadOptions opts)
                  throws IDSException,
                         EntityNotFoundException,
                         EntityNotUniqueException,
                         AuthorizationException,
                         InvalidAttributesException

Search for group matching given id attribute value that uniquely identifies the user

Parameters:

id - Value of the group's id attribute

opts - Read operation options

Returns:

Group matching given ID value

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When there is no group found for given ID value

EntityNotUniqueException - When the given filter condition does not uniquely identify the group

InvalidAttributesException - If the requested attributes is invalid

AuthorizationException - If user does not have sufficient privileges

searchGroup

public Group searchGroup(java.lang.String attrName,
                         java.lang.String attrVal,
                         ReadOptions opts)
                  throws IDSException,
                         EntityNotFoundException,
                         EntityNotUniqueException,
                         InvalidFilterException,
                         AuthorizationException,
                         InvalidAttributesException

Finds group matching given attribute name and value

Parameters:

attrName - Name of the attribute

attrVal - Attribute value

opts - Read operation options

Returns:

Group matching given search filter

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When no group found for given search filter

EntityNotUniqueException - When the given filter condition does not uniquely identify the group

InvalidFilterException - If the attribute is invalid filter attribute

InvalidAttributesException - If the requested attributes is invalid

AuthorizationException - If user does not have sufficient privileges

searchGroupByGuid

public Group searchGroupByGuid(java.lang.String guid,
                               ReadOptions opts)
                        throws IDSException,
                               EntityNotFoundException,
                               EntityNotUniqueException,
                               AuthorizationException,
                               InvalidAttributesException

Search for group matching given GUID value that uniquely identifies the group

Parameters:

guid - guid value of group

opts - Read operation options

Returns:

Group matching given GUID value

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When there is no group found for given GUID value

EntityNotUniqueException - When the given GUID values does not uniquely identify the group

InvalidAttributesException - If the requested attributes is invalid

AuthorizationException - If user does not have sufficient privileges

searchGroups

public ResultSet<Group> searchGroups(SearchFilter filter,
                                     SearchOptions opts)
                              throws IDSException,
                                     InvalidFilterException,
                                     OperationNotSupportedException,
                                     AuthorizationException,
                                     InvalidAttributesException

Searches the repository and returns list of group matching the given filter condition. Pagesize, Sorting and other options can be specified in the search options.

Parameters:

filter - Search filter

opts - Search operation options

Returns:

Search results matching given filter

Throws:

IDSException - Generic Identity Directory Service exception

InvalidFilterException - When the input search filter is not valid

OperationNotSupportedException - When this user search operation is not supported

InvalidAttributesException - When the requested attributes or the attributes in the search filter are invalid

AuthorizationException - If user does not have sufficient privileges

deleteGroup

public void deleteGroup(java.security.Principal principal,
                        DeleteOptions opts)
                 throws EntityNotFoundException,
                        IDSException,
                        AuthorizationException,
                        OperationNotSupportedException

Deletes the group from repository for given user principal

Parameters:

principal - Group principal

opts - Delete operation options

Throws:

EntityNotFoundException - When there is no group in the repository for given group principal

IDSException - Generic Identity Directory Service exception

OperationNotSupportedException - If the group delete operation is not supported

AuthorizationException - If user does not have sufficient privileges

deleteGroup

public void deleteGroup(java.lang.String id,
                        DeleteOptions opts)
                 throws EntityNotFoundException,
                        IDSException,
                        AuthorizationException,
                        OperationNotSupportedException

Deletes the group from repository for given id attribute value

Parameters:

id - id value

opts - Delete operation options

Throws:

EntityNotFoundException - When there is no group in the repository for given id value

IDSException - Generic Identity Directory Service exception

OperationNotSupportedException - If the group delete operation is not supported

AuthorizationException - If user does not have sufficient privileges

deleteGroup

public void deleteGroup(java.lang.String attrName,
                        java.lang.String attrVal,
                        DeleteOptions opts)
                 throws EntityNotFoundException,
                        IDSException,
                        AuthorizationException,
                        OperationNotSupportedException

Deletes the group from repository for given unique attrname and value

Parameters:

attrName - Name of the attribute

attrVal - Attribute value

opts - Delete operation options

Throws:

EntityNotFoundException - When there is no group in the repository for given group principal

IDSException - Generic Identity Directory Service exception

OperationNotSupportedException - If the group delete operation is not supported

AuthorizationException - If user does not have sufficient privileges

getCapabilities

public EntityCapabilities getCapabilities()

Gets Group entity capabilities

Returns:

group entity capabilities