public class EntityManager extends AbstractEntityManager
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
|
compareEntityAttr, compareEntityAttr, getAttributeDef, getAttributeRef, getEntityAttributes, getEntityDef, getEntityRelationships, getGlobalCommonIdAttribute, getIdAttribute, modify, modify, modify, rename
public java.lang.String getEntityName()
public Entity getEntity(java.security.Principal principal, ReadOptions opts) throws EntityNotFoundException, IDSException, AuthorizationException, InvalidAttributesException
principal
- Entity principalopts
- Read operation optionsEntityNotFoundException
- When there is no entity in the repository for given entity principalIDSException
- Generic Identity Directory Service exceptionInvalidAttributesException
- If the requested attributes is invalidAuthorizationException
- If user does not have sufficient privilegespublic Entity searchEntity(java.lang.String id, ReadOptions opts) throws EntityNotFoundException, EntityNotUniqueException, IDSException, AuthorizationException, InvalidAttributesException
id
- Value of the entity's id attributeopts
- Read operation optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- When there is no entity found for given ID valueEntityNotUniqueException
- When the given filter condition does not uniquely identify the entityInvalidAttributesException
- If the requested attributes is invalidAuthorizationException
- If user does not have sufficient privilegespublic Entity searchEntity(java.lang.String attrName, java.lang.String attrVal, ReadOptions opts) throws EntityNotFoundException, EntityNotUniqueException, InvalidFilterException, IDSException, AuthorizationException, InvalidAttributesException
attrName
- Name of the attributeattrVal
- Attribute valueopts
- Read operation optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- When no entity found for given search filterEntityNotUniqueException
- When the given filter condition does not uniquely identify the entityInvalidFilterException
- If the attribute is invalid filter attributeInvalidAttributesException
- If the requested attributes is invalidAuthorizationException
- If user does not have sufficient privilegespublic Entity searchEntityByGuid(java.lang.String guid, ReadOptions opts) throws IDSException, EntityNotFoundException, EntityNotUniqueException, AuthorizationException, InvalidAttributesException
guid
- guid value of entityopts
- Read operation optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- When there is no entity found for given GUID valueEntityNotUniqueException
- When the given GUID values does not uniquely identify the entityInvalidAttributesException
- If the requested attributes is invalidAuthorizationException
- If user does not have sufficient privilegespublic java.security.Principal createEntity(java.util.List<Attribute> attrVals, CreateOptions opts) throws EntityAlreadyExistsException, IDSException, InvalidAttributesException, AuthorizationException, OperationNotSupportedException
attrVals
- List of attribute valuesopts
- Create operation optionsIDSException
- Generic Identity Directory Service exceptionEntityNotUniqueException
- When the entity to be created already existsOperationNotSupportedException
- If the entity create operation is not supportedInvalidAttributesException
- When the add attributes list is invalidAuthorizationException
- If user does not have sufficient privilegesEntityAlreadyExistsException
public void deleteEntity(java.security.Principal principal, DeleteOptions opts) throws EntityNotFoundException, IDSException, AuthorizationException, OperationNotSupportedException
principal
- Entity principalopts
- Delete operation optionsEntityNotFoundException
- When there is no entity in the repository for given entity principalIDSException
- Generic Identity Directory Service exceptionOperationNotSupportedException
- If the entity delete operation is not supportedAuthorizationException
- If user does not have sufficient privilegespublic void deleteEntity(java.lang.String id, DeleteOptions opts) throws EntityNotFoundException, IDSException, AuthorizationException, OperationNotSupportedException
id
- id valueopts
- Delete operation optionsEntityNotFoundException
- When there is no entity in the repository for given id valueIDSException
- Generic Identity Directory Service exceptionOperationNotSupportedException
- If the entity delete operation is not supportedAuthorizationException
- If user does not have sufficient privilegespublic void deleteEntity(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 entity in the repository for given entity principalIDSException
- Generic Identity Directory Service exceptionOperationNotSupportedException
- If the entity delete operation is not supportedAuthorizationException
- If user does not have sufficient privilegespublic ResultSet<Entity> searchEntities(SearchFilter filter, SearchOptions opts) throws InvalidFilterException, IDSException, OperationNotSupportedException, AuthorizationException, InvalidAttributesException
filter
- Search filteropts
- Search operation optionsIDSException
- Generic Identity Directory Service exceptionInvalidFilterException
- When the input search filter is not validOperationNotSupportedException
- If the entity 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 EntityCapabilities getCapabilities()