Skip navigation links

oracle.igf.ids
Class IdentityDirectory

java.lang.Object
oracle.igf.ids.IdentityDirectory

public class IdentityDirectory

extends java.lang.Object

This class represents an handle to IdentityDirectory. Creation of IdentityDirectory instance initializes Entity configuration and connection pool to identity repository. Identity Directory instance provides handles to User, Group, Org and generic Entity Manager using which the operations on the corresponding entities can be performed.

Field Summary

static java.lang.String	IDS_APP_NAME
static java.lang.String	IDS_CONFIG_FILE
static java.lang.String	IDS_ENTITY_CONFIG_NAME
static java.lang.String	IDS_OVD_CONTEXT_NAME

Method Summary

void	close() Closes Identity Directory service releasing all the resources
AttributeSchema	getAttributeSchema(java.lang.String attrName) Gets attribute schema from Identity Store
Capabilities	getCapabilities() Gets all the capabilities of this IdentityDirectory instance
EntitiesConfig	getEntitiesConfig() Gets the Entities Configuration
EntityManager	getEntityManager(java.lang.String entityName) Gets generic EntityManager instance for a given entity name that is defined in entity configuration
EntityRelationManager	getEntityRelationManager() Gets instance of EntityRelationManager for create, delete or search of the entity relationships
GroupManager	getGroupManager() Gets instance of GroupManager for the group entity defined in Entity configuration
OrgManager	getOrgManager() Gets instance of OrgManager for the org entity defined in Entity configuration
UserManager	getUserManager() Gets the instance of UserManager for default user entity defined in Entity configuration
UserManager	getUserManager(java.lang.String entityName) Gets the instance of UserManager for given user entity name.
void	reload() Reload the Entity Configuration

Methods inherited from class java.lang.Object

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

Field Detail

IDS_CONFIG_FILE

public static final java.lang.String IDS_CONFIG_FILE

See Also:

Constant Field Values

IDS_OVD_CONTEXT_NAME

public static final java.lang.String IDS_OVD_CONTEXT_NAME

See Also:

Constant Field Values

IDS_ENTITY_CONFIG_NAME

public static final java.lang.String IDS_ENTITY_CONFIG_NAME

See Also:

Constant Field Values

IDS_APP_NAME

public static final java.lang.String IDS_APP_NAME

See Also:

Constant Field Values

Method Detail

getEntitiesConfig

public EntitiesConfig getEntitiesConfig()

Gets the Entities Configuration

Returns:

Entities configuration

reload

public void reload()
            throws IDSException

Reload the Entity Configuration

Throws:

IDSException

getUserManager

public UserManager getUserManager()
                           throws IDSException

Gets the instance of UserManager for default user entity defined in Entity configuration

Returns:

UserManager instance

Throws:

IDSException

getUserManager

public UserManager getUserManager(java.lang.String entityName)
                           throws IDSException

Gets the instance of UserManager for given user entity name. If the logical entity configuration has more than one user entity this method can be used to get the UserManager instance for a given user entity name.

Parameters:

entityName - Name of the user entity

Returns:

UserManager instance

Throws:

IDSException

getGroupManager

public GroupManager getGroupManager()
                             throws IDSException

Gets instance of GroupManager for the group entity defined in Entity configuration

Returns:

GroupManager instance

Throws:

IDSException

getOrgManager

public OrgManager getOrgManager()
                         throws IDSException

Gets instance of OrgManager for the org entity defined in Entity configuration

Returns:

OrgManager instance

Throws:

IDSException

getEntityManager

public EntityManager getEntityManager(java.lang.String entityName)
                               throws IDSException

Gets generic EntityManager instance for a given entity name that is defined in entity configuration

Parameters:

entityName - Name of the entity defined in Entity configuration

Returns:

EntityManager instance

Throws:

IDSException

getEntityRelationManager

public EntityRelationManager getEntityRelationManager()

Gets instance of EntityRelationManager for create, delete or search of the entity relationships

Returns:

EntityRelationManager instance

getCapabilities

public Capabilities getCapabilities()

Gets all the capabilities of this IdentityDirectory instance

Returns:

Capabilities object

close

public void close()

Closes Identity Directory service releasing all the resources

getAttributeSchema

public AttributeSchema getAttributeSchema(java.lang.String attrName)

Gets attribute schema from Identity Store

Parameters:

attrName - Name of attribute

Returns:

attribute schema

Skip navigation links