Skip navigation links

oracle.igf.ids
Class Entity

java.lang.Object
oracle.igf.ids.Entity

Direct Known Subclasses:

Group, Org, User

public class Entity

extends java.lang.Object

This is generic entity class holding the list of attributes of the entity fetched using search or read methods. This generic entity class also holds the EntityManager handle and provides methods to modify attribute values in the repository and the methods for getting the related entities per the entity relationship definitions.

Method Summary

Entity	clone() Clones this object
java.util.Map<java.lang.String,Attribute>	getAllAttributes() Gets map of all entity attributes
Attribute	getAttribute(java.lang.String attrName) Gets Entity Attribute
java.lang.String	getAttributeLocaleValue(java.lang.String attrName, java.util.Locale locale) Gets attribute locale value
java.lang.String	getAttributeValue(java.lang.String attrName) Gets first attribute value
java.lang.String	getCanonicalName() Gets entity canonical name
java.lang.String	getEntityName() Gets entity name
java.lang.String	getGuid() Gets entity Guid value
java.lang.String	getId() Gets entity ID attribute value
java.lang.String	getName() Gets entity name value
java.security.Principal	getPrincipal() Gets principal identifier of the entity
ResultSet	getRelatedEntities(java.lang.String relationshipName, int nestedLevels, SearchFilter targetFilter, SearchOptions searchOpts) Gets all related entities for given entity relationship
java.lang.String	getSubjectName() Gets entity subjectname
void	modify(java.util.List<ModAttribute> attrVals, ModifyOptions opts) Modifies entity attribute values
void	setAttributeValue(java.lang.String attrName, java.lang.String attrVal, ModifyOptions opts) Modifies entity attribute value

Methods inherited from class java.lang.Object

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

Method Detail

getAttribute

public Attribute getAttribute(java.lang.String attrName)

Gets Entity Attribute

Parameters:

attrName - Name of the attribute

Returns:

attribute value

getAttributeValue

public java.lang.String getAttributeValue(java.lang.String attrName)

Gets first attribute value

Parameters:

attrName - Name of the attribute

Returns:

attribute value

getAllAttributes

public java.util.Map<java.lang.String,Attribute> getAllAttributes()

Gets map of all entity attributes

Returns:

map of entity attributes

getAttributeLocaleValue

public java.lang.String getAttributeLocaleValue(java.lang.String attrName,
                                                java.util.Locale locale)

Gets attribute locale value

Parameters:

attrName - Attribute name

locale - Locale value

Returns:

attribute value

getEntityName

public java.lang.String getEntityName()

Gets entity name

Returns:

entity name

getPrincipal

public java.security.Principal getPrincipal()

Gets principal identifier of the entity

Returns:

entity principal

getSubjectName

public java.lang.String getSubjectName()

Gets entity subjectname

Returns:

entity subjectname

getCanonicalName

public java.lang.String getCanonicalName()

Gets entity canonical name

Returns:

canonical name

getId

public java.lang.String getId()

Gets entity ID attribute value

Returns:

id value

getName

public java.lang.String getName()

Gets entity name value

Returns:

name value

getGuid

public java.lang.String getGuid()

Gets entity Guid value

Returns:

guid value

modify

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

Modifies entity attribute values

Parameters:

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

setAttributeValue

public void setAttributeValue(java.lang.String attrName,
                              java.lang.String attrVal,
                              ModifyOptions opts)
                       throws IDSException,
                              EntityNotFoundException,
                              OperationNotSupportedException,
                              AuthorizationException,
                              InvalidAttributesException

Modifies entity attribute value

Parameters:

attrName - Attribute name

attrVal - Attribute value

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 input attribute is invalid

AuthorizationException - If user does not have sufficient privileges

getRelatedEntities

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

Gets all related entities for given entity relationship

Parameters:

relationshipName - Entity relationship name to be processed

nestedLevels - Number of nested levels the related entiteis to be fetched

targetFilter - Search filter to be used against the related entities

searchOpts - Search operation options

Returns:

Search results

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - If the entity for which related entities to be fetched is not found

InvalidAttributesException - If the requested attributes or the attributes in the target search filter are invalid

AuthorizationException - If user does not have sufficient privileges

OperationNotSupportedException

clone

public Entity clone()

Clones this object

Overrides:

clone in class java.lang.Object

Returns:

copy of this object

Skip navigation links