public class Entity
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
OBJCLASS |
Modifier and Type | Method and Description |
---|---|
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 from map.
|
java.lang.String |
getAttributeLocaleValue(java.lang.String attrName, java.util.Locale locale)
Gets attribute locale value
|
java.util.Map<java.util.Locale,Attribute> |
getAttributeLocaleValues(java.lang.String attrName)
Gets attribute locale values.
|
java.lang.String |
getAttributeValue(java.lang.String attrName)
Gets first attribute value from map.
|
java.lang.String |
getCanonicalName()
Gets entity canonical name
|
java.lang.String |
getCommonId()
Returns Entity commonId
|
java.lang.String |
getDescription()
Returns Entity description
|
java.lang.String |
getDisplayname()
Returns Entity displayname
|
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 |
getMail()
Returns entity mail
|
java.lang.String |
getName()
Gets entity name value
|
java.util.List<java.lang.String> |
getObjectClasses()
Gets entity objectclass values
|
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
|
public static final java.lang.String OBJCLASS
public Attribute getAttribute(java.lang.String attrName)
attrName
- Name of the attributepublic java.lang.String getAttributeValue(java.lang.String attrName)
attrName
- Name of the attributepublic java.util.Map<java.lang.String,Attribute> getAllAttributes()
public java.lang.String getAttributeLocaleValue(java.lang.String attrName, java.util.Locale locale)
The search for the entity must have been performed with a ReadOptions opts parameter where opts.setLocale(ReadOptions.ALL_LOCALES) was called. Otherwise this routine will always return null.
attrName
- Attribute namelocale
- Locale valuepublic java.util.Map<java.util.Locale,Attribute> getAttributeLocaleValues(java.lang.String attrName)
The search for the entity must have been performed with a ReadOptions opts parameter where opts.setLocale(ReadOptions.ALL_LOCALES) was called. Otherwise this routine will always return null.
attrName
- Attribute namepublic java.lang.String getEntityName()
public java.security.Principal getPrincipal()
public java.lang.String getSubjectName()
public java.lang.String getCanonicalName()
public java.lang.String getId()
public java.lang.String getName()
public java.lang.String getGuid()
public java.util.List<java.lang.String> getObjectClasses()
public void modify(java.util.List<ModAttribute> attrVals, ModifyOptions opts) throws IDSException, EntityNotFoundException, OperationNotSupportedException, AuthorizationException, InvalidAttributesException
attrVals
- List of mod attribute valuesopts
- Modify operation optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- When the entity to be modified is not foundOperationNotSupportedException
- When this entity modify operation is not supportedInvalidAttributesException
- When the mod attributes are invalidAuthorizationException
- If user does not have sufficient privilegespublic void setAttributeValue(java.lang.String attrName, java.lang.String attrVal, ModifyOptions opts) throws IDSException, EntityNotFoundException, OperationNotSupportedException, AuthorizationException, InvalidAttributesException
attrName
- Attribute nameattrVal
- Attribute valueopts
- Modify operation optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- When the entity to be modified is not foundOperationNotSupportedException
- When this entity modify operation is not supportedInvalidAttributesException
- When the input attribute is invalidAuthorizationException
- If user does not have sufficient privilegespublic ResultSet getRelatedEntities(java.lang.String relationshipName, int nestedLevels, SearchFilter targetFilter, SearchOptions searchOpts) throws EntityNotFoundException, IDSException, InvalidAttributesException, AuthorizationException, OperationNotSupportedException
relationshipName
- Entity relationship name to be processednestedLevels
- Number of nested levels the related entiteis to be fetchedtargetFilter
- Search filter to be used against the related entitiessearchOpts
- Search operation optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- If the entity for which related entities to be fetched is not foundInvalidAttributesException
- If the requested attributes or the attributes in the target search filter are invalidAuthorizationException
- If user does not have sufficient privilegesOperationNotSupportedException
public Entity clone()
clone
in class java.lang.Object
public java.lang.String getMail() throws OperationNotSupportedException
OperationNotSupportedException
- If mailAttr not configured in Entity definitionpublic java.lang.String getDisplayname() throws OperationNotSupportedException
OperationNotSupportedException
- If displaynameAttr not configured in Entity definitionpublic java.lang.String getDescription() throws OperationNotSupportedException
OperationNotSupportedException
- If descriptionAttr not configured in Entity definitionpublic java.lang.String getCommonId() throws OperationNotSupportedException
OperationNotSupportedException
- If descriptionAttr not configured in Entity definition