oracle.igf.ids

Class CustomIdentityDirectory

java.lang.Object

oracle.igf.ids.IdentityDirectory

oracle.igf.ids.CustomIdentityDirectory

public abstract class CustomIdentityDirectory
extends IdentityDirectory

This class acts as a bridge between any custom Identity Directory implementation and the default OPSS IdentityDirectory implementation. The custom IdentityDirectory implementation needs to extend this class. The CustomIdentityDirectory provides a means to get handles for the custom UserManager and GroupManager implementations, if any , using which the operations on entities can be performed as required.

Field Summary

Fields inherited from class oracle.igf.ids.IdentityDirectory

IDS_APP_NAME, IDS_CONFIG_FILE, IDS_ENTITY_CONFIG_NAME, IDS_OVD_CONTEXT_NAME

Constructor Summary

Constructors

Constructor and Description
CustomIdentityDirectory() Any custom IdentityDirectory implementation must use this constructor to initialize the IdentityDirectory instance.

Method Summary

Modifier and Type	Method and Description
void	close() This method unregisters the already created custom IdentityDirectory implementation.
void	finalize() Releases the resources.
AppRoleManager	getAppRoleManager() The default AppRoleManager functionality is unsupported in the custom IdentityDirectory implementation and this unmodifiable method throws an exception if used.
AttributeSchema	getAttributeSchema(java.lang.String attrName) This default functionality is unsupported in the custom implementation of the IdentityDirectory and throws an Exception if used.
Capabilities	getCapabilities() Get the CRUD (Create , Read, Update , Delete) capabilities related to the users and groups.
EntitiesConfig	getEntitiesConfig() Get the entitiesConfig information pertaining to the current custom IdentityDirectory implementation.
EntityManager	getEntityManager(java.lang.String entityName) The default EntityManager functionality is unsupported in the custom IdentityDirectory implementation and this unmodifiable method throws an exception if used.
EntityRelationManager	getEntityRelationManager() The default EntityRelationManager functionality is unsupported in the custom IdentityDirectory implementation and this unmodifiable method throws an exception if used.
abstract GroupManager	getGroupManager() This method must be implemented by the custom IdentityDirectory implementation to return the custom implementation of GroupManager as required.
java.lang.String	getIdsName() Get the custom IdentityDirectory implementation name ,if any, being currently used.
java.util.Map<java.lang.String,java.util.Set<IDSLDAPConnectionPoolStats>>	getLDAPConnectionPoolStats() This default functionality is unsupported in the custom implementation of the IdentityDirectory and throws an Exception if used.
LDAPSchemaUtil	getLDAPSchemaUtil() This default functionality is unsupported in the custom implementation of the IdentityDirectory and throws an Exception if used.
java.lang.String	getLogicalToPhysicalAttr(java.lang.String logicalAttr) This default functionality is unsupported in the custom implementation of the IdentityDirectory and throws an Exception if used.
OrgManager	getOrgManager() The default OrgManager functionality is unsupported in the custom IdentityDirectory implementation and this unmodifiable method throws an exception if used.
java.util.List<java.lang.String>	getPhysicalToLogicalAttr(java.lang.String physicalAttr) This default functionality is unsupported in the custom implementation of the IdentityDirectory and throws an Exception if used.
abstract UserManager	getUserManager() This method must be implemented by the custom IdentityDirectory implementation to return the custom implementation of UserManager as required.
abstract UserManager	getUserManager(java.lang.String entityName) This method must be implemented by the custom IdentityDirectory implementation to return the custom implementation of UserManager , with the entity name parameter, if required.
void	reload() The default functionality is not supported with custom IdentityDirectory implementation.

Methods inherited from class oracle.igf.ids.IdentityDirectory

getIdentityStoreConfig, getOperationalConfig

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomIdentityDirectory

public CustomIdentityDirectory()
                        throws IDSException

Any custom IdentityDirectory implementation must use this constructor to initialize the IdentityDirectory instance. The idsName parameter is the identifier to the handle of the IdentityDirectory returned. The configuration related with entities, identity store and various users and group operations is set to default values if not modified explicitly.

Parameters:

idsName -

idStoreConfig -

Throws:

IDSException

Method Detail

getEntitiesConfig

public EntitiesConfig getEntitiesConfig()

Get the entitiesConfig information pertaining to the current custom IdentityDirectory implementation.

Overrides:

getEntitiesConfig in class IdentityDirectory

Returns:

The persisted EntitiesConfig information. Default values are returned if not modified explicitly.

reload

public void reload()
            throws IDSException

The default functionality is not supported with custom IdentityDirectory implementation. Throws exception by default if used without overriding the method and providing an implementation.

Overrides:

reload in class IdentityDirectory

Throws:

IDSException

getUserManager

public abstract UserManager getUserManager()
                                    throws IDSException

This method must be implemented by the custom IdentityDirectory implementation to return the custom implementation of UserManager as required.

Overrides:

getUserManager in class IdentityDirectory

Returns:

The custom UserManager implementation instance

Throws:

IDSException

getUserManager

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

This method must be implemented by the custom IdentityDirectory implementation to return the custom implementation of UserManager , with the entity name parameter, if required.

Overrides:

getUserManager in class IdentityDirectory

Parameters:

entityName - The entityName with which the custom UserManager implementation is to be associated.

Returns:

The custom UserManager implementation instance.

Throws:

IDSException

getGroupManager

public abstract GroupManager getGroupManager()
                                      throws IDSException

This method must be implemented by the custom IdentityDirectory implementation to return the custom implementation of GroupManager as required.

Overrides:

getGroupManager in class IdentityDirectory

Returns:

The custom GroupManager implementation instance

Throws:

IDSException

getOrgManager

public final OrgManager getOrgManager()
                               throws IDSException

The default OrgManager functionality is unsupported in the custom IdentityDirectory implementation and this unmodifiable method throws an exception if used.

Overrides:

getOrgManager in class IdentityDirectory

Returns:

OrgManager instance

Throws:

IDSException

getEntityManager

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

The default EntityManager functionality is unsupported in the custom IdentityDirectory implementation and this unmodifiable method throws an exception if used.

Overrides:

getEntityManager in class IdentityDirectory

Parameters:

entityName - Name of the entity defined in Entity configuration

Returns:

EntityManager instance

Throws:

IDSException

getAppRoleManager

public final AppRoleManager getAppRoleManager()
                                       throws IDSException

The default AppRoleManager functionality is unsupported in the custom IdentityDirectory implementation and this unmodifiable method throws an exception if used.

Overrides:

getAppRoleManager in class IdentityDirectory

Returns:

AppRole manager

Throws:

IDSException - on exception

getEntityRelationManager

public final EntityRelationManager getEntityRelationManager()

The default EntityRelationManager functionality is unsupported in the custom IdentityDirectory implementation and this unmodifiable method throws an exception if used.

Overrides:

getEntityRelationManager in class IdentityDirectory

Returns:

EntityRelationManager instance

getCapabilities

public Capabilities getCapabilities()

Get the CRUD (Create , Read, Update , Delete) capabilities related to the users and groups. This modifiable method can be over-riden to change the default functionality if required.

Overrides:

getCapabilities in class IdentityDirectory

Returns:

A Capabilities object with the set user and group capabilities.

close

public void close()

This method unregisters the already created custom IdentityDirectory implementation. This modifiable method can be over-ridden to change the default behaviour if required.

Overrides:

close in class IdentityDirectory

getAttributeSchema

public AttributeSchema getAttributeSchema(java.lang.String attrName)

This default functionality is unsupported in the custom implementation of the IdentityDirectory and throws an Exception if used. This modifiable method can be over-riden to change the default functionality, if required.

Overrides:

getAttributeSchema in class IdentityDirectory

Parameters:

attrName - Name of attribute

Returns:

attribute schema

getLogicalToPhysicalAttr

public java.lang.String getLogicalToPhysicalAttr(java.lang.String logicalAttr)

This default functionality is unsupported in the custom implementation of the IdentityDirectory and throws an Exception if used. This modifiable method can be over-riden to change the default functionality, if required.

Overrides:

getLogicalToPhysicalAttr in class IdentityDirectory

Parameters:

logicalAttr - Name of logical attribute

Returns:

physical attribute name

getPhysicalToLogicalAttr

public java.util.List<java.lang.String> getPhysicalToLogicalAttr(java.lang.String physicalAttr)

This default functionality is unsupported in the custom implementation of the IdentityDirectory and throws an Exception if used. This modifiable method can be over-riden to change the default functionality, if required.

Overrides:

getPhysicalToLogicalAttr in class IdentityDirectory

Parameters:

physicalAttr - Name of physical attribute

Returns:

list of logical attribute name

getLDAPSchemaUtil

public LDAPSchemaUtil getLDAPSchemaUtil()

This default functionality is unsupported in the custom implementation of the IdentityDirectory and throws an Exception if used. This modifiable method can be over-riden to change the default functionality, if required.

Overrides:

getLDAPSchemaUtil in class IdentityDirectory

Returns:

LDAPSchemaUtil instance

getLDAPConnectionPoolStats

public java.util.Map<java.lang.String,java.util.Set<IDSLDAPConnectionPoolStats>> getLDAPConnectionPoolStats()
                                                                                                     throws IDSException

This default functionality is unsupported in the custom implementation of the IdentityDirectory and throws an Exception if used. This modifiable method can be over-riden to change the default functionality, if required.

Overrides:

getLDAPConnectionPoolStats in class IdentityDirectory

Returns:

Throws:

IDSException

finalize

public void finalize()
              throws java.lang.Throwable

Releases the resources.

Overrides:

finalize in class IdentityDirectory

Throws:

java.lang.Throwable

getIdsName

public java.lang.String getIdsName()

Get the custom IdentityDirectory implementation name ,if any, being currently used.

Returns:

Name of the IDS handle of the custom IdentityDrectory implementation.