com.netegrity.llsdk6.imsapi.provider
Interface AdminTaskProvider

public interface AdminTaskProvider

Lets you create or retrieve admin tasks in the current Identity Manager environment.

This and all Identity Manager providers are retrieved through ProviderAccessor.

Access to Admin Task Attributes

After you retrieve an admin task object, you access its attribute data through the methods in the base interface Task.

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

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

AdminTask	createAdminTask(java.lang.String friendlyName, java.lang.String tag, java.lang.String category, java.lang.String application, ActionType action, ObjectType object) Creates an admin task, accepting the default values for a number of its configuration parameters.
AdminTask	createAdminTask(java.lang.String friendlyName, java.lang.String description, java.lang.String category, java.lang.String application, java.lang.String workflowID, java.lang.String tag, ActionType action, ObjectType object, boolean system, boolean auditable, boolean provisionable, boolean workflowable, boolean external, boolean hidden, boolean publicTask, boolean webserviceTask, java.lang.String url) Creates an admin task with its configuration parameters passed into the method.
AdminTask	findAdminTask(java.lang.String friendlyName) Retrieves the specified admin task, using the task's friendly name.
AdminTask	findByTag(java.lang.String tag) Retrieves the specified admin task, using the task's tag name.
java.util.Vector	getAdminApplicationNames() Retrieves the names of all the applications associated with admin tasks in this environment.
java.util.Vector	getAdminApplicationNamesForUser(User user) Retrieves the names of all the applications that are associated with admin tasks and that the specified user can perform in this environment
java.util.Vector	getAdministratorsTasks(User admin) Retrieves the admin task assignments for the administrator.
java.util.Vector	getAdminRolesUsingAdminTask(AdminTask task) Retrieves the admin roles that contain the specified admin task.
AdminTask	getAdminTask(java.lang.String uniqueName) Retrieves the specified admin task, using the task's unique name.
java.util.Vector	getAdminTaskCategories() Retrieves the unique names of admin task categories in this environment.
java.util.Vector	getAdminTasks() Retrieves all the admin tasks in the Identity Manager environment.
java.util.Vector	searchAdminTasks(TaskObjectQuery query) Searches for a subset of the admin tasks in the Identity Manager environment.

Method Detail

createAdminTask

AdminTask createAdminTask(java.lang.String friendlyName,
                          java.lang.String tag,
                          java.lang.String category,
                          java.lang.String application,
                          ActionType action,
                          ObjectType object)
                          throws com.netegrity.sdk.apiutil.SmApiException

Creates an admin task, accepting the default values for a number of its configuration parameters.

This method accepts the following default configuration values:

• true
  • auditable
  • provisionable
  • workflowable
  • system
• false
  • external
  • hidden
  • public
• An empty string
  • WorkflowID
  • url
  • description

For descriptions of the above parameters, see createAdminTask().

Parameters:

friendlyName - The friendly name for the task (must not be null).

tag - The task tag.

category - The task category (can be null). For example, a Create User or Modify User task might be grouped under a Users category.

application - The application associated with the task, if any (can be null).

action - The type of action performed by the task -- for example, CREATE, MODIFY, and DELETE actions.

object - The type of object directly affected by the task -- for example, USER, GROUP, and ORG objects.

Returns:

The newly created admin task.

Throws:

com.netegrity.sdk.apiutil.SmApiException

createAdminTask

AdminTask createAdminTask(java.lang.String friendlyName,
                          java.lang.String description,
                          java.lang.String category,
                          java.lang.String application,
                          java.lang.String workflowID,
                          java.lang.String tag,
                          ActionType action,
                          ObjectType object,
                          boolean system,
                          boolean auditable,
                          boolean provisionable,
                          boolean workflowable,
                          boolean external,
                          boolean hidden,
                          boolean publicTask,
                          boolean webserviceTask,
                          java.lang.String url)
                          throws com.netegrity.sdk.apiutil.SmApiException

Creates an admin task with its configuration parameters passed into the method.

Parameters:

friendlyName - The friendly name for the task (must not be null).

description - The description of the task (can be null).

category - The task category (can be null). For example, a Create User or Modify User task might be grouped under a Users category.

application - The application associated with the task, if any (can be null).

workflowID - The workflow ID associated with the task -- for example, CreateUserApproveProcess (can be null).

tag - The task tag. Alphanumeric only -- no spaces or special characters.

action - The type of action performed by the task -- for example, CREATE, MODIFY, and DELETE actions.

object - The type of object directly affected by the task -- for example, USER, GROUP, and ORG objects.

system - Reserved for future use.

auditable - true if the task is eligble for auditing. Auditable tasks can be included in reports.

provisionable - true if the task is eligible for provisioning.

workflowable - true if the task is eligible for workflow control.

external - true if the task is an external task. An external task is executed by an application other than Identity Manager.

hidden - true if the task is a hidden task. A hidden task is not displayed in menus. You typically enable this feature when the task is only invoked through a URL or another task.

publicTask - true if the task is a public task. A public task is one that a user can invoke without first having to log in -- for example, self-registration and forgotten password tasks.

webserviceTask - true if the task is available through the Identity Manager Task Execution Web Service (TEWS). TEWS allows a third-party application to submit a remote task request to Identity Manager.

url - The URL associated with this task. A URL is typicaly used by external tasks to provide a UI link (can be null).

Returns:

The newly created admin task.

Throws:

com.netegrity.sdk.apiutil.SmApiException

getAdminTask

AdminTask getAdminTask(java.lang.String uniqueName)
                       throws SmApiException,
                              NoSuchObjectException

Retrieves the specified admin task, using the task's unique name.

Parameters:

uniqueName - The unique name of the admin task to retrieve.

Returns:

The specified admin task.

Throws:

NoSuchObjectException - if the object cannot be found.

SmApiException

findAdminTask

AdminTask findAdminTask(java.lang.String friendlyName)
                        throws SmApiException,
                               NoSuchObjectException

Retrieves the specified admin task, using the task's friendly name.

Parameters:

friendlyName - The friendly name of the admin task to retrieve.

Returns:

The specified admin task.

Throws:

NoSuchObjectException - if the object cannot be found.

SmApiException

findByTag

AdminTask findByTag(java.lang.String tag)
                    throws SmApiException,
                           NoSuchObjectException

Retrieves the specified admin task, using the task's tag name.

Parameters:

tag - The tag name of the admin task to retrieve.

Returns:

The specified admin task.

Throws:

NoSuchObjectException - if the object cannot be found.

SmApiException

getAdminTasks

java.util.Vector getAdminTasks()
                               throws SmApiException

Retrieves all the admin tasks in the Identity Manager environment.

Returns:

A Vector of the admin tasks.

Throws:

SmApiException

searchAdminTasks

java.util.Vector searchAdminTasks(TaskObjectQuery query)
                                  throws com.netegrity.sdk.apiutil.SmApiException

Searches for a subset of the admin tasks in the Identity Manager environment.

Parameters:

query - The search filter.

Returns:

A Vector of the admin task objects found in the search.

Throws:

com.netegrity.sdk.apiutil.SmApiException

getAdminRolesUsingAdminTask

java.util.Vector getAdminRolesUsingAdminTask(AdminTask task)
                                             throws SmApiException

Retrieves the admin roles that contain the specified admin task.

Parameters:

task - The admin task in question.

Returns:

A Vector of the admin roles in the specified organization.

Throws:

SmApiException

getAdminTaskCategories

java.util.Vector getAdminTaskCategories()
                                        throws SmApiException

Retrieves the unique names of admin task categories in this environment.

Returns:

A Vector of Strings containing unique category names.

Throws:

SmApiException

getAdminApplicationNames

java.util.Vector getAdminApplicationNames()
                                          throws SmApiException

Retrieves the names of all the applications associated with admin tasks in this environment.

Returns:

A Vector of Strings containing application names.

Throws:

SmApiException

getAdminApplicationNamesForUser

java.util.Vector getAdminApplicationNamesForUser(User user)
                                                 throws SmApiException

Retrieves the names of all the applications that are associated with admin tasks and that the specified user can perform in this environment

Parameters:

user - The user who is authorized to perform the admin tasks.

Returns:

A Vector of Strings containing application names.

Throws:

SmApiException

getAdministratorsTasks

java.util.Vector getAdministratorsTasks(User admin)
                                        throws SmApiException

Retrieves the admin task assignments for the administrator.

Parameters:

admin - The administrator whose admin task assignments are being retrieved.

Returns:

A Vector of admin tasks.

Throws:

SmApiException