|
Oracle Fusion Middleware Identity Governance Framework Identity Directory Java API Reference 11 g Release 2 (11.1.2) E27140-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.igf.ids.Entity
oracle.igf.ids.User
public class User
Class holding the list of attributes of the User entity fetched using search or read methods. This User entity class also holds the UserManager 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 | |
---|---|
void |
addMemberOf(Group group, ModifyOptions opts) Adds this user as a member to input group |
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 |
deleteMemberOf(Group group, ModifyOptions opts) Deletes this user as a member to input group |
void |
deleteOwnerOf(Group group, ModifyOptions opts) Deletes this user as owner of the given group |
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> |
getOwnedGroups(int nLevels, SearchFilter targetFilter, SearchOptions opts) Gets all the groups owned by this user matching the given filter condition |
ResultSet<User> |
getReportees(int nLevels, SearchFilter targetFilter, SearchOptions opts) Gets all the reportees of this user |
boolean |
isManager(User user, boolean direct, ReadOptions opts) Checks if the given user is manager of this user |
boolean |
isMemberOf(Group group, boolean direct, 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 |
resetPassword(char[] password, ModifyOptions opts) Resets user password |
void |
setManager(User user, ModifyOptions opts) Sets the input user as manager of this user |
Methods inherited from class oracle.igf.ids.Entity |
---|
getAllAttributes, getAttribute, getAttributeLocaleValue, getAttributeValue, getCanonicalName, getEntityName, getGuid, getId, getName, getPrincipal, getRelatedEntities, getSubjectName, modify, setAttributeValue |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public void changePassword(char[] oldPassword, char[] newPassword, ModifyOptions opts) throws AuthenticationException, OperationNotSupportedException, EntityNotFoundException, AuthorizationException, IDSException
oldPassword
- Old password of the usernewPassword
- New password of the useropts
- Modify optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- When this user is not foundOperationNotSupportedException
- If the user authenticate operation is not supportedAuthenticationException
- If user authentication failedAuthorizationException
- If user does not have sufficient privilegespublic void resetPassword(char[] password, ModifyOptions opts) throws OperationNotSupportedException, EntityNotFoundException, AuthorizationException, IDSException
password
- User's new passwordopts
- Modify optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- When this user is not foundOperationNotSupportedException
- If the user authenticate operation is not supportedAuthorizationException
- If user does not have sufficient privilegespublic ResultSet<User> getManagementChain(int nLevels, SearchOptions opts) throws IDSException, EntityNotFoundException, InvalidAttributesException, AuthorizationException, OperationNotSupportedException
nLevels
- Number of levels the managers to be fetched recursively. 0 means all levels.opts
- Search optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- When this user is not foundInvalidAttributesException
- If the requested attributes are invalidAuthorizationException
- If user does not have sufficient privilegesOperationNotSupportedException
public java.util.List<User> getManagementChain(int nLevels, java.lang.String manager, java.lang.String title, SearchOptions opts) throws IDSException, EntityNotFoundException, InvalidAttributesException, AuthorizationException, OperationNotSupportedException
nLevels
- Number of levels the managers to be fetched recursively. 0 means all levels.manager
- upto this manager (principal name)title
- upto this titleopts
- Search optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- When this user is not foundInvalidAttributesException
- If the requested attributes are invalidAuthorizationException
- If user does not have sufficient privilegesOperationNotSupportedException
public boolean isManager(User user, boolean direct, ReadOptions opts) throws IDSException, EntityNotFoundException, AuthorizationException, OperationNotSupportedException
user
- User objectdirect
- if set to true checks only the direct manager, otherwise checks the entire management chainopts
- Read optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- When either of the users not foundAuthorizationException
- If user does not have sufficient privilegesOperationNotSupportedException
public void setManager(User user, ModifyOptions opts) throws IDSException, EntityNotFoundException, AuthorizationException, OperationNotSupportedException
user
- User entityopts
- Modify optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- When either of the users not foundOperationNotSupportedException
- If tthis method is not supportedAuthorizationException
- If user does not have sufficient privilegespublic ResultSet<User> getReportees(int nLevels, SearchFilter targetFilter, SearchOptions opts) throws IDSException, EntityNotFoundException, InvalidAttributesException, AuthorizationException, OperationNotSupportedException
nLevels
- Number of levels the reportees to be fetched recursively. 0 means all levelstargetFilter
- Filter condition to be applied on the resulting reportee entitiesopts
- Search optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- When this user 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 ResultSet<Group> getMemberOfGroups(int nLevels, SearchFilter targetFilter, SearchOptions opts) throws IDSException, EntityNotFoundException, InvalidAttributesException, AuthorizationException, OperationNotSupportedException
nLevels
- Number of levels to be searched for the nested relationships. 0 means all levels.targetFilter
- Filter criteria to be applied on the related entitiesopts
- Search optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- If the entity for which related entities to be fetched is not foundInvalidAttributesException
- If the requsted attributes or the attributes in the target search filter are invalidAuthorizationException
- If user does not have sufficient privilegesOperationNotSupportedException
public boolean isMemberOf(Group group, boolean direct, ReadOptions opts) throws IDSException, EntityNotFoundException, AuthorizationException, OperationNotSupportedException
group
- Group entitydirect
- if true checks only the direct memberhship otherwise checks all levels recursivelyopts
- Read optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- If either user or group entity is not foundAuthorizationException
- If user does not have sufficient privilegesOperationNotSupportedException
@Deprecated
public boolean isMemberOfGroup(Group group,
boolean direct,
ReadOptions opts)
throws IDSException,
OperationNotSupportedException,
EntityNotFoundException
IDSException
OperationNotSupportedException
EntityNotFoundException
public void addMemberOf(Group group, ModifyOptions opts) throws IDSException, EntityNotFoundException, OperationNotSupportedException, AuthorizationException, InvalidAttributesException
group
- Group entityopts
- Modify optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- If either user or group entity not foundOperationNotSupportedException
- If add member of is not supportedAuthorizationException
- If user does not have sufficient privilegesInvalidAttributesException
public void deleteMemberOf(Group group, ModifyOptions opts) throws IDSException, EntityNotFoundException, OperationNotSupportedException, AuthorizationException, InvalidAttributesException
group
- Group entityopts
- Modify optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- If either user or group entity not foundOperationNotSupportedException
- If delete member of is not supportedAuthorizationException
- If user does not have sufficient privilegesInvalidAttributesException
public ResultSet<Group> getOwnedGroups(int nLevels, SearchFilter targetFilter, SearchOptions opts) throws IDSException, AuthorizationException, OperationNotSupportedException
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 groupsopts
- Search optionsIDSException
- Generic Identity Directory Service exceptionAuthorizationException
- If user does not have sufficient privilegesOperationNotSupportedException
public boolean isOwnerOf(Group group, boolean direct, ReadOptions opts) throws AuthorizationException, OperationNotSupportedException, IDSException
group
- Group entitydirect
- if true checks only the direct ownership otherwise checks all levels recursivelyopts
- Read optionsIDSException
- Generic Identity Directory Service exceptionAuthorizationException
- If user does not have sufficient privilegesOperationNotSupportedException
public void addOwnerOf(Group group, ModifyOptions opts) throws IDSException, EntityNotFoundException, OperationNotSupportedException, AuthorizationException, InvalidAttributesException
group
- Group entityopts
- Modify optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- If either user or group entity not foundOperationNotSupportedException
- If add owner of is not supportedAuthorizationException
- If user does not have sufficient privilegesInvalidAttributesException
public void deleteOwnerOf(Group group, ModifyOptions opts) throws IDSException, EntityNotFoundException, OperationNotSupportedException, AuthorizationException, InvalidAttributesException
group
- Group entityopts
- Modify optionsIDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- If either user or group entity not foundOperationNotSupportedException
- If delete owner of is not supportedAuthorizationException
- If user does not have sufficient privilegesInvalidAttributesException
public User clone()
clone
in class Entity
|
Oracle Fusion Middleware Identity Governance Framework Identity Directory Java API Reference 11 g Release 2 (11.1.2) E27140-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |