com.netegrity.llsdk6.imsapi.provider
Interface UserProvider

public interface UserProvider

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

This and all Identity Manager providers are retrieved through ProviderAccessor.

Access to User Objects

This interface provides two ways of accessing user objects:

• Hierarchical access, using specialized forms of the Organization object's generic methods to access the users within an organizational hierarchy.
• Environment-wide access, using methods that access all the users 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 User Attribute Data

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

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

Note: To commit the changes you make to a managed object retrieved through UserProvider, 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

User	createUser(Organization org, java.util.Hashtable attribs) Creates a user object within the specified organization.
User	createUser(Organization org, java.util.Hashtable attribs, AttributeRightsCollection permissions) Creates a user object within the specified organization, including permission requests for the object's attributes.
User	disambiguateUser(java.lang.String name, java.util.Enumeration attributes) Disambiguate the specified user object and attributes from the current Identity Manager environment.
User	findUser(java.lang.String name, java.util.Enumeration attributes) Retrieves the specified user object and attributes from the current Identity Manager environment.
User	findUser(TSContext context, java.lang.String name, AttributeRightsCollection attributes) Retrieves the specified user object and attributes from the current Identity Manager environment, and includes permissions for the specified attributes.
User	findUser(TSContext context, java.lang.String name, AttributeRightsCollection attributes, boolean defaultAttrs) Retrieves the specified user object, the specified object attributes, and optionally, the object's default attributes from the current Identity Manager environment, and includes the appropriate attribute permissions.
boolean	findUserDuplicate(java.lang.String name) Retrieves the specified user object and attributes from the current Identity Manager environment.It will search user with IME's referencing the same user directory but using different object classes also.
java.util.Vector<User>	findUsers(UserFilter uf, OrgMembershipConstraint orgs, AttributeRightsCollection attrs) Retrieves the users matching an attribute filter and an organization membership constraint.
	findUsersInScope(SearchContext searchContext)
java.util.Vector<User>	findUsersInScope(TSContext tsCtx, UserFilter uf, OrgScopeConstraint orgs, AttributeRightsCollection attrs) Deprecated.
java.util.Vector<User>	findUsersInScope(TSContext tsCtx, UserFilter uf, OrgScopeConstraint orgs, AttributeRightsCollection attrs, ObjectType scopingType) Deprecated. Deprecated in Identity Manager 8.1. Use findUsersInScope(), which omits scopingType.
User	getUserFromSMTOKEN(java.lang.String smtoken, java.util.Enumeration attribs) Retrieves the user from an encrypted SMTOKEN with the specified attributes.
java.util.Vector<User>	getUsersInOrg(Organization org, SearchDepthType searchDepth, java.util.Enumeration attributes) Retrieves all user objects in the specified organization(s).
java.util.Vector<User>	getUsersInOrg(Organization org, SearchDepthType searchDepth, java.util.Enumeration attributes, AdminTask task, User admin) Deprecated. Deprecated in IdentityMinder 6.0 Use the getUsersInOrg() version containing TSContext.
java.util.Vector<User>	getUsersInOrg(TSContext context, Organization org, SearchDepthType searchDepth, AttributeRightsCollection attributes) Retrieves all user objects in the specified organization(s) -- attribute permissions are included in the returned objects.
java.util.Vector<User>	searchOrgForUsers(Organization org, java.util.Vector filter, ConjunctionType conj, SearchDepthType searchDepth, java.util.Enumeration attributes) Deprecated.
java.util.Vector<User>	searchOrgForUsers(Organization org, java.util.Vector filter, ConjunctionType conj, SearchDepthType searchDepth, java.util.Enumeration attributes, AdminTask task, User admin) Searches for users within the specified organization(s).
java.util.Vector<User>	searchOrgForUsers(Organization org, java.util.Vector filter, SearchDepthType searchDepth, java.util.Enumeration attributes) Deprecated. Deprecated in IdentityMinder 6.0. Use searchOrgForUsers() containing ConjunctionType.
java.util.Vector<User>	searchOrgForUsers(Organization org, java.util.Vector filter, SearchDepthType searchDepth, java.util.Enumeration attributes, AdminTask task, User admin) Deprecated. Deprecated in IdentityMinder 6.0 Use searchOrgForUsers() containing ConjunctionType.
	searchOrgForUsers(SearchContext searchContext)
java.util.Vector<User>	searchOrgForUsers(TSContext context, Organization org, java.util.Vector filter, ConjunctionType conj, SearchDepthType searchDepth, AttributeRightsCollection attributes, AdminTask task, User admin) Searches for organizations within the specified organization(s) -- attribute permissions are included in the returned objects.

Method Detail

disambiguateUser

User disambiguateUser(java.lang.String name,
                      java.util.Enumeration attributes)
                      throws SmApiException,
                             NoSuchObjectException

Disambiguate the specified user object and attributes from the current Identity Manager environment.

Parameters:

name - The friendly name of the user to retrieve.

attributes - 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 user object, if found, containing the attributes specified in attributes.

Throws:

NoSuchObjectException - if the object cannot be found.

SmApiException - For more general problems with the execution of the call

findUser

User findUser(java.lang.String name,
              java.util.Enumeration attributes)
              throws SmApiException,
                     NoSuchObjectException

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

Parameters:

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

attributes - 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 user object, if found, containing the attributes specified in attributes.

Throws:

NoSuchObjectException - if the object cannot be found.

SmApiException - For more general problems with the execution of the call

findUser

User findUser(TSContext context,
              java.lang.String name,
              AttributeRightsCollection attributes)
              throws SmApiException,
                     NoSuchObjectException

Retrieves the specified user 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 user to retrieve. The name can be a unique name or a friendly name.

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

Returns:

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

Throws:

NoSuchObjectException - if the object cannot be found.

SmApiException - For more general problems with the execution of the call

findUser

User findUser(TSContext context,
              java.lang.String name,
              AttributeRightsCollection attributes,
              boolean defaultAttrs)
              throws SmApiException,
                     NoSuchObjectException

Retrieves the specified user object, the specified object attributes, and optionally, the object's default attributes from the current Identity Manager environment, and includes the appropriate attribute permissions.

Parameters:

context - Context information for the current task session.

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

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

defaultAttrs - If true, the default attributes defined for a User managed object are included in the returned user object. READONLY permission is requested for all default attributes. However, if a default attribute is specified in attributes, the associated permission specified in attributes remains the requested permission.

Returns:

The specfied user object, if found, containing the attributes specified in attributes, the default attributes, if requested, and the appropriate attribute permissions.

Throws:

com.netegrity.llsdk6.imsapi.exception.NoSuchObjectException - if the object cannot be found

com.netegrity.sdk.apiutil.SmApiException - For more general problems with the execution of the call

SmApiException

NoSuchObjectException

findUsers

java.util.Vector<User> findUsers(UserFilter uf,
                                 OrgMembershipConstraint orgs,
                                 AttributeRightsCollection attrs)
                                 throws SmApiException

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

Parameters:

uf - Attribute filter for the search. If no filter is specified, all users in the specified organization scope 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 user objects containing the attributes specified in attrs and the associated permissions.

Throws:

SmApiException

createUser

User createUser(Organization org,
                java.util.Hashtable attribs)
                throws SmApiException

Creates a user object within the specified organization.

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

Parameters:

org - The organization where the user is being created.

attribs - Seed attributes to include in the user object.

Returns:

The new user object.

Throws:

SmApiException

createUser

User createUser(Organization org,
                java.util.Hashtable attribs,
                AttributeRightsCollection permissions)
                throws SmApiException

Creates a user 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 user is being created.

attribs - Seed attributes to include in the user object.

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

Returns:

The new user object.

Throws:

SmApiException

getUsersInOrg

java.util.Vector<User> getUsersInOrg(Organization org,
                                     SearchDepthType searchDepth,
                                     java.util.Enumeration attributes)
                                     throws SmApiException

Retrieves all user 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.

attributes - 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 user objects in the specified organization(s), each containing the attributes specified in attributes.

Throws:

SmApiException

getUsersInOrg

java.util.Vector<User> getUsersInOrg(TSContext context,
                                     Organization org,
                                     SearchDepthType searchDepth,
                                     AttributeRightsCollection attributes)
                                     throws SmApiException

Retrieves all user 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.

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

Returns:

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

Throws:

SmApiException

getUsersInOrg

java.util.Vector<User> getUsersInOrg(Organization org,
                                     SearchDepthType searchDepth,
                                     java.util.Enumeration attributes,
                                     AdminTask task,
                                     User admin)
                                     throws SmApiException

Deprecated. Deprecated in IdentityMinder 6.0 Use the getUsersInOrg() version containing TSContext.

Retrieves all user 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.

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

task - The task currently being executed.

admin - The admin executing the task.

Returns:

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

Throws:

SmApiException

searchOrgForUsers

java.util.Vector<User> searchOrgForUsers(Organization org,
                                         java.util.Vector filter,
                                         SearchDepthType searchDepth,
                                         java.util.Enumeration attributes)
                                         throws SmApiException

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

Searches for users 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.

attributes - 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 users found in the search.

Throws:

SmApiException

searchOrgForUsers

java.util.Vector<User> searchOrgForUsers(Organization org,
                                         java.util.Vector filter,
                                         SearchDepthType searchDepth,
                                         java.util.Enumeration attributes,
                                         AdminTask task,
                                         User admin)
                                         throws SmApiException

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

Searches for users 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.

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

task - The task currently being executed.

admin - The admin executing the task.

Returns:

A Vector of the users found in the search.

Throws:

SmApiException

searchOrgForUsers

java.util.Vector<User> searchOrgForUsers(TSContext context,
                                         Organization org,
                                         java.util.Vector filter,
                                         ConjunctionType conj,
                                         SearchDepthType searchDepth,
                                         AttributeRightsCollection attributes,
                                         AdminTask task,
                                         User admin)
                                         throws SmApiException

Searches for organizations 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.

attributes - A collection of AttributeRight

task - The task currently being executed.

admin - The admin executing the task.

Returns:

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

Throws:

SmApiException

searchOrgForUsers

java.util.Vector<User> searchOrgForUsers(Organization org,
                                         java.util.Vector filter,
                                         ConjunctionType conj,
                                         SearchDepthType searchDepth,
                                         java.util.Enumeration attributes)
                                         throws SmApiException

Deprecated.

Searches for users 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.

attributes - 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 users found in the search.

Throws:

SmApiException

searchOrgForUsers

 searchOrgForUsers(SearchContext searchContext)
                        throws SmApiException

Throws:

SmApiException

searchOrgForUsers

java.util.Vector<User> searchOrgForUsers(Organization org,
                                         java.util.Vector filter,
                                         ConjunctionType conj,
                                         SearchDepthType searchDepth,
                                         java.util.Enumeration attributes,
                                         AdminTask task,
                                         User admin)
                                         throws SmApiException

Searches for users 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.

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

task - The task currently being executed.

admin - The admin executing the task.

Returns:

A Vector of the users found in the search.

Throws:

SmApiException

findUsersInScope

java.util.Vector<User> findUsersInScope(TSContext tsCtx,
                                        UserFilter uf,
                                        OrgScopeConstraint orgs,
                                        AttributeRightsCollection attrs)
                                        throws SmApiException

Deprecated.

Retrieves the users 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.

uf - Attribute filter for the search. If no filter is specified, all users 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 user objects containing the attributes specified in attrs and the associated permissions.

Throws:

SmApiException

findUsersInScope

 findUsersInScope(SearchContext searchContext)
                       throws SmApiException

Throws:

SmApiException

findUsersInScope

java.util.Vector<User> findUsersInScope(TSContext tsCtx,
                                        UserFilter uf,
                                        OrgScopeConstraint orgs,
                                        AttributeRightsCollection attrs,
                                        ObjectType scopingType)
                                        throws SmApiException

Deprecated. Deprecated in Identity Manager 8.1. Use findUsersInScope(), which omits scopingType.

Retrieves the users 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.

uf - Attribute filter for the search. If no filter is specified, all users 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.

scopingType -

Returns:

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

Throws:

SmApiException

findUserDuplicate

boolean findUserDuplicate(java.lang.String name)
                          throws SmApiException

Retrieves the specified user object and attributes from the current Identity Manager environment.It will search user with IME's referencing the same user directory but using different object classes also.

Parameters:

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

Returns:

true if found, otherwise false.

Throws:

NoSuchObjectException - if the object cannot be found.

SmApiException - For more general problems with the execution of the call

getUserFromSMTOKEN

User getUserFromSMTOKEN(java.lang.String smtoken,
                        java.util.Enumeration attribs)
                        throws SmApiException,
                               NoSuchObjectException

Retrieves the user from an encrypted SMTOKEN with the specified attributes. The encrypted SMTOKEN comes from SiteMinder Password Services.

Parameters:

smtoken - The encrypted SMTOKEN from SiteMinder Password Services.

attributes - 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 specfied user object, if found, containing the attributes specified in attributes and the associated permissions.

Throws:

NoSuchObjectException - if the object cannot be found.

SmApiException - For more general problems with the execution of the call