oracle.igf.ids

Class CustomGroup

java.lang.Object

oracle.igf.ids.Entity

oracle.igf.ids.Group

oracle.igf.ids.CustomGroup

public abstract class CustomGroup
extends Group

Any custom provider implementations for the IDS must extend and implement this class to get a Group object.

Field Summary

Fields inherited from class oracle.igf.ids.Entity

OBJCLASS

Constructor Summary

Constructors

Constructor and Description
CustomGroup()
CustomGroup(IdentityDirectory ids, java.lang.String entityName)

Method Summary

Modifier and Type	Method and Description
void	addManager(Group group, ModifyOptions opts) Adds the given group as manager of this group
void	addManager(User user, ModifyOptions opts) Adds the given user as manager of this group
void	addManagerOf(Group group, ModifyOptions opts) Adds this group as manager of the given group
void	addMember(Group group, ModifyOptions opts) Adds the given group as a member to this group
void	addMember(User user, ModifyOptions opts) Adds the given user as a member to this group
void	addMemberOf(Group group, ModifyOptions opts) Adds this group as a member to input group
void	addMembers(java.util.List<java.security.Principal> users, ModifyOptions opts) Adds the list of users as members to this group
void	addOwner(Group group, ModifyOptions opts) Adds the given group as owner of this group
void	addOwner(User user, ModifyOptions opts) Adds the given user as owner of this group
void	addOwnerOf(Group group, ModifyOptions opts) Adds this group as owner of the given group
Group	clone() Clones this object
void	deleteManager(Group group, ModifyOptions opts) Deletes the given group as manager of this group
void	deleteManager(User user, ModifyOptions opts) Deletes the given user as manager of this group
void	deleteManagerOf(Group group, ModifyOptions opts) Deletes this group as manager of the given group
void	deleteMember(Group group, ModifyOptions opts) Deletes the input group as a member to this group
void	deleteMember(User user, ModifyOptions opts) Deletes the input user as a member to this group
void	deleteMemberOf(Group group, ModifyOptions opts) Deletes this group as a member to input group
void	deleteMembers(java.util.List<java.security.Principal> users, ModifyOptions opts) Deletes the list of users as a member to this group
void	deleteOwner(Group group, ModifyOptions opts) Deletes the given group as owner of this group
void	deleteOwner(User user, ModifyOptions opts) Deletes the given user as owner of this group
void	deleteOwnerOf(Group group, ModifyOptions opts) Deletes this group 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	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
ResultSet<Group>	getManagedGroups(int nLevels, SearchFilter targetFilter, SearchOptions opts) Gets all the groups managed by this group matching the given filter condition
ResultSet<User>	getManagers(int nLevels, SearchFilter targetFilter, SearchOptions opts) Gets manager of this group matching the given filter condition
ResultSet<Group>	getMemberGroups(int nLevels, SearchFilter targetFilter, SearchOptions opts) Gets all the groups that are members of this group matching the given filter condition
ResultSet<Group>	getMemberOfGroups(int nLevels, SearchFilter targetFilter, SearchOptions opts) Gets all the groups this group is a member of and matching the given filter criteria
ResultSet<User>	getMembers(int nLevels, SearchFilter targetFilter, SearchOptions opts) Gets all the users that are members of this group matching the given filter condition
ResultSet<User>	getMembers(SearchFilter targetFilter, SearchOptions opts) Gets all the users that are members of this group matching the given filter condition.
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 group matching the given filter condition
ResultSet<User>	getOwners(int nLevels, SearchFilter targetFilter, SearchOptions opts) Gets owners of this group 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
java.lang.String	getSubjectName() Gets entity subject name
boolean	isManagerOf(Group group, boolean direct, ReadOptions opts) Checks if this group is manager of given group
boolean	isMember(Group group, boolean direct, ReadOptions opts) Checks if the input group is a member of this group
boolean	isMember(User user, boolean direct, ReadOptions opts) Checks if input user is a member of this group
boolean	isMember(User user, ReadOptions opts) Checks if input user is a member of this group.
boolean	isMemberOf(Group group, boolean direct, ReadOptions opts) Checks if this group is a member of the given group
boolean	isOwnerOf(Group group, boolean direct, ReadOptions opts) Checks if this group is owner of given group
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

Constructor Detail

CustomGroup

public CustomGroup()

CustomGroup

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

Method Detail

getMemberOfGroups

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

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

Overrides:

getMemberOfGroups in class Group

Parameters:

nLevels - Number of levels to be searched for the member of Groups recursively. 0 means all levels.

targetFilter - Filter criteria to be applied on the related entities

opts - Search options

Returns:

all the groups this group 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 requested attributes or the attributes in the target search filter are invalid

OperationNotSupportedException - If entity configuration does not support this method

AuthorizationException - If user does not have sufficient privileges

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

InvalidFilterException

isMember

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

Checks if the input group is a member of this group

Overrides:

isMember in class Group

Parameters:

group - Group entity

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

opts - Read options

Returns:

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

Throws:

IDSException - Generic Identity Directory Service exception

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

OperationNotSupportedException - If entity configuration does not support this method

AuthorizationException - If user does not have sufficient privileges

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

isMember

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

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

Overrides:

isMember in class Group

Parameters:

user - User entity

opts - Read options

Returns:

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

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - If the entity for which related entities to be fetched 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

isMember

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

Checks if input user is a member of this group

Overrides:

isMember in class Group

Parameters:

user - User entity

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

opts - Read options

Returns:

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

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - If the entity for which related entities to be fetched 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

addMember

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

Adds the given user as a member to this group

Overrides:

addMember in class Group

Parameters:

user - User entity

opts - Modify options

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - If either user or group entity not found

OperationNotSupportedException - If add member is not supported

AuthorizationException - If user does not have sufficient privileges

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

addMembers

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

Adds the list of users as members to this group

Overrides:

addMembers in class Group

Parameters:

users - List of user principals

opts - Modify options

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - If either user or group entity not found

OperationNotSupportedException - If add member is not supported

AuthorizationException - If user does not have sufficient privileges

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

addMember

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

Adds the given group as a member to this group

Overrides:

addMember in class Group

Parameters:

group - Group entity

opts - Modify options

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - If either of the group entities not found

OperationNotSupportedException - If add member is not supported

AuthorizationException - If user does not have sufficient privileges

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

deleteMember

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

Deletes the input user as a member to this group

Overrides:

deleteMember in class Group

Parameters:

user - User entity

opts - Modify options

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - If either user or group entity not found

OperationNotSupportedException - If delete member is not supported

AuthorizationException - If user does not have sufficient privileges

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

deleteMembers

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

Deletes the list of users as a member to this group

Overrides:

deleteMembers in class Group

Parameters:

user - List of user principals

opts - Modify options

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - If either user or group entity not found

OperationNotSupportedException - If delete member is not supported

AuthorizationException - If user does not have sufficient privileges

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

deleteMember

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

Deletes the input group as a member to this group

Overrides:

deleteMember in class Group

Parameters:

group - Group entity

opts - Modify options

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - If either of the group entities not found

OperationNotSupportedException - If delete member is not supported

AuthorizationException - If user does not have sufficient privileges

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

addMemberOf

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

Adds this group as a member to input group

Overrides:

addMemberOf in class Group

Parameters:

group - Group entity

opts - Modify options

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - If either of the group entities 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.

deleteMemberOf

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

Deletes this group as a member to input group

Overrides:

deleteMemberOf in class Group

Parameters:

group - Group entity

opts - Modify options

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - If either of the group entities 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.

getMembers

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

Gets all the users that are members of this group matching the given filter condition. Group membership is checked recursively in all the nested groups. For OPSS IdentityStore, nested group memberships are evaluated as configured in OPSS.

Overrides:

getMembers in class Group

Parameters:

targetFilter - Filter condition to be applied on the resulting members of this group

opts - Search otions

Returns:

the users that are members of this group

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - If the group entity is not found

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

OperationNotSupportedException - If entity configuration does not support this method

AuthorizationException - If user does not have sufficient privileges

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

InvalidFilterException

getMembers

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

Gets all the users that are members of this group matching the given filter condition

Overrides:

getMembers in class Group

Parameters:

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

targetFilter - Filter condition to be applied on the resulting members of this group

opts - Search options

Returns:

the users that are members of this group

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - If the group entity is not found

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

OperationNotSupportedException - If entity configuration does not support this method

AuthorizationException - If user does not have sufficient privileges

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

InvalidFilterException

getMemberGroups

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

Gets all the groups that are members of this group matching the given filter condition

Overrides:

getMemberGroups in class Group

Parameters:

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

targetFilter - Filter condition to be applied on the resulting members of this group

opts - Search options

Returns:

the groups that are members of this group

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - If the group entity is not found

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

OperationNotSupportedException - If entity configuration does not support this method

AuthorizationException - If user does not have sufficient privileges

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

InvalidFilterException

isMemberOf

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

Checks if this group is a member of the given group

Overrides:

isMemberOf in class Group

Parameters:

group - Group entity

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

opts - Read options

Returns:

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

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - If either of the group entities is not found

OperationNotSupportedException - If entity configuration does not support this method

AuthorizationException - If user does not have sufficient privileges

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

getOwners

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

Gets owners of this group matching the given filter condition

Overrides:

getOwners in class Group

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 owners of this group

opts - Search options

Returns:

owners of this group

Throws:

IDSException - Generic Identity Directory Service exception

OperationNotSupportedException - If entity configuration does not support this method

AuthorizationException - If user does not have sufficient privileges

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

getOwnedGroups

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

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

Overrides:

getOwnedGroups in class Group

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 group

Throws:

IDSException - Generic Identity Directory Service exception

OperationNotSupportedException - If entity configuration does not support this method

AuthorizationException - If user does not have sufficient privileges

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

isOwnerOf

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

Checks if this group is owner of given group

Overrides:

isOwnerOf in class Group

Parameters:

group - Group entity

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

opts - Read options

Returns:

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

Throws:

IDSException - Generic Identity Directory Service exception

OperationNotSupportedException - If entity configuration does not support this method

AuthorizationException - If user does not have sufficient privileges

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

addOwner

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

Adds the given user as owner of this group

Overrides:

addOwner in class Group

Parameters:

user - User entity

opts - Modify options

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - If either user or group entity not found

OperationNotSupportedException - If add owner is not supported

AuthorizationException - If user does not have sufficient privileges

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

addOwner

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

Adds the given group as owner of this group

Overrides:

addOwner in class Group

Parameters:

group - Group entity

opts - Modify options

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - If either of the group entities not found

OperationNotSupportedException - If add owner is not supported

AuthorizationException - If user does not have sufficient privileges

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

deleteOwner

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

Deletes the given user as owner of this group

Overrides:

deleteOwner in class Group

Parameters:

user - User entity

opts - Modify options

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - If either user or group entity not found

OperationNotSupportedException - If delete owner 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

deleteOwner

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

Deletes the given group as owner of this group

Overrides:

deleteOwner in class Group

Parameters:

group - Group entity

opts - Modify options

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - If either of the group entities not found

OperationNotSupportedException - If delete owner 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

addOwnerOf

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

Adds this group as owner of the given group

Overrides:

addOwnerOf in class Group

Parameters:

group - Group entity

opts - Modify options

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - If either of the group entities 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.

deleteOwnerOf

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

Deletes this group as owner of the given group

Overrides:

deleteOwnerOf in class Group

Parameters:

group - Group entity

opts - Modify options

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - If either of the group entities 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

getManagers

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

Gets manager of this group matching the given filter condition

Overrides:

getManagers in class Group

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 managers of this group

opts - Search options

Returns:

manager of this group

Throws:

IDSException - Generic Identity Directory Service exception

OperationNotSupportedException - If entity configuration does not support this method

AuthorizationException - If user does not have sufficient privileges

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

getManagedGroups

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

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

Overrides:

getManagedGroups in class Group

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 group

Throws:

IDSException - Generic Identity Directory Service exception

OperationNotSupportedException - If entity configuration does not support this method

AuthorizationException - If user does not have sufficient privileges

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

isManagerOf

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

Checks if this group is manager of given group

Overrides:

isManagerOf in class Group

Parameters:

group - Group entity

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

opts - Read options

Returns:

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

Throws:

IDSException - Generic Identity Directory Service exception

OperationNotSupportedException - If entity configuration does not support this method

AuthorizationException - If user does not have sufficient privileges

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

addManager

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

Adds the given user as manager of this group

Overrides:

addManager in class Group

Parameters:

user - User entity

opts - Modify options

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - If either user or group entity not found

OperationNotSupportedException - If add manager is not supported

AuthorizationException - If user does not have sufficient privileges

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

addManager

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

Adds the given group as manager of this group

Overrides:

addManager in class Group

Parameters:

group - Group entity

opts - Modify options

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - If either of the group entities not found

OperationNotSupportedException - If add manager is not supported

AuthorizationException - If user does not have sufficient privileges

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

deleteManager

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

Deletes the given user as manager of this group

Overrides:

deleteManager in class Group

Parameters:

user - User entity

opts - Modify options

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - If either user or group entity not found

OperationNotSupportedException - If delete manager 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

deleteManager

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

Deletes the given group as manager of this group

Overrides:

deleteManager in class Group

Parameters:

group - Group entity

opts - Modify options

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - If either of the group entities not found

OperationNotSupportedException - If delete manager 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

addManagerOf

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

Adds this group as manager of the given group

Overrides:

addManagerOf in class Group

Parameters:

group - Group entity

opts - Modify options

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - If either of the group entities 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.

deleteManagerOf

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

Deletes this group as manager of the given group

Overrides:

deleteManagerOf in class Group

Parameters:

group - Group entity

opts - Modify options

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - If either of the group entities 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

clone

public Group clone()

Clones this object

Overrides:

clone in class Group

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)

Description copied from class: Entity

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

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.