oracle.igf.ids

Class EntityManager

java.lang.Object

oracle.igf.ids.AbstractEntityManager

oracle.igf.ids.EntityManager

Direct Known Subclasses:

AppRoleManager

public class EntityManager
extends AbstractEntityManager

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

Method Summary

Modifier and Type	Method and Description
java.security.Principal	createEntity(java.util.List<Attribute> attrVals, CreateOptions opts) Creates entity in the repository with given list of attribute values
void	deleteEntity(java.security.Principal principal, DeleteOptions opts) Deletes the entity from repository for given entity principal
void	deleteEntity(java.lang.String id, DeleteOptions opts) Deletes the entity from repository for given id attribute value
void	deleteEntity(java.lang.String attrName, java.lang.String attrVal, DeleteOptions opts) Deletes the entity from repository for given unique attrname and value
EntityCapabilities	getCapabilities() Gets entity capabilities
Entity	getEntity(java.security.Principal principal, ReadOptions opts) Gets the entity from repository for given entity principal.
java.lang.String	getEntityName() Gets the entity name
ResultSet<Entity>	searchEntities(SearchFilter filter, SearchOptions opts) Searches the repository and returns list of entities matching the given filter condition.
Entity	searchEntity(java.lang.String id, ReadOptions opts) Finds entity for given id value that uniquely identifies the entity
Entity	searchEntity(java.lang.String attrName, java.lang.String attrVal, ReadOptions opts) Finds entity matching given attribute name and value
Entity	searchEntityByGuid(java.lang.String guid, ReadOptions opts) Search for entity matching given GUID value that uniquely identifies the entity

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

getEntityName

public java.lang.String getEntityName()

Gets the entity name

Returns:

entity name

getEntity

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

Gets the entity from repository for given entity principal. Locale and the list of attributes to be fetched can be specified in read options.

Parameters:

principal - Entity principal

opts - Read operation options

Returns:

Entity for given principal

Throws:

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

IDSException - Generic Identity Directory Service exception

InvalidAttributesException - If the requested attributes is invalid

AuthorizationException - If user does not have sufficient privileges

searchEntity

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

Finds entity for given id value that uniquely identifies the entity

Parameters:

id - Value of the entity's id attribute

opts - Read operation options

Returns:

Entity matching given ID value

Throws:

IDSException - Generic Identity Directory Service exception

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

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

InvalidAttributesException - If the requested attributes is invalid

AuthorizationException - If user does not have sufficient privileges

searchEntity

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

Finds entity matching given attribute name and value

Parameters:

attrName - Name of the attribute

attrVal - Attribute value

opts - Read operation options

Returns:

Entity matching given search filter

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When no entity found for given search filter

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

InvalidFilterException - If the attribute is invalid filter attribute

InvalidAttributesException - If the requested attributes is invalid

AuthorizationException - If user does not have sufficient privileges

searchEntityByGuid

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

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

Parameters:

guid - guid value of entity

opts - Read operation options

Returns:

Entity matching given GUID value

Throws:

IDSException - Generic Identity Directory Service exception

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

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

InvalidAttributesException - If the requested attributes is invalid

AuthorizationException - If user does not have sufficient privileges

createEntity

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

Creates entity in the repository with given list of attribute values

Parameters:

attrVals - List of attribute values

opts - Create operation options

Returns:

Principal identifier of the entity created

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotUniqueException - When the entity to be created already exists

OperationNotSupportedException - If the entity create operation is not supported

InvalidAttributesException - When the add attributes list is invalid

AuthorizationException - If user does not have sufficient privileges

EntityAlreadyExistsException

deleteEntity

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

Deletes the entity from repository for given entity principal

Parameters:

principal - Entity principal

opts - Delete operation options

Throws:

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

IDSException - Generic Identity Directory Service exception

OperationNotSupportedException - If the entity delete operation is not supported

AuthorizationException - If user does not have sufficient privileges

deleteEntity

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

Deletes the entity from repository for given id attribute value

Parameters:

id - id value

opts - Delete operation options

Throws:

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

IDSException - Generic Identity Directory Service exception

OperationNotSupportedException - If the entity delete operation is not supported

AuthorizationException - If user does not have sufficient privileges

deleteEntity

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

Deletes the entity 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 entity in the repository for given entity principal

IDSException - Generic Identity Directory Service exception

OperationNotSupportedException - If the entity delete operation is not supported

AuthorizationException - If user does not have sufficient privileges

searchEntities

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

Searches the repository and returns list of entities 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 - If the entity 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

getCapabilities

public EntityCapabilities getCapabilities()

Gets entity capabilities

Returns:

entity capabilities