oracle.igf.ids

Class CustomUser

java.lang.Object

oracle.igf.ids.Entity

oracle.igf.ids.User

oracle.igf.ids.CustomUser

public abstract class CustomUser
extends User

Any custom provider implementations of IDS must extend and implement this class to get a User object.

Field Summary

Fields inherited from class oracle.igf.ids.Entity

OBJCLASS

Constructor Summary

Constructors

Constructor and Description
CustomUser() Public Constructors to initialize user.
CustomUser(IdentityDirectory ids, java.lang.String entityName)

Method Summary

Modifier and Type	Method and Description
void	addManagerOf(Group group, ModifyOptions opts) Adds this user as manager of the given group
void	addMemberOf(Group group, ModifyOptions opts) Adds this user as a member to input group
void	addMemberOf(java.util.List<java.security.Principal> groups, ModifyOptions opts) Adds this user as a member to list of groups
void	addOwnerOf(Group group, ModifyOptions opts) Adds this user as owner of the given group
void	changePassword(char[] oldPassword, char[] newPassword, ModifyOptions opts) Changes user password given the old and new password
User	clone() Clones this object
void	deleteManagerOf(Group group, ModifyOptions opts) Deletes this user as manager of the given group
void	deleteMemberOf(Group group, ModifyOptions opts) Deletes this user as a member to input group
void	deleteMemberOf(java.util.List<java.security.Principal> groups, ModifyOptions opts) Deletes this user as a member from list of groups
void	deleteOwnerOf(Group group, ModifyOptions opts) Deletes this user as owner of the given group
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	getChallengeAns() Returns User challengeAns
java.lang.String	getChallengeQn() Returns User challengeQn
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	getFirstname() Returns User firstname
java.lang.String	getGuid() Gets entity Guid value
java.lang.String	getId() Gets entity ID attribute value
java.lang.String	getLastname() Returns User lastname
java.lang.String	getMail() Returns entity mail
ResultSet<Group>	getManagedGroups(int nLevels, SearchFilter targetFilter, SearchOptions opts) Gets all the groups managed by this user matching the given filter condition
ResultSet<User>	getManagementChain(int nLevels, SearchOptions opts) Gets the management chain for this user
java.util.List<User>	getManagementChain(int nLevels, java.lang.String manager, java.lang.String title, SearchOptions opts) Gets the management chain for this user upto the requested levels or the manager mataches the input manager or title
ResultSet<Group>	getMemberOfGroups(int nLevels, SearchFilter targetFilter, SearchOptions opts) Gets all the groups this user is a member of and matching the given filter criteria
ResultSet<Group>	getMemberOfGroups(SearchFilter targetFilter, SearchOptions opts) Gets all the groups this user is a member of and matching the given filter criteria.
java.lang.String	getName() Gets entity name value
java.util.List<java.lang.String>	getObjectClasses() Gets entity object class values
ResultSet<Group>	getOwnedGroups(int nLevels, SearchFilter targetFilter, SearchOptions opts) Gets all the groups owned by this user matching the given filter condition
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
ResultSet<User>	getReportees(int nLevels, SearchFilter targetFilter, SearchOptions opts) Gets all the reportees of this user
java.lang.String	getSubjectName() Gets entity subject name
boolean	isManager(User user, boolean direct, ReadOptions opts) Checks if the given user is manager of this user
boolean	isManagerOf(Group group, boolean direct, ReadOptions opts) Checks if this user is manager of given group
boolean	isMemberOf(Group group, boolean direct, ReadOptions opts) Checks if this user is a member of the given group
boolean	isMemberOf(Group group, ReadOptions opts) Checks if this user is a member of the given group.
boolean	isMemberOfGroup(Group group, boolean direct, ReadOptions opts) Deprecated.
boolean	isOwnerOf(Group group, boolean direct, ReadOptions opts) Checks if this user is owner of given group
void	modify(java.util.List<ModAttribute> attrVals, ModifyOptions opts) Modifies entity attribute values
void	resetPassword(char[] password, ModifyOptions opts) Resets user password
void	setAttributeValue(java.lang.String attrName, java.lang.String attrVal, ModifyOptions opts) Modifies entity attribute value
void	setManager(User user, ModifyOptions opts) Sets the input user as manager of this user

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomUser

public CustomUser()

Public Constructors to initialize user.

CustomUser

public CustomUser(IdentityDirectory ids,
                  java.lang.String entityName)

Method Detail

changePassword

public void changePassword(char[] oldPassword,
                           char[] newPassword,
                           ModifyOptions opts)
                    throws AuthenticationException,
                           OperationNotSupportedException,
                           EntityNotFoundException,
                           AuthorizationException,
                           PasswordPolicyException,
                           IDSException

Changes user password given the old and new password

Overrides:

changePassword in class User

Parameters:

oldPassword - Old password of the user

newPassword - New password of the user

opts - Modify options

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When this user is not found

OperationNotSupportedException - If the user authenticate operation is not supported

AuthenticationException - If user authentication failed

PasswordPolicyException - If there are any password policy errors

AuthorizationException - If user does not have sufficient privileges

java.lang.UnsupportedOperationException - if custom User implementation uses this method without implementing it.

resetPassword

public void resetPassword(char[] password,
                          ModifyOptions opts)
                   throws OperationNotSupportedException,
                          EntityNotFoundException,
                          AuthorizationException,
                          PasswordPolicyException,
                          IDSException

Resets user password

Overrides:

resetPassword in class User

Parameters:

password - User's new password

opts - Modify options

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When this user is not found

OperationNotSupportedException - If the user authenticate operation is not supported

PasswordPolicyException - If there are any password policy errors

AuthorizationException - If user does not have sufficient privileges

java.lang.UnsupportedOperationException - if custom User implementation uses this method without implementing it.

getManagementChain

public ResultSet<User> getManagementChain(int nLevels,
                                          SearchOptions opts)
                                   throws IDSException,
                                          EntityNotFoundException,
                                          InvalidAttributesException,
                                          AuthorizationException,
                                          OperationNotSupportedException

Gets the management chain for this user

Overrides:

getManagementChain in class User

Parameters:

nLevels - Number of levels the managers to be fetched recursively. 0 means all levels.

opts - Search options

Returns:

management chain of this user

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When this user is not found

InvalidAttributesException - If the requested attributes are invalid

AuthorizationException - If user does not have sufficient privileges

java.lang.UnsupportedOperationException - if custom User implementation uses this method without implementing it.

OperationNotSupportedException

getManagementChain

public java.util.List<User> getManagementChain(int nLevels,
                                               java.lang.String manager,
                                               java.lang.String title,
                                               SearchOptions opts)
                                        throws IDSException,
                                               EntityNotFoundException,
                                               InvalidAttributesException,
                                               AuthorizationException,
                                               OperationNotSupportedException

Gets the management chain for this user upto the requested levels or the manager mataches the input manager or title

Overrides:

getManagementChain in class User

Parameters:

nLevels - Number of levels the managers to be fetched recursively. 0 means all levels.

manager - upto this manager (principal name)

title - upto this title

opts - Search options

Returns:

managment chain of this user

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When this user is not found

InvalidAttributesException - If the requested attributes are invalid

AuthorizationException - If user does not have sufficient privileges

java.lang.UnsupportedOperationException - if custom User implementation uses this method without implementing it.

OperationNotSupportedException

isManager

public boolean isManager(User user,
                         boolean direct,
                         ReadOptions opts)
                  throws IDSException,
                         EntityNotFoundException,
                         AuthorizationException,
                         OperationNotSupportedException

Checks if the given user is manager of this user

Overrides:

isManager in class User

Parameters:

user - User object

direct - if set to true checks only the direct manager, otherwise checks the entire management chain

opts - Read options

Returns:

true if the given user is manager of this user ; false otherwise

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When either of the users not found

AuthorizationException - If user does not have sufficient privileges

java.lang.UnsupportedOperationException - if custom User implementation uses this method without implementing it.

OperationNotSupportedException

setManager

public void setManager(User user,
                       ModifyOptions opts)
                throws IDSException,
                       EntityNotFoundException,
                       AuthorizationException,
                       OperationNotSupportedException

Sets the input user as manager of this user

Overrides:

setManager in class User

Parameters:

user - User entity

opts - Modify options

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When either of the users not found

OperationNotSupportedException - If tthis method is not supported

AuthorizationException - If user does not have sufficient privileges

java.lang.UnsupportedOperationException - if custom User implementation uses this method without implementing it.

getReportees

public ResultSet<User> getReportees(int nLevels,
                                    SearchFilter targetFilter,
                                    SearchOptions opts)
                             throws IDSException,
                                    EntityNotFoundException,
                                    InvalidAttributesException,
                                    AuthorizationException,
                                    OperationNotSupportedException

Gets all the reportees of this user

Overrides:

getReportees in class User

Parameters:

nLevels - Number of levels the reportees to be fetched recursively. 0 means all levels

targetFilter - Filter condition to be applied on the resulting reportee entities

opts - Search options

Returns:

reportees of this user

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When this user 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

java.lang.UnsupportedOperationException - if custom User implementation uses this method without implementing it.

OperationNotSupportedException

getMemberOfGroups

public ResultSet<Group> getMemberOfGroups(SearchFilter targetFilter,
                                          SearchOptions opts)
                                   throws IDSException,
                                          EntityNotFoundException,
                                          InvalidFilterException,
                                          InvalidAttributesException,
                                          AuthorizationException,
                                          OperationNotSupportedException

Gets all the groups this user is a member of and matching the given filter criteria. Group membership is checked recursively in all the nested groups. For OPSS IdentityStore, nested group memberships are evaluated as configured in OPSS.

Overrides:

getMemberOfGroups in class User

Parameters:

targetFilter - Filter criteria to be applied on the related entities

opts - Search options

Returns:

all the groups this user is a member of

Throws:

IDSException - Generic Identity Directory Service exception

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

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

AuthorizationException - If user does not have sufficient privileges

java.lang.UnsupportedOperationException - if custom User implementation uses this method without implementing it.

InvalidFilterException

OperationNotSupportedException

getMemberOfGroups

public ResultSet<Group> getMemberOfGroups(int nLevels,
                                          SearchFilter targetFilter,
                                          SearchOptions opts)
                                   throws IDSException,
                                          EntityNotFoundException,
                                          InvalidFilterException,
                                          InvalidAttributesException,
                                          AuthorizationException,
                                          OperationNotSupportedException

Gets all the groups this user is a member of and matching the given filter criteria

Overrides:

getMemberOfGroups in class User

Parameters:

nLevels - Number of levels to be searched for the nested relationships. 0 means all levels.

targetFilter - Filter criteria to be applied on the related entities

opts - Search options

Returns:

all the groups this user is a member of

Throws:

IDSException - Generic Identity Directory Service exception

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

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

AuthorizationException - If user does not have sufficient privileges

java.lang.UnsupportedOperationException - if custom User implementation uses this method without implementing it.

InvalidFilterException

OperationNotSupportedException

isMemberOf

public boolean isMemberOf(Group group,
                          ReadOptions opts)
                   throws IDSException,
                          EntityNotFoundException,
                          AuthorizationException,
                          OperationNotSupportedException

Checks if this user is a member of the given group. Group membership is checked recursively in all the nested groups. For OPSS IdentityStore, nested group memberships are evaluated as configured in OPSS.

Overrides:

isMemberOf in class User

Parameters:

group - Group entity

opts - Read options

Returns:

true if this user is a member of the given group ; false otherwise

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - If either user or group entity is not found

AuthorizationException - If user does not have sufficient privileges

java.lang.UnsupportedOperationException - if custom User implementation uses this method without implementing it.

OperationNotSupportedException

isMemberOf

public boolean isMemberOf(Group group,
                          boolean direct,
                          ReadOptions opts)
                   throws IDSException,
                          EntityNotFoundException,
                          AuthorizationException,
                          OperationNotSupportedException

Checks if this user is a member of the given group

Overrides:

isMemberOf in class User

Parameters:

group - Group entity

direct - if true checks only the direct membership otherwise checks all levels recursively

opts - Read options

Returns:

true if this user is a member of the given group ; false otherwise

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - If either user or group entity is not found

AuthorizationException - If user does not have sufficient privileges

java.lang.UnsupportedOperationException - if custom User implementation uses this method without implementing it.

OperationNotSupportedException

isMemberOfGroup

@Deprecated
public boolean isMemberOfGroup(Group group,
                                           boolean direct,
                                           ReadOptions opts)
                                    throws IDSException,
                                           EntityNotFoundException,
                                           OperationNotSupportedException

Deprecated.

Preferably use isMemberOf method instead of this.

Overrides:

isMemberOfGroup in class User

Throws:

IDSException

EntityNotFoundException

OperationNotSupportedException

addMemberOf

public void addMemberOf(Group group,
                        ModifyOptions opts)
                 throws IDSException,
                        EntityNotFoundException,
                        OperationNotSupportedException,
                        AuthorizationException,
                        InvalidAttributesException

Adds this user as a member to input group

Overrides:

addMemberOf in class User

Parameters:

group - Group entity

opts - Modify options

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - If either user or group entity not found

OperationNotSupportedException - If add member of is not supported

AuthorizationException - If user does not have sufficient privileges

java.lang.UnsupportedOperationException - if custom User implementation uses this method without implementing it.

InvalidAttributesException

addMemberOf

public void addMemberOf(java.util.List<java.security.Principal> groups,
                        ModifyOptions opts)
                 throws IDSException,
                        EntityNotFoundException,
                        OperationNotSupportedException,
                        AuthorizationException,
                        InvalidAttributesException

Adds this user as a member to list of groups

Overrides:

addMemberOf in class User

Parameters:

group - List of Group principals

opts - Modify options

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - If either user or group entity not found

OperationNotSupportedException - If add member of is not supported

AuthorizationException - If user does not have sufficient privileges

java.lang.UnsupportedOperationException - if custom User implementation uses this method without implementing it.

InvalidAttributesException

deleteMemberOf

public void deleteMemberOf(Group group,
                           ModifyOptions opts)
                    throws IDSException,
                           EntityNotFoundException,
                           OperationNotSupportedException,
                           AuthorizationException,
                           InvalidAttributesException

Deletes this user as a member to input group

Overrides:

deleteMemberOf in class User

Parameters:

group - Group entity

opts - Modify options

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - If either user or group entity not found

OperationNotSupportedException - If delete member of is not supported

AuthorizationException - If user does not have sufficient privileges

java.lang.UnsupportedOperationException - if custom User implementation uses this method without implementing it.

InvalidAttributesException

deleteMemberOf

public void deleteMemberOf(java.util.List<java.security.Principal> groups,
                           ModifyOptions opts)
                    throws IDSException,
                           EntityNotFoundException,
                           OperationNotSupportedException,
                           AuthorizationException,
                           InvalidAttributesException

Deletes this user as a member from list of groups

Overrides:

deleteMemberOf in class User

Parameters:

group - Group entity

opts - Modify options

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - If either user or group entity not found

OperationNotSupportedException - If delete member of is not supported

AuthorizationException - If user does not have sufficient privileges

java.lang.UnsupportedOperationException - if custom User implementation uses this method without implementing it.

InvalidAttributesException

getOwnedGroups

public ResultSet<Group> getOwnedGroups(int nLevels,
                                       SearchFilter targetFilter,
                                       SearchOptions opts)
                                throws IDSException,
                                       AuthorizationException,
                                       OperationNotSupportedException

Gets all the groups owned by this user matching the given filter condition

Overrides:

getOwnedGroups in class User

Parameters:

nLevels - Number of levels to be searched recursively for the group ownership. 0 means all levels.

targetFilter - Filter condition to be applied on the resulting owned groups

opts - Search options

Returns:

the groups owned by this user

Throws:

IDSException - Generic Identity Directory Service exception

AuthorizationException - If user does not have sufficient privileges

java.lang.UnsupportedOperationException - if custom User implementation uses this method without implementing it.

OperationNotSupportedException

isOwnerOf

public boolean isOwnerOf(Group group,
                         boolean direct,
                         ReadOptions opts)
                  throws AuthorizationException,
                         IDSException

Checks if this user is owner of given group

Overrides:

isOwnerOf in class User

Parameters:

group - Group entity

direct - if true checks only the direct ownership otherwise checks all levels recursively

opts - Read options

Returns:

true if this user is owner of given group ; false otherwise

Throws:

IDSException - Generic Identity Directory Service exception

AuthorizationException - If user does not have sufficient privileges

java.lang.UnsupportedOperationException - if custom User implementation uses this method without implementing it.

addOwnerOf

public void addOwnerOf(Group group,
                       ModifyOptions opts)
                throws IDSException,
                       EntityNotFoundException,
                       OperationNotSupportedException,
                       AuthorizationException,
                       InvalidAttributesException

Adds this user as owner of the given group

Overrides:

addOwnerOf in class User

Parameters:

group - Group entity

opts - Modify options

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - If either user or group entity not found

OperationNotSupportedException - If add owner of is not supported

AuthorizationException - If user does not have sufficient privileges

java.lang.UnsupportedOperationException - if custom User implementation uses this method without implementing it.

InvalidAttributesException

deleteOwnerOf

public void deleteOwnerOf(Group group,
                          ModifyOptions opts)
                   throws IDSException,
                          EntityNotFoundException,
                          OperationNotSupportedException,
                          AuthorizationException,
                          InvalidAttributesException

Deletes this user as owner of the given group

Overrides:

deleteOwnerOf in class User

Parameters:

group - Group entity

opts - Modify options

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - If either user or group entity not found

OperationNotSupportedException - If delete owner of is not supported

AuthorizationException - If user does not have sufficient privileges

java.lang.UnsupportedOperationException - if custom User implementation uses this method without implementing it.

InvalidAttributesException

getManagedGroups

public ResultSet<Group> getManagedGroups(int nLevels,
                                         SearchFilter targetFilter,
                                         SearchOptions opts)
                                  throws IDSException,
                                         AuthorizationException,
                                         OperationNotSupportedException

Gets all the groups managed by this user matching the given filter condition

Overrides:

getManagedGroups in class User

Parameters:

nLevels - Number of levels to be searched recursively for the group manager. 0 means all levels.

targetFilter - Filter condition to be applied on the resulting managed groups

opts - Search options

Returns:

the groups managed by this user

Throws:

IDSException - Generic Identity Directory Service exception

AuthorizationException - If user does not have sufficient privileges

java.lang.UnsupportedOperationException - if custom User implementation uses this method without implementing it.

OperationNotSupportedException

isManagerOf

public boolean isManagerOf(Group group,
                           boolean direct,
                           ReadOptions opts)
                    throws AuthorizationException,
                           IDSException

Checks if this user is manager of given group

Overrides:

isManagerOf in class User

Parameters:

group - Group entity

direct - if true checks only the direct manager otherwise checks all levels recursively

opts - Read options

Returns:

true if this user is manager of given group ; false otherwise

Throws:

IDSException - Generic Identity Directory Service exception

AuthorizationException - If user does not have sufficient privileges

java.lang.UnsupportedOperationException - if custom User implementation uses this method without implementing it.

addManagerOf

public void addManagerOf(Group group,
                         ModifyOptions opts)
                  throws IDSException,
                         EntityNotFoundException,
                         OperationNotSupportedException,
                         AuthorizationException,
                         InvalidAttributesException

Adds this user as manager of the given group

Overrides:

addManagerOf in class User

Parameters:

group - Group entity

opts - Modify options

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - If either user or group entity not found

OperationNotSupportedException - If add manager of is not supported

AuthorizationException - If user does not have sufficient privileges

java.lang.UnsupportedOperationException - if custom User implementation uses this method without implementing it.

InvalidAttributesException

deleteManagerOf

public void deleteManagerOf(Group group,
                            ModifyOptions opts)
                     throws IDSException,
                            EntityNotFoundException,
                            OperationNotSupportedException,
                            AuthorizationException,
                            InvalidAttributesException

Deletes this user as manager of the given group

Overrides:

deleteManagerOf in class User

Parameters:

group - Group entity

opts - Modify options

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - If either user or group entity not found

OperationNotSupportedException - If delete manager of is not supported

AuthorizationException - If user does not have sufficient privileges

java.lang.UnsupportedOperationException - if custom User implementation uses this method without implementing it.

InvalidAttributesException

getFirstname

public java.lang.String getFirstname()
                              throws OperationNotSupportedException

Returns User firstname

Overrides:

getFirstname in class User

Returns:

firstname

Throws:

OperationNotSupportedException - If firstnameAttr not configured in Entity definition

java.lang.UnsupportedOperationException - if custom User implementation uses this method without implementing it.

getLastname

public java.lang.String getLastname()
                             throws OperationNotSupportedException

Returns User lastname

Overrides:

getLastname in class User

Returns:

lastname

Throws:

OperationNotSupportedException - If lastnameAttr not configured in Entity definition

java.lang.UnsupportedOperationException - if custom User implementation uses this method without implementing it.

getChallengeQn

public java.lang.String getChallengeQn()
                                throws OperationNotSupportedException

Returns User challengeQn

Overrides:

getChallengeQn in class User

Returns:

challengeQn

Throws:

OperationNotSupportedException - If challengeQnAttr not configured in Entity definition

java.lang.UnsupportedOperationException - if custom User implementation uses this method without implementing it.

getChallengeAns

public java.lang.String getChallengeAns()
                                 throws OperationNotSupportedException

Returns User challengeAns

Overrides:

getChallengeAns in class User

Returns:

challengeAns

Throws:

OperationNotSupportedException - If challengeAnsAttr not configured in Entity definition

java.lang.UnsupportedOperationException - if custom User implementation uses this method without implementing it.

clone

public User clone()

Clones this object

Overrides:

clone in class User

Returns:

copy of this object

Throws:

java.lang.UnsupportedOperationException - if custom User implementation uses this method without implementing it.

getAttribute

public Attribute getAttribute(java.lang.String attrName)

Gets Entity Attribute from map. If the local map doesn't have this requested attribute, it will be fetched from repository. All the required attributes should be specified in the ReadOptions during entity search itself for better performance.

Overrides:

getAttribute in class Entity

Parameters:

attrName - Name of the attribute

Returns:

attribute value

Throws:

java.lang.UnsupportedOperationException - if custom User implementation uses this method without implementing it.

getAttributeValue

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

Gets first attribute value from map. If the local map doesn't have this requested attribute, it will be fetched from repository. All the required attributes should be specified in the ReadOptions during entity search itself for better performance.

Overrides:

getAttributeValue in class Entity

Parameters:

attrName - Name of the attribute

Returns:

attribute value

Throws:

java.lang.UnsupportedOperationException - if custom User implementation uses this method without implementing it.

getAllAttributes

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

Gets map of all entity attributes

Overrides:

getAllAttributes in class Entity

Returns:

map of entity attributes

Throws:

java.lang.UnsupportedOperationException - if custom User implementation uses this method without implementing it.

getAttributeLocaleValue

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

Gets attribute locale value

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.

Overrides:

getAttributeLocaleValue in class Entity

Parameters:

attrName - Attribute name

locale - Locale value

Returns:

attribute value

Throws:

java.lang.UnsupportedOperationException - if custom User implementation uses this method without implementing it.

getAttributeLocaleValues

public java.util.Map<java.util.Locale,Attribute> getAttributeLocaleValues(java.lang.String attrName)

Gets attribute locale values.

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.

Overrides:

getAttributeLocaleValues in class Entity

Parameters:

attrName - Attribute name

Returns:

Map of locale and attribute values

Throws:

java.lang.UnsupportedOperationException - if custom User implementation uses this method without implementing it.

getEntityName

public java.lang.String getEntityName()

Gets entity name

Overrides:

getEntityName in class Entity

Returns:

entity name

getPrincipal

public java.security.Principal getPrincipal()

Gets principal identifier of the entity

Overrides:

getPrincipal in class Entity

Returns:

entity principal

Throws:

java.lang.UnsupportedOperationException - if custom User implementation uses this method without implementing it.

getSubjectName

public java.lang.String getSubjectName()

Gets entity subject name

Overrides:

getSubjectName in class Entity

Returns:

entity subject name

Throws:

java.lang.UnsupportedOperationException - if custom User implementation uses this method without implementing it.

getCanonicalName

public java.lang.String getCanonicalName()

Gets entity canonical name

Overrides:

getCanonicalName in class Entity

Returns:

canonical name

Throws:

java.lang.UnsupportedOperationException - if custom User implementation uses this method without implementing it.

getId

public java.lang.String getId()

Gets entity ID attribute value

Overrides:

getId in class Entity

Returns:

id value

Throws:

java.lang.UnsupportedOperationException - if custom User implementation uses this method without implementing it.

getName

public java.lang.String getName()

Gets entity name value

Overrides:

getName in class Entity

Returns:

name value

Throws:

java.lang.UnsupportedOperationException - if custom User implementation uses this method without implementing it.

getGuid

public java.lang.String getGuid()

Gets entity Guid value

Overrides:

getGuid in class Entity

Returns:

guid value

Throws:

java.lang.UnsupportedOperationException - if custom User implementation uses this method without implementing it.

getObjectClasses

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

Gets entity object class values

Overrides:

getObjectClasses in class Entity

Returns:

object class values

Throws:

java.lang.UnsupportedOperationException - if custom User implementation uses this method without implementing it.

modify

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

Modifies entity attribute values

Overrides:

modify in class Entity

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

java.lang.UnsupportedOperationException - if custom User implementation uses this method without implementing it.

setAttributeValue

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

Modifies entity attribute value

Overrides:

setAttributeValue in class Entity

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

java.lang.UnsupportedOperationException - if custom User implementation uses this method without implementing it.

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

Overrides:

getRelatedEntities in class Entity

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

java.lang.UnsupportedOperationException - if custom User implementation uses this method without implementing it.

OperationNotSupportedException

getMail

public java.lang.String getMail()
                         throws OperationNotSupportedException

Returns entity mail

Overrides:

getMail in class Entity

Returns:

mail

Throws:

OperationNotSupportedException - If mailAttr not configured in Entity definition

getDisplayname

public java.lang.String getDisplayname()
                                throws OperationNotSupportedException

Returns Entity displayname

Overrides:

getDisplayname in class Entity

Returns:

displayname

Throws:

OperationNotSupportedException - If displaynameAttr not configured in Entity definition

java.lang.UnsupportedOperationException - if custom User implementation uses this method without implementing it.

getDescription

public java.lang.String getDescription()
                                throws OperationNotSupportedException

Returns Entity description

Overrides:

getDescription in class Entity

Returns:

description

Throws:

OperationNotSupportedException - If descriptionAttr not configured in Entity definition

java.lang.UnsupportedOperationException - if custom User implementation uses this method without implementing it.

getCommonId

public java.lang.String getCommonId()
                             throws OperationNotSupportedException

Returns Entity commonId

Overrides:

getCommonId in class Entity

Returns:

description

Throws:

OperationNotSupportedException - If descriptionAttr not configured in Entity definition

java.lang.UnsupportedOperationException - if custom User implementation uses this method without implementing it.