oracle.igf.ids

Class EntityRelationManager

java.lang.Object

oracle.igf.ids.EntityRelationManager

public class EntityRelationManager
extends java.lang.Object

Class for handling entity relationship operations like read, create, delete, and search relationship

Method Summary

Modifier and Type	Method and Description
void	createEntityRelationship(java.lang.String relationshipName, Entity fromEntity, Entity toEntity, CreateOptions createOpts) Creates specified entity relationship between given two entities
void	createEntityRelationship(java.lang.String relationshipName, java.lang.String fromEntityId, java.lang.String toEntityId, CreateOptions createOpts) Creates specified entity relationship between given two entities
void	deleteEntityRelationship(java.lang.String relationshipName, Entity fromEntity, Entity toEntity, DeleteOptions deleteOpts) Deletes specified entity relationship between given two entities
void	deleteEntityRelationship(java.lang.String relationshipName, java.lang.String fromEntityId, java.lang.String toEntityId, DeleteOptions deleteOpts) Deletes specified entity relationship between given two entities
boolean	entityRelationExists(java.lang.String relationshipName, Entity fromEntity, Entity toEntity, ReadOptions readOpts) Checks if the specified entity relationship exists between given two entities
boolean	entityRelationExists(java.lang.String relationshipName, java.lang.String fromEntityId, java.lang.String toEntityId, ReadOptions readOpts) Checks if the specified entity relationship exists between given two entities
EntityRelationship	getEntityRelationship(java.lang.String entityRelationshipName) Gets entity relationship definition for given entity relationship name
java.util.List<EntityRelationship>	getEntityRelationships() Gets all entity relationships defined in entity configuration
ResultSet	searchEntityRelationship(java.lang.String relationshipName, Entity fromEntity, int nestedLevels, SearchFilter targetFilter, SearchOptions searchOpts) Searches related entities for a given entity and specified entity relationship
ResultSet	searchEntityRelationship(java.lang.String relationshipName, java.lang.String fromEntityId, int nestedLevels, SearchFilter targetFilter, SearchOptions searchOpts) Searches related entities for a given entity and specified entity relationship

Methods inherited from class java.lang.Object

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

Method Detail

entityRelationExists

public boolean entityRelationExists(java.lang.String relationshipName,
                                    java.lang.String fromEntityId,
                                    java.lang.String toEntityId,
                                    ReadOptions readOpts)
                             throws IDSException,
                                    EntityNotFoundException,
                                    AuthorizationException,
                                    EntityNotUniqueException

Checks if the specified entity relationship exists between given two entities

Parameters:

relationshipName - Name of relationship

fromEntityId - First entity id

toEntityId - Second entity id

readOpts - Read options

Returns:

true if the specified entity relationship exists ; false otherwise

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - If any of the given two entities not found

AuthorizationException - If user does not have sufficient privileges

EntityNotUniqueException

entityRelationExists

public boolean entityRelationExists(java.lang.String relationshipName,
                                    Entity fromEntity,
                                    Entity toEntity,
                                    ReadOptions readOpts)
                             throws IDSException,
                                    AuthorizationException,
                                    EntityNotFoundException

Checks if the specified entity relationship exists between given two entities

Parameters:

relationshipName - Name of relationship

fromEntity - First entity

toEntity - Second entity

readOpts - Read options

Returns:

true if the specified entity relationship exists ; false otherwise

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - If any of the given two entities not found

AuthorizationException - If user does not have sufficient privileges

createEntityRelationship

public void createEntityRelationship(java.lang.String relationshipName,
                                     java.lang.String fromEntityId,
                                     java.lang.String toEntityId,
                                     CreateOptions createOpts)
                              throws IDSException,
                                     EntityAlreadyExistsException,
                                     EntityNotFoundException,
                                     EntityNotUniqueException,
                                     AuthorizationException,
                                     OperationNotSupportedException

Creates specified entity relationship between given two entities

Parameters:

relationshipName - Name of the entity relationship

fromEntityId - First entity id

toEntityId - Second entity id

createOpts - Create options

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - If any of the given two entities not found

EntityNotUniqueException - If more than one entity found matching given entity id

OperationNotSupportedException - If the entity relationship creation is not supported

AuthorizationException - If user does not have sufficient privileges

EntityAlreadyExistsException

createEntityRelationship

public void createEntityRelationship(java.lang.String relationshipName,
                                     Entity fromEntity,
                                     Entity toEntity,
                                     CreateOptions createOpts)
                              throws IDSException,
                                     EntityAlreadyExistsException,
                                     EntityNotFoundException,
                                     AuthorizationException,
                                     OperationNotSupportedException

Creates specified entity relationship between given two entities

Parameters:

relationshipName - Name of the entity relationship

fromEntity - First entity

toEntity - Second entity

createOpts - Create options

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - If any of the given two entities not found

OperationNotSupportedException - If the entity relationship creation is not supported

AuthorizationException - If user does not have sufficient privileges

EntityAlreadyExistsException

deleteEntityRelationship

public void deleteEntityRelationship(java.lang.String relationshipName,
                                     java.lang.String fromEntityId,
                                     java.lang.String toEntityId,
                                     DeleteOptions deleteOpts)
                              throws IDSException,
                                     EntityNotFoundException,
                                     OperationNotSupportedException,
                                     AuthorizationException,
                                     EntityNotUniqueException

Deletes specified entity relationship between given two entities

Parameters:

relationshipName - Name of the entity relationship

fromEntityId - First entity id

toEntityId - Second entity id

deleteOpts - Delete options

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - If any of the given two entities not found

EntityNotUniqueException - If more than one entity found matching given entity id

OperationNotSupportedException - If the entity relationship creation is not supported

AuthorizationException - If user does not have sufficient privileges

deleteEntityRelationship

public void deleteEntityRelationship(java.lang.String relationshipName,
                                     Entity fromEntity,
                                     Entity toEntity,
                                     DeleteOptions deleteOpts)
                              throws IDSException,
                                     EntityNotFoundException,
                                     AuthorizationException,
                                     OperationNotSupportedException

Deletes specified entity relationship between given two entities

Parameters:

relationshipName - Name of the entity relationship

fromEntity - First entity

toEntity - Second entity

deleteOpts - Delete options

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - If any of the given two entities not found

EntityNotUniqueException - If more than one entity found matching given entity id

OperationNotSupportedException - If the entity relationship creation is not supported

AuthorizationException - If user does not have sufficient privileges

searchEntityRelationship

public ResultSet searchEntityRelationship(java.lang.String relationshipName,
                                          java.lang.String fromEntityId,
                                          int nestedLevels,
                                          SearchFilter targetFilter,
                                          SearchOptions searchOpts)
                                   throws IDSException,
                                          EntityNotFoundException,
                                          EntityNotUniqueException,
                                          AuthorizationException,
                                          OperationNotSupportedException

Searches related entities for a given entity and specified entity relationship

Parameters:

relationshipName - Name of the entity relationship

fromEntityId - Entity from which the related entities to be found

nestedLevels - number of levels to be searched for recursive relationships. 0 means all the levels.

targetFilter - Search filter to be applied on the related entities

searchOpts - Search options

Returns:

ResultSet with all related entities matching targetFilter criteria

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - If any of the given two entities not found

EntityNotUniqueException - If more than one entity found matching given entity id

AuthorizationException - If user does not have sufficient privileges

OperationNotSupportedException

searchEntityRelationship

public ResultSet searchEntityRelationship(java.lang.String relationshipName,
                                          Entity fromEntity,
                                          int nestedLevels,
                                          SearchFilter targetFilter,
                                          SearchOptions searchOpts)
                                   throws IDSException,
                                          AuthorizationException,
                                          OperationNotSupportedException

Searches related entities for a given entity and specified entity relationship

Parameters:

relationshipName - Name of the entity relationship

fromEntity - Entity from which the related entities to be found

nestedLevels - number of levels to be searched for recursive relationships. 0 means all the levels.

targetFilter - Search filter to be applied on the related entities

searchOpts - Search options

Returns:

ResultSet with all related entities matching targetFilter criteria

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - If any of the given two entities not found

EntityNotUniqueException - If more than one entity found matching given entity id

AuthorizationException - If user does not have sufficient privileges

OperationNotSupportedException

getEntityRelationships

public java.util.List<EntityRelationship> getEntityRelationships()

Gets all entity relationships defined in entity configuration

Returns:

list of all entity relationship definitions

getEntityRelationship

public EntityRelationship getEntityRelationship(java.lang.String entityRelationshipName)

Gets entity relationship definition for given entity relationship name

Parameters:

entityRelationshipName - Name of the entity relationship

Returns:

entity relationship definition