oracle.igf.ids

Class AbstractEntityManager

java.lang.Object

oracle.igf.ids.AbstractEntityManager

Direct Known Subclasses:

EntityManager, GroupManager, OrgManager, UserManager

public abstract class AbstractEntityManager
extends java.lang.Object

Abstract EntityManager class. Derived classes - EntityManager, UserManager, GroupManager and OrgManager

Method Summary

Modifier and Type	Method and Description
boolean	compareEntityAttr(java.security.Principal principal, java.lang.String attrname, char[] attrvalue) Compares entity attribute for given principal in the repository.
boolean	compareEntityAttr(java.security.Principal principal, java.lang.String attrname, java.lang.String attrvalue) Compares entity attribute for given principal in the repository.
AttributeDef	getAttributeDef(java.lang.String attrName) Gets attribute definition for given attribute name
AttributeRef	getAttributeRef(java.lang.String attrName) Gets entity attribute reference for given attribute name
java.util.List<java.lang.String>	getEntityAttributes() Gets entity attributes from entity definition
EntityDef	getEntityDef() Gets entity defintion
java.util.List<EntityRelationship>	getEntityRelationships() Gets all entity relationships where current entity is part of the entity relationship definition
java.lang.String	getGlobalCommonIdAttribute(java.lang.String entityName) Returns global common id attribute name configured in the entity definition
java.lang.String	getIdAttribute() Returns the ID attribute name configured in the entity definition
void	modify(java.security.Principal principal, java.util.List<ModAttribute> attrVals, ModifyOptions opts) Modifies entity attribute values
void	modify(java.lang.String id, java.util.List<ModAttribute> attrVals, ModifyOptions opts) Modifies entity attribute values
void	modify(java.lang.String attrName, java.lang.String attrVal, java.util.List<ModAttribute> attrVals, ModifyOptions opts) Modifies entity attribute values
void	rename(java.security.Principal principal, java.lang.String newName, java.lang.String newContainer, ModifyOptions opts) Renames the entity for given principal

Methods inherited from class java.lang.Object

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

Method Detail

getEntityDef

public EntityDef getEntityDef()

Gets entity defintion

Returns:

entity definition

getEntityAttributes

public java.util.List<java.lang.String> getEntityAttributes()

Gets entity attributes from entity definition

Returns:

list of entity attributes

getAttributeDef

public AttributeDef getAttributeDef(java.lang.String attrName)

Gets attribute definition for given attribute name

Parameters:

attrName - Name of the attribute

Returns:

attribute definition

getAttributeRef

public AttributeRef getAttributeRef(java.lang.String attrName)

Gets entity attribute reference for given attribute name

Parameters:

attrName - Name of the attribute

Returns:

entity attribute reference

getEntityRelationships

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

Gets all entity relationships where current entity is part of the entity relationship definition

Returns:

list of entity relationship definitions

getIdAttribute

public java.lang.String getIdAttribute()

Returns the ID attribute name configured in the entity definition

Returns:

id attribute name

getGlobalCommonIdAttribute

public java.lang.String getGlobalCommonIdAttribute(java.lang.String entityName)

Returns global common id attribute name configured in the entity definition

Returns:

global commond id attribute name

compareEntityAttr

public boolean compareEntityAttr(java.security.Principal principal,
                                 java.lang.String attrname,
                                 java.lang.String attrvalue)
                          throws IDSException,
                                 EntityNotFoundException,
                                 OperationNotSupportedException

Compares entity attribute for given principal in the repository.

Parameters:

principal - Principal identifier of the entity

attrname - Attribute name

attrvalue - Attribute value to be compared

Returns:

true if authenticated successfully ; false otherwise

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When no user found for given ID value

OperationNotSupportedException - If the user authenticate operation is not supported

compareEntityAttr

public boolean compareEntityAttr(java.security.Principal principal,
                                 java.lang.String attrname,
                                 char[] attrvalue)
                          throws IDSException,
                                 EntityNotFoundException,
                                 OperationNotSupportedException

Compares entity attribute for given principal in the repository.

Parameters:

principal - Principal identifier of the entity

attrname - Attribute name

attrvalue - Attribute value to be compared

Returns:

true if authenticated successfully ; false otherwise

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When no user found for given ID value

OperationNotSupportedException - If the user authenticate operation is not supported

modify

public void modify(java.lang.String id,
                   java.util.List<ModAttribute> attrVals,
                   ModifyOptions opts)
            throws IDSException,
                   EntityNotFoundException,
                   OperationNotSupportedException,
                   AuthorizationException,
                   InvalidAttributesException

Modifies entity attribute values

Parameters:

id - Value of the entity's id attribute

attrVals - List of mod attribute values

opts - Modify operation options

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When the entity to be modified is not found

OperationNotSupportedException - When this entity modify operation is not supported

InvalidAttributesException - When the mod attributes are invalid

AuthorizationException - If user does not have sufficient privileges

modify

public void modify(java.security.Principal principal,
                   java.util.List<ModAttribute> attrVals,
                   ModifyOptions opts)
            throws IDSException,
                   EntityNotFoundException,
                   OperationNotSupportedException,
                   AuthorizationException,
                   InvalidAttributesException

Modifies entity attribute values

Parameters:

principal - Principal identifier of the entity

attrVals - List of mod attribute values

opts - Modify operation options

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When the entity to be modified is not found

OperationNotSupportedException - When this entity modify operation is not supported

InvalidAttributesException - When the mod attributes are invalid

AuthorizationException - If user does not have sufficient privileges

modify

public void modify(java.lang.String attrName,
                   java.lang.String attrVal,
                   java.util.List<ModAttribute> attrVals,
                   ModifyOptions opts)
            throws IDSException,
                   EntityNotFoundException,
                   OperationNotSupportedException,
                   AuthorizationException,
                   InvalidAttributesException

Modifies entity attribute values

Parameters:

attrName - Name of the unique attribute

attrVal - Attribute value

attrVals - List of mod attribute values

opts - Modify operation options

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When the entity to be modified is not found

OperationNotSupportedException - When this entity modify operation is not supported

InvalidAttributesException - When the mod attributes are invalid

AuthorizationException - If user does not have sufficient privileges

rename

public void rename(java.security.Principal principal,
                   java.lang.String newName,
                   java.lang.String newContainer,
                   ModifyOptions opts)
            throws IDSException,
                   EntityNotFoundException,
                   OperationNotSupportedException,
                   AuthorizationException,
                   InvalidAttributesException

Renames the entity for given principal

Parameters:

principal - Principal identifier of the entity

newName - new name value. If the entity is moved under different container keeping the name same then the newName should be same as old name value.

newContainer - new container where this entity is moved under. If this is just name change then this can be null.

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When the entity to be modified is not found

OperationNotSupportedException - When this entity modify operation is not supported

InvalidAttributesException - When the mod attributes are invalid

AuthorizationException - If user does not have sufficient privileges