com.netegrity.llsdk6.imsapi.provider
Interface GroupProvider

public interface GroupProvider

Lets you create or retrieve group objects in the current Identity Manager environment.

This and all Identity Manager providers are retrieved through ProviderAccessor.

Access to Group Objects

This interface provides two ways of accessing group objects:

• Hierarchical access, using specialized forms of the Organization object's generic methods to access the groups within an organizational hierarchy.
• Environment-wide access, using methods that access all the groups in the current Identity Manager environment.

Object Attributes and Attribute Permissions

You can specify the attributes to include in the retrieved objects. You do so through overloaded methods that let you choose between the following:

• Passing in just the names of the attributes to include. These attributes become part of a returned object's internal structure. Permissions associated with the attributes are not included.
• Passing in the names of the attributes and a permission request for each attribute. Attribute names and permission requests are passed in AttributeRightsCollection. The managed objects that are returned to the method include the specified attributes and their applicable permissions, as described below.

Access to Group Attribute Data

After you retrieve a group object, you access its attribute data through the methods in AttributeCollection.

Typically, managed objects retrieved through GroupProvider are accessed for reading purposes only. However, on occassion, business logic task handlers and event listeners may need to modify objects retrieved through GroupProvider.

Note: To commit the changes you make to a managed object retrieved through GroupProvider, call modifyObject(). The changes are then immediately persisted to the data store. No Identity Manager events are generated, and no workflow approvals, auditing, or security checks are performed.

Since:

IdentityMinder 6.0

Method Summary

Group	createGroup(Organization org, java.util.Hashtable attribs) Creates a group object within the specified organization.
Group	createGroup(Organization org, java.util.Hashtable attribs, AttributeRightsCollection permissions) Creates a group object within the specified organization, including permission requests for the object's attributes.
Group	findGroup(java.lang.String name, java.util.Enumeration attribs) Retrieves the specified group object and attributes from the current Identity Manager environment.
Group	findGroup(TSContext context, java.lang.String name, AttributeRightsCollection attribs) Retrieves the specified group object and attributes from the current Identity Manager environment, and includes permissions for the specified attributes.
java.util.Vector	findGroups(GroupFilter gf, OrgMembershipConstraint orgs, AttributeRightsCollection attrs) Retrieves the groups matching an attribute filter and an organization membership constraint.
java.util.Vector	findGroupsInScope(TSContext tsCtx, GroupFilter gf, OrgScopeConstraint orgs, AttributeRightsCollection attrs) Retrieves the groups within the current task that match the specified search criteria.
java.util.Vector	getGroupsAdminCanAssign(TSContext context, Organization searchTop, SearchDepthType searchDepth, AttributeRightsCollection attribs) Retrieves the groups in the specified organization(s) for which the current user is an administrator.
java.util.Vector	getGroupsInOrg(Organization org, SearchDepthType searchDepth, java.util.Enumeration attribs) Retrieves all group objects in the specified organization(s).
java.util.Vector	getGroupsInOrg(TSContext context, Organization org, SearchDepthType searchDepth, AttributeRightsCollection attribs) Retrieves all group objects in the specified organization(s) -- attribute permissions are included in the returned objects.
java.util.Vector	getSelfSubscribingGroupsForNewUser(Organization org, java.util.Enumeration attribs) Retrieves the self-subscribing groups available to a new user in the specified organization.
java.util.Vector	getSelfSubscribingGroupsForNewUser(TSContext context, Organization org, AttributeRightsCollection attribs) Retrieves the self-subscribing groups available to a new user in the specified organization -- attribute permissions are included in the returned objects.
ApiResultSet	pagedGetGroupsInOrg(Organization org, SearchDepthType searchDepth, java.util.Enumeration attribs, SearchCursor cursor) Deprecated. As of FW 2.0, no alternate method exists. Retrieves and sorts all group objects in the specified organization(s). This method is a specialization of Organization.getMembers(ObjectType, SearchDepthType).
ApiResultSet	pagedGetGroupsInOrg(TSContext context, Organization org, SearchDepthType searchDepth, AttributeRightsCollection attribs, SearchCursor cursor) Deprecated. As of FW 2.0, no alternate method exists. Retrieves and sorts all group objects in the specified organization(s) -- attribute permissions are included in the returned objects. This method is a specialization of Organization.getMembers(ObjectType, SearchDepthType).
ApiResultSet	pagedSearchOrgForGroups(Organization org, java.util.Vector filter, ConjunctionType conj, SearchDepthType searchDepth, java.util.Enumeration attribs, SearchCursor cursor) Deprecated. As of FW 2.0, no alternate method exists. Searches for groups within the specified organization(s) and sorts the result. This method is a specialization of Organization.searchManagedObjects().
ApiResultSet	pagedSearchOrgForGroups(Organization org, java.util.Vector filter, SearchDepthType searchDepth, java.util.Enumeration attribs, SearchCursor cursor) Deprecated. Deprecated in IdentityMinder 6.0. Use pagedSearchOrgForGroups() containing ConjunctionType.
ApiResultSet	pagedSearchOrgForGroups(TSContext context, Organization org, java.util.Vector filter, ConjunctionType conj, SearchDepthType searchDepth, AttributeRightsCollection attribs, SearchCursor cursor) Searches for groups within the specified organization(s) and sorts the result -- attribute permissions are included in the returned objects.
java.util.Vector	searchOrgForGroups(Organization org, java.util.Vector filter, ConjunctionType conj, SearchDepthType searchDepth, java.util.Enumeration attribs) Searches for groups within the specified organization(s).
java.util.Vector	searchOrgForGroups(Organization org, java.util.Vector filter, SearchDepthType searchDepth, java.util.Enumeration attribs) Deprecated. Deprecated in IdentityMinder 6.0. Use searchOrgForGroups() containing ConjunctionType.
java.util.Vector	searchOrgForGroups(TSContext context, Organization org, java.util.Vector filter, ConjunctionType conj, SearchDepthType searchDepth, AttributeRightsCollection attribs) Searches for groups within the specified organization(s) -- attribute permissions are included in the returned objects.

Method Detail

findGroup

Group findGroup(java.lang.String name,
                java.util.Enumeration attribs)
                throws com.netegrity.sdk.apiutil.SmApiException,
                       NoSuchObjectException

Retrieves the specified group object and attributes from the current Identity Manager environment.

Parameters:

name - The name of the group to retrieve. The name can be a unique name or a friendly name.

attribs - An Enumeration of Strings containing names of the attributes to include in the retrieved object. If you pass an empty Enumeration, no attributes are included. If you pass null, all attributes are included.

Returns:

The specfied group object, if found, containing the attributes specified in attribs.

Throws:

NoSuchObjectException - if the object cannot be found.

com.netegrity.sdk.apiutil.SmApiException

findGroup

Group findGroup(TSContext context,
                java.lang.String name,
                AttributeRightsCollection attribs)
                throws com.netegrity.sdk.apiutil.SmApiException,
                       NoSuchObjectException

Retrieves the specified group object and attributes from the current Identity Manager environment, and includes permissions for the specified attributes.

Parameters:

context - Context information for the current task session.

name - The name of the group to retrieve. The name can be a unique name or a friendly name.

attribs - A collection of AttributeRight objects, each containing an attribute name and a permission request.

Returns:

The specfied group object, if found, containing the attributes specified in attribs and the associated permissions.

Throws:

NoSuchObjectException - if the object cannot be found.

com.netegrity.sdk.apiutil.SmApiException

findGroups

java.util.Vector findGroups(GroupFilter gf,
                            OrgMembershipConstraint orgs,
                            AttributeRightsCollection attrs)
                            throws SmApiException

Retrieves the groups matching an attribute filter and an organization membership constraint.

Parameters:

gf - Attribute filter for the search. If no filter is specified, all groups in the specified organizations will be returned.

orgs - Organization constraint that defines the scope for the search. If no constraint is specified, the search will occur within all organizations.

attrs - A collection of AttributeRight objects, each containing an attribute name and a permission request.

Returns:

A Vector of group objects containing the attributes specified in attrs and the associated permissions.

Throws:

SmApiException

createGroup

Group createGroup(Organization org,
                  java.util.Hashtable attribs)
                  throws SmApiException

Creates a group object within the specified organization.

This method is a specialization of Organization.createManagedObject().

Parameters:

org - The organization where the group is being created.

attribs - Seed attributes to include in the group object.

Returns:

The new group object.

Throws:

SmApiException

createGroup

Group createGroup(Organization org,
                  java.util.Hashtable attribs,
                  AttributeRightsCollection permissions)
                  throws SmApiException

Creates a group object within the specified organization, including permission requests for the object's attributes.

This method is a specialization of Organization.createManagedObject().

Parameters:

org - The organization where the group is being created.

attribs - Seed attributes to include in the group object.

permissions - A collection of AttributeRight objects, each containing an attribute name and a permission request.

Returns:

The new group object.

Throws:

SmApiException

getGroupsInOrg

java.util.Vector getGroupsInOrg(Organization org,
                                SearchDepthType searchDepth,
                                java.util.Enumeration attribs)
                                throws SmApiException

Retrieves all group objects in the specified organization(s).

This method is a specialization of Organization.getMembers(ObjectType, SearchDepthType).

Parameters:

org - The organization to search.

searchDepth - Indicates whether to search just the specified organization or also its children.

attribs - An Enumeration of Strings that specifies the attributes to include in retrieved objects. If you pass an empty Enumeration, no attributes are included. If you pass null, all attributes are included.

Returns:

A Vector of group objects in the specified organization(s), each containing the attributes specified in attribs.

Throws:

SmApiException

getGroupsInOrg

java.util.Vector getGroupsInOrg(TSContext context,
                                Organization org,
                                SearchDepthType searchDepth,
                                AttributeRightsCollection attribs)
                                throws SmApiException

Retrieves all group objects in the specified organization(s) -- attribute permissions are included in the returned objects.

This method is a specialization of Organization.getMembers(ObjectType, SearchDepthType).

Parameters:

context - Context information for the current task session.

org - The organization to search.

searchDepth - Indicates whether to search just the specified organization or also its children.

attribs - A collection of AttributeRight objects, each containing an attribute name and a permission request.

Returns:

A Vector of group objects in the specified organization(s), each containing the attributes specified in attribs and the associated permissions.

Throws:

SmApiException

pagedGetGroupsInOrg

ApiResultSet pagedGetGroupsInOrg(Organization org,
                                 SearchDepthType searchDepth,
                                 java.util.Enumeration attribs,
                                 SearchCursor cursor)
                                 throws SmApiException

Deprecated. As of FW 2.0, no alternate method exists.

Retrieves and sorts all group objects in the specified organization(s).

This method is a specialization of Organization.getMembers(ObjectType, SearchDepthType).

Parameters:

org - The organization to search.

searchDepth - Indicates whether to search just the specified organization or also its children.

attribs - An Enumeration of Strings that specifies the attributes to include in retrieved objects. If you pass an empty Enumeration, no attributes are included. If you pass null, all attributes are included.

cursor - Instructions for sorting the retrieved objects.

Returns:

The sorted group objects retrieved from the specified organization(s), each containing the attributes specified in attribs.

Throws:

SmApiException

pagedGetGroupsInOrg

ApiResultSet pagedGetGroupsInOrg(TSContext context,
                                 Organization org,
                                 SearchDepthType searchDepth,
                                 AttributeRightsCollection attribs,
                                 SearchCursor cursor)
                                 throws SmApiException

Deprecated. As of FW 2.0, no alternate method exists.

Retrieves and sorts all group objects in the specified organization(s) -- attribute permissions are included in the returned objects.

This method is a specialization of Organization.getMembers(ObjectType, SearchDepthType).

Parameters:

context - Context information for the current task session.

org - The organization to search.

searchDepth - Indicates whether to search just the specified organization or also its children.

attribs - A collection of AttributeRight objects, each containing an attribute name and a permission request.

cursor - Instructions for sorting the retrieved objects.

Returns:

The sorted group objects in the specified organization(s), each containing the attributes specified in attribs and the associated permissions.

Throws:

SmApiException

searchOrgForGroups

java.util.Vector searchOrgForGroups(Organization org,
                                    java.util.Vector filter,
                                    SearchDepthType searchDepth,
                                    java.util.Enumeration attribs)
                                    throws SmApiException

Deprecated. Deprecated in IdentityMinder 6.0. Use searchOrgForGroups() containing ConjunctionType.

Searches for groups within the specified organization(s).

This method is a specialization of Organization.searchManagedObjects().

Parameters:

org - The organization to search.

filter - A Vector of SearchExpression objects that must all match the returned objects (all SearchExpression objects in the Vector are ANDed). If there is anything else in the Vector, an exception is thrown.

searchDepth - Indicates whether to search just the specified organization or also its children.

attribs - An Enumeration of Strings that specifies the attributes to include in retrieved objects. If you pass an empty Enumeration, no attributes are included. If you pass null, all attributes are included.

Returns:

A Vector of the groups found in the search.

Throws:

SmApiException

searchOrgForGroups

java.util.Vector searchOrgForGroups(Organization org,
                                    java.util.Vector filter,
                                    ConjunctionType conj,
                                    SearchDepthType searchDepth,
                                    java.util.Enumeration attribs)
                                    throws SmApiException

Searches for groups within the specified organization(s).

This method is a specialization of Organization.searchManagedObjects().

Parameters:

org - The organization to search.

filter - A Vector of SearchExpression objects. If there is anything else in the Vector, an exception is thrown.

conj - A conjunction (such as AND or OR) for combining expressions in the search filter.

searchDepth - Indicates whether to search just the specified organization or also its children.

attribs - An Enumeration of Strings that specifies the attributes to include in retrieved objects. If you pass an empty Enumeration, no attributes are included. If you pass null, all attributes are included.

Returns:

A Vector of the groups found in the search.

Throws:

SmApiException

searchOrgForGroups

java.util.Vector searchOrgForGroups(TSContext context,
                                    Organization org,
                                    java.util.Vector filter,
                                    ConjunctionType conj,
                                    SearchDepthType searchDepth,
                                    AttributeRightsCollection attribs)
                                    throws SmApiException

Searches for groups within the specified organization(s) -- attribute permissions are included in the returned objects.

This method is a specialization of Organization.searchManagedObjects().

Parameters:

context - Context information for the current task session.

org - The organization to search.

filter - A Vector of SearchExpression objects. If there is anything else in the Vector, an exception is thrown.

conj - A conjunction (such as AND or OR) for combining expressions in the search filter.

searchDepth - Indicates whether to search just the specified organization or also its children.

attribs - A collection of AttributeRight objects, each containing an attribute name and a permission request.

Returns:

A Vector of the groups found in the search, with attribute permissions included.

Throws:

SmApiException

pagedSearchOrgForGroups

ApiResultSet pagedSearchOrgForGroups(Organization org,
                                     java.util.Vector filter,
                                     SearchDepthType searchDepth,
                                     java.util.Enumeration attribs,
                                     SearchCursor cursor)
                                     throws SmApiException

Deprecated. Deprecated in IdentityMinder 6.0. Use pagedSearchOrgForGroups() containing ConjunctionType.

Searches for groups within the specified organization(s) and sorts the result.

This method is a specialization of Organization.searchManagedObjects().

Parameters:

org - The organization to search.

filter - A Vector of SearchExpression objects that must all match the returned objects (all SearchExpression objects in the Vector are ANDed). If there is anything else in the Vector, an exception is thrown.

searchDepth - Indicates whether to search just the specified organization or also its children.

attribs - An Enumeration of Strings that specifies the attributes to include in retrieved objects. If you pass an empty Enumeration, no attributes are included. If you pass null, all attributes are included.

cursor - Instructions for sorting the retrieved objects.

Returns:

The sorted group objects retrieved from the specified organization(s), each containing the attributes specified in attribs.

Throws:

SmApiException

pagedSearchOrgForGroups

ApiResultSet pagedSearchOrgForGroups(Organization org,
                                     java.util.Vector filter,
                                     ConjunctionType conj,
                                     SearchDepthType searchDepth,
                                     java.util.Enumeration attribs,
                                     SearchCursor cursor)
                                     throws SmApiException

Deprecated. As of FW 2.0, no alternate method exists.

Searches for groups within the specified organization(s) and sorts the result.

This method is a specialization of Organization.searchManagedObjects().

Parameters:

org - The organization to search.

filter - A Vector of SearchExpression objects. If there is anything else in the Vector, an exception is thrown.

conj - A conjunction (such as AND or OR) for combining expressions in the search filter.

searchDepth - Indicates whether to search just the specified organization or also its children.

attribs - An Enumeration of Strings that specifies the attributes to include in retrieved objects. If you pass an empty Enumeration, no attributes are included. If you pass null, all attributes are included.

cursor - Instructions for sorting the retrieved objects.

Returns:

The sorted group objects retrieved from the specified organization(s), each containing the attributes specified in attribs.

Throws:

SmApiException

pagedSearchOrgForGroups

ApiResultSet pagedSearchOrgForGroups(TSContext context,
                                     Organization org,
                                     java.util.Vector filter,
                                     ConjunctionType conj,
                                     SearchDepthType searchDepth,
                                     AttributeRightsCollection attribs,
                                     SearchCursor cursor)
                                     throws SmApiException

Searches for groups within the specified organization(s) and sorts the result -- attribute permissions are included in the returned objects.

This method is a specialization of Organization.searchManagedObjects().

Parameters:

context - Context information for the current task session.

org - The organization to search.

filter - A Vector of SearchExpression objects. If there is anything else in the Vector, an exception is thrown.

conj - A conjunction (such as AND or OR) for combining expressions in the search filter.

searchDepth - Indicates whether to search just the specified organization or also its children.

attribs - A collection of AttributeRight objects, each containing an attribute name and a permission request.

cursor - Instructions for sorting the retrieved objects.

Returns:

The sorted group objects retrieved from the specified organization(s). The returned objects contain the attributes specified in attribs and their associated permissions.

Throws:

SmApiException

getSelfSubscribingGroupsForNewUser

java.util.Vector getSelfSubscribingGroupsForNewUser(Organization org,
                                                    java.util.Enumeration attribs)
                                                    throws SmApiException

Retrieves the self-subscribing groups available to a new user in the specified organization.

This method is useful during a self-subscription operation for a new user. Pass in the organization where the user will be created, and the method returns the groups to which the user can self-subscribe.

Parameters:

org - The organization to search.

attribs - An Enumeration of Strings that specifies the attributes to include in retrieved objects. If you pass an empty Enumeration, no attributes are included. If you pass null, all attributes are included.

Returns:

The self-subscribing groups in the specified organization.

Throws:

SmApiException

getSelfSubscribingGroupsForNewUser

java.util.Vector getSelfSubscribingGroupsForNewUser(TSContext context,
                                                    Organization org,
                                                    AttributeRightsCollection attribs)
                                                    throws SmApiException

Retrieves the self-subscribing groups available to a new user in the specified organization -- attribute permissions are included in the returned objects.

This method is useful during a self-subscription operation. Pass in the organization where the user will be created, and the method returns the groups to which the user can self-subscribe.

Parameters:

context - Context information for the current task session.

org - The organization to search.

attribs - A collection of AttributeRight objects, each containing an attribute name and a permission request.

Returns:

The self-subscribing groups in the specified organization. The returned objects include the attributes specified in attribs and their associated permissions.

Throws:

SmApiException

getGroupsAdminCanAssign

java.util.Vector getGroupsAdminCanAssign(TSContext context,
                                         Organization searchTop,
                                         SearchDepthType searchDepth,
                                         AttributeRightsCollection attribs)
                                         throws SmApiException

Retrieves the groups in the specified organization(s) for which the current user is an administrator.

Parameters:

context - Context information about the current task, such as the user who is executing the task.

searchTop - The organization to search.

searchDepth - Indicates whether to search just the specified organization or also its children.

attribs - A collection of AttributeRight objects, each containing an attribute name and a permission request.

Returns:

The groups for which the current user is an administrator. The group objects contain the attributes specified in attribs and the associated permissions

Throws:

SmApiException

findGroupsInScope

java.util.Vector findGroupsInScope(TSContext tsCtx,
                                   GroupFilter gf,
                                   OrgScopeConstraint orgs,
                                   AttributeRightsCollection attrs)
                                   throws SmApiException

Retrieves the groups within the current task that match the specified search criteria.

Parameters:

tsCtx - Context information about the current task, such as the user who is executing the task.

gf - Attribute filter for the search. If no filter is specified, all groups matching the other criteria will be returned.

orgs - Organization scope to search. If no constraint is specified, the search will occur within all organizations in the task context.

attrs - A collection of AttributeRight objects, each containing an attribute name and a permission request.

Returns:

A Vector of group objects containing the attributes specified in attrs and the associated permissions.

Throws:

SmApiException