oracle.igf.ids

Class Group

java.lang.Object

oracle.igf.ids.Entity

oracle.igf.ids.Group

Direct Known Subclasses:

CustomGroup

public class Group
extends Entity

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

Field Summary

Fields inherited from class oracle.igf.ids.Entity

OBJCLASS

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
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.
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
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

Methods inherited from class oracle.igf.ids.Entity

getAllAttributes, getAttribute, getAttributeLocaleValue, getAttributeLocaleValues, getAttributeValue, getCanonicalName, getCommonId, getDescription, getDisplayname, getEntityName, getGuid, getId, getMail, getName, getObjectClasses, getPrincipal, getRelatedEntities, getSubjectName, modify, setAttributeValue

Methods inherited from class java.lang.Object

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

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

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 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

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

Parameters:

group - Group entity

direct - if true checks only the direct memberhship 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

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.

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

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

Parameters:

user - User entity

direct - if true checks only the direct memberhship 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

OperationNotSupportedException

addMember

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

Adds the given user as a member to this 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

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

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

addMember

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

Adds the given group as a member to this 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

deleteMember

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

Deletes the input user as a member to this 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

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

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

deleteMember

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

Deletes the input group as a member to this 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

addMemberOf

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

Adds this group as a member to input 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

deleteMemberOf

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

Deletes this group as a member to input 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

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.

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

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

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 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

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

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 otions

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 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

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

Parameters:

group - Group entity

direct - if true checks only the direct memberhship 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

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

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

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

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

isOwnerOf

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

Checks if this group is owner of given 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

addOwner

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

Adds the given user as owner of this 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

addOwner

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

Adds the given group as owner of this 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

deleteOwner

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

Deletes the given user as owner of this 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

InvalidAttributesException

deleteOwner

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

Deletes the given group as owner of this 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

InvalidAttributesException

addOwnerOf

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

Adds this group as owner of the given 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

deleteOwnerOf

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

Deletes this group as owner of the given 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

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

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

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

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

isManagerOf

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

Checks if this group is manager of given 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

addManager

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

Adds the given user as manager of this 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

addManager

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

Adds the given group as manager of this 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

deleteManager

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

Deletes the given user as manager of this 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

InvalidAttributesException

deleteManager

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

Deletes the given group as manager of this 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

InvalidAttributesException

addManagerOf

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

Adds this group as manager of the given 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

deleteManagerOf

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

Deletes this group as manager of the given 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

InvalidAttributesException

clone

public Group clone()

Clones this object

Overrides:

clone in class Entity

Returns:

copy of this object