com.netegrity.llsdk6.imsapi.provider
Interface AccessTaskProvider

public interface AccessTaskProvider

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

This and all Identity Manager providers are retrieved through ProviderAccessor.

Access to Access Task Attributes

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

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

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

Identity Manager 6.0

Method Summary

AccessTask	createAccessTask(java.lang.String friendlyName, java.lang.String tag, java.lang.String category, java.lang.String application, ActionType action, ObjectType object) Creates an access task, accepting the default values for a number of its configuration parameters.
AccessTask	createAccessTask(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 access task with the attributes passed in.
AccessTask	findAccessTask(java.lang.String friendlyName) Retrieves the specified access task, using the task's friendly name.
java.util.Vector	findAccessTasksInScope(TSContext tsCtx) Retrieves the set of access tasks which are in scope for the current task executed by the current administrator.
java.util.Vector	findAccessTasksInScope(TSContext tsCtx, AccessTaskFilter additional) Retrieves the set of access tasks which are in scope for the current task executed by the current administrator.
AccessTask	findByTag(java.lang.String tag) Retrieves the specified access task, using the task's tag name.
java.util.Vector	getAccessApplicationNames() Retrieves the names of all the applications associated with access tasks in this environment.
java.util.Vector	getAccessRolesUsingAccessTask(AccessTask task) Retrieves the access roles that contain the specified access task.
AccessTask	getAccessTask(java.lang.String uniqueName) Retrieves the specified access task, using the task's unique name.
java.util.Vector	getAccessTaskCategories() Retrieves the unique names of access task categories in this environment.
java.util.Vector	getAccessTasks() Retrieves all the access tasks in the Identity Manager environment.
java.util.Vector	getAccessTasksForApplication(java.lang.String applicationName) Retrieves the access tasks associated with the specified application.
java.util.Vector	getAdministratorsTasks(User admin) Return a Vector of all Access Tasks this user is authorized to run
java.util.Vector	searchAccessTasks(TaskObjectQuery query) Searches for a subset of the access tasks in the Identity Manager environment.

Method Detail

createAccessTask

AccessTask createAccessTask(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 access 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 createAccessTask().

Parameters:

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

tag - The task tag.

category - The task category (can be null).

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

action - The type of action performed by the task.

object - The type of object directly affected by the task.

Returns:

The newly created access task.

Throws:

com.netegrity.sdk.apiutil.SmApiException

createAccessTask

AccessTask createAccessTask(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 access task with the attributes passed in.

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

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

workflowID - The workflowID for this AccessTask (can be null)

tag - The task tag.

action - The type of action performed by the task.

object - The type of object directly affected by the task.

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.

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

Throws:

com.netegrity.sdk.apiutil.SmApiException

See Also:

Task.FieldId

getAccessTask

AccessTask getAccessTask(java.lang.String uniqueName)
                         throws SmApiException,
                                NoSuchObjectException

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

Parameters:

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

Returns:

The specified access task.

Throws:

NoSuchObjectException - if the object cannot be found.

SmApiException

findAccessTask

AccessTask findAccessTask(java.lang.String friendlyName)
                          throws SmApiException,
                                 NoSuchObjectException

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

Parameters:

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

Returns:

The specified access task.

Throws:

NoSuchObjectException - if the object cannot be found.

SmApiException

findByTag

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

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

Parameters:

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

Returns:

The specified access task.

Throws:

NoSuchObjectException - if the object cannot be found.

SmApiException

getAccessTasks

java.util.Vector getAccessTasks()
                                throws SmApiException

Retrieves all the access tasks in the Identity Manager environment.

Returns:

A Vector of the access tasks.

Throws:

SmApiException

searchAccessTasks

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

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

Parameters:

query - The search filter.

Returns:

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

Throws:

com.netegrity.sdk.apiutil.SmApiException

getAccessTasksForApplication

java.util.Vector getAccessTasksForApplication(java.lang.String applicationName)
                                              throws SmApiException

Retrieves the access tasks associated with the specified application.

Parameters:

applicationName - The application to search for (case sensitive). If null or an empty string is passed, the method retrieves all access tasks that are not associated.with the application.

Returns:

A Vector of the access tasks used in the specified application.

Throws:

SmApiException

getAccessRolesUsingAccessTask

java.util.Vector getAccessRolesUsingAccessTask(AccessTask task)
                                               throws SmApiException

Retrieves the access roles that contain the specified access task.

Parameters:

task - The access task in question.

Returns:

A Vector of the access roles containing the specified access task.

Throws:

SmApiException

getAccessTaskCategories

java.util.Vector getAccessTaskCategories()
                                         throws SmApiException

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

Returns:

A Vector of Strings containing unique category names.

Throws:

SmApiException

getAccessApplicationNames

java.util.Vector getAccessApplicationNames()
                                           throws SmApiException

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

Returns:

A Vector of Strings containing application names.

Throws:

SmApiException

findAccessTasksInScope

java.util.Vector findAccessTasksInScope(TSContext tsCtx)
                                        throws SmApiException

Retrieves the set of access tasks which are in scope for the current task executed by the current administrator.

Returns:

A Vector of access task objects.

Throws:

SmApiException

findAccessTasksInScope

java.util.Vector findAccessTasksInScope(TSContext tsCtx,
                                        AccessTaskFilter additional)
                                        throws SmApiException

Retrieves the set of access tasks which are in scope for the current task executed by the current administrator.

Parameters:

additional - A filter of additional constraints on the search. All constraints are anded with each other and with the scope rules.

Returns:

A Vector of access task objects.

Throws:

SmApiException

getAdministratorsTasks

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

Return a Vector of all Access Tasks this user is authorized to run

Parameters:

admin - - This user

Returns:

Throws:

SmApiException