com.netegrity.imapi
Interface TaskInfo

All Known Subinterfaces:

BLTHContext, EventContext, EventROContext, ExposedEventContextInformation, ExposedTaskContextInformation, FieldContext, IMContext, IMPersistentContext, LogicalAttributeContext, NotificationRuleContext, ParticipantResolverContext, ScreenContext, TabControllerContext, TabSequenceContext, WorkflowContext

public interface TaskInfo

Provides information about the current task context -- for example, the time the task was created, the name and unique identifier of the administrator who is executing the task, and the organization associated with the subject of the task.

The task's subject is the object that is directly affected by the task. For example, for a Create User task, the subject is User.

The TaskInfo interface is part of the core Identity Manager API architecture. The ...Context object in each Identity Manager API inherits TaskInfo methods.

Since:

IdentityMinder 5.6

Method Summary

void	addErrorObject(java.lang.String key, java.lang.Object[] values, java.lang.String tabName) Add a task error object to the task session.
void	addMessageObject(IMSException ex, java.lang.String component, ProcessStep processStep, ErrorLevel errorLevel) Adds a response message that is displayed as a part of the task submission acknowledgement.
void	addMessageObject(java.lang.String message, java.lang.String component, ProcessStep processStep, ErrorLevel errorLevel) Adds a response message that is displayed as a part of the task submission acknowledgement.
void	addStatusDetail(RuntimeStatusDetail rst) Add a statusDetail record to the Runtime status detail.
RuntimeStatusDetail	createRuntimeStatusDetail() Get a instance of a RuntimeStatusDetail record.
ActionType	getActionType() Return the ActionType of the current task.
java.lang.String	getAdminFriendlyName() Retrieves the name of the administrator who is executing the task.
User	getAdministrator() Retrieves the administrator who is executing the task.
AdminTask	getAdminTask() Retrieves the admin task being executed.
java.lang.String	getAdminUniqueName() Retrieves the unique identifier of the administrator who is executing the task.
java.lang.String	getAuthDirFriendlyName() Returns the friendly name of the directory where the administrator who is executing the task was authenticated.
java.lang.String	getAuthDirUniqueName() Retrieves the unique name of the user directory where the administrator who is executing the task was authenticated.
java.lang.String	getEnvironmentFriendlyName() Retrieves the name of the Identity Manager environment where the task is being executed.
java.lang.String	getEnvironmentUniqueName() Retrieves the unique identifier for the Identity Manager environment
Organization	getObjectOrganization() Retrieves the organization of the task's subject.
java.lang.String	getObjectOrganizationFriendlyName() Retrieves the friendly name of the subject's organization.
java.util.Date	getSessionCreateTime() Retrieves the creation date of the task context.
java.lang.String	getSessionId() Retrieves the Identity Manager task context ID.
java.lang.String	getSiteMinderSessionId() Retrieves the unique ID of a SiteMinder session.
java.lang.String	getSiteMinderSessionSpec() Retrieves the SiteMinder session specification.
java.lang.String	getSiteMinderTransactionId() Retrieves the transaction ID of a SiteMinder request.
java.lang.String	getSMHeader(java.lang.String headerName) Retrieves the specified SiteMinder header information from the task session.
ManagedObject	getSubject() Return the subject for the current task.
java.util.Vector	getSubjects() Return the subjects for the current task.
java.lang.String	getTaskApplication() Retrieves the name of the application associated with the current task.
java.lang.String	getTaskCategory() Retrieves the category of the current task.
java.lang.String	getTaskFriendlyName() Retrieves the user-defined name for the task.
java.lang.String	getTaskUniqueName() Retrieves the unique identifier for the task.
TSContext	getTSContext() Retrieves the task session context information for the current task session.
java.util.Locale	getUserLocale() Retrieves the java.util.Locale object representing the locale where the current task is being executed -- for example, the browser locale of the administrator executing a task.
boolean	isAuditableTask() Retrives the Auditable flag of the current task.
boolean	isTaskReadOnly() Specifies whether the current task is a read-only task.
boolean	isWorkflowTask() Retrives the workflow flag of the current task.
void	sendAuditEvent(AuditEvent event) Sends an auditing event to the Identity Manager auditing mechanism.

Method Detail

getSessionCreateTime

java.util.Date getSessionCreateTime()

Retrieves the creation date of the task context.

Returns:

The task context creation date.

getTaskFriendlyName

java.lang.String getTaskFriendlyName()

Retrieves the user-defined name for the task.

Returns:

The task name.

getAdminUniqueName

java.lang.String getAdminUniqueName()

Retrieves the unique identifier of the administrator who is executing the task.

Returns:

The administrator's unique identifier.

getAdminFriendlyName

java.lang.String getAdminFriendlyName()

Retrieves the name of the administrator who is executing the task.

Returns:

The adminstrator's name.

getEnvironmentFriendlyName

java.lang.String getEnvironmentFriendlyName()

Retrieves the name of the Identity Manager environment where the task is being executed.

Returns:

The name of the Identity Manager environment.

getTaskUniqueName

java.lang.String getTaskUniqueName()

Retrieves the unique identifier for the task.

Returns:

The unique task ID.

getObjectOrganization

Organization getObjectOrganization()

Retrieves the organization of the task's subject.

Returns:

The subject's organization.

getObjectOrganizationFriendlyName

java.lang.String getObjectOrganizationFriendlyName()

Retrieves the friendly name of the subject's organization.

Returns:

Friendly name of the subject's organization.

getEnvironmentUniqueName

java.lang.String getEnvironmentUniqueName()

Retrieves the unique identifier for the Identity Manager environment

Returns:

The unique ID of the Identity Manager environment.

getSiteMinderTransactionId

java.lang.String getSiteMinderTransactionId()

Retrieves the transaction ID of a SiteMinder request.

The transaction ID can be used to correlate SiteMinder access control activity with activity performed through an Identity Manager API.

Returns:

The SiteMinder transaction ID.

getSiteMinderSessionId

java.lang.String getSiteMinderSessionId()

Retrieves the unique ID of a SiteMinder session.

Returns:

The SiteMinder session ID.

getSiteMinderSessionSpec

java.lang.String getSiteMinderSessionSpec()

Retrieves the SiteMinder session specification.

A session specification contains information about the user who is making a SiteMinder request. It is the key to SiteMinder session management.

Returns:

The SiteMinder session specification.

getAuthDirUniqueName

java.lang.String getAuthDirUniqueName()

Retrieves the unique name of the user directory where the administrator who is executing the task was authenticated.

Returns:

The unique name of the user directory.

getAuthDirFriendlyName

java.lang.String getAuthDirFriendlyName()

Returns the friendly name of the directory where the administrator who is executing the task was authenticated.

Returns:

The friendly name of the user directory.

getTaskApplication

java.lang.String getTaskApplication()

Retrieves the name of the application associated with the current task. For example, admin tasks might be associated with the application IMS (Identity Manager). Access tasks are associated with the name of the application for which access rights are being granted.

Returns:

The name of the application associated with the task.

getTaskCategory

java.lang.String getTaskCategory()

Retrieves the category of the current task. In the Identity Manager user interface, tasks are grouped according to task category. The category name is displayed above the group. For example, the tasks Create User, Delete User, and Modify User might be grouped under the category User Management.

Returns:

The category of the current task.

isTaskReadOnly

boolean isTaskReadOnly()

Specifies whether the current task is a read-only task.

Returns:

Returns true if the task is read-only. Otherwise, returns false.

getSessionId

java.lang.String getSessionId()

Retrieves the Identity Manager task context ID.

Returns:

The task context ID.

getUserLocale

java.util.Locale getUserLocale()

Retrieves the java.util.Locale object representing the locale where the current task is being executed -- for example, the browser locale of the administrator executing a task.

Identity Manager uses a "best match" strategy to determine the locale, as described in the CA Identity Manager Configuration Guide.

Returns:

A standard Java Locale object.

Since:

IdentityMinder 5.6 SP 2

isWorkflowTask

boolean isWorkflowTask()

Retrives the workflow flag of the current task.

Returns:

The workflow flag of the current task. If true, workflow is enabled for the task.

Since:

IdentityMinder 6.0

isAuditableTask

boolean isAuditableTask()

Retrives the Auditable flag of the current task.

Returns:

The Auditable flag of the current task. If true, Auditing is enabled for the task.

Since:

IdentityManager r12

getAdministrator

User getAdministrator()
                      throws java.lang.Exception

Retrieves the administrator who is executing the task.

Returns:

The administrator's User object.

Throws:

java.lang.Exception

Since:

IdentityMinder 6.0

getAdminTask

AdminTask getAdminTask()

Retrieves the admin task being executed.

Returns:

The admin task object.

Since:

IdentityMinder 6.0

addMessageObject

void addMessageObject(java.lang.String message,
                      java.lang.String component,
                      ProcessStep processStep,
                      ErrorLevel errorLevel)
                      throws java.lang.Exception

Adds a response message that is displayed as a part of the task submission acknowledgement.

The message is retrieved from the resource bundle associated with the current locale.

For information about localized messages and resource bundles, see the CA Identity Manager Configuration Guide. For information about message format and message variables, see IMSException.

Parameters:

message - The localized error/informational message

component - The name of the component which generated this message.

processStep - The process step which generated this message

errorLevel - The errorLevel associated with the message

Throws:

java.lang.Exception

Since:

IdentityMinder 6.0

addMessageObject

void addMessageObject(IMSException ex,
                      java.lang.String component,
                      ProcessStep processStep,
                      ErrorLevel errorLevel)
                      throws java.lang.Exception

Adds a response message that is displayed as a part of the task submission acknowledgement.

The message is retrieved from the resource bundle associated with the current locale.

For information about localized messages and resource bundles, see the CA Identity Manager Configuration Guide. For information about message format and message variables, see IMSException.

Parameters:

ex - The IMSException which contains the localized message

component - The name of the component which generated this message.

processStep - The process step which generated this message

errorLevel - The errorLevel associated with the message

Throws:

java.lang.Exception

Since:

IdentityMinder 6.0

getSMHeader

java.lang.String getSMHeader(java.lang.String headerName)

Retrieves the specified SiteMinder header information from the task session.

SiteMinder includes the following default HTTP header names. You can use any of these names in the headerName parameter:

• SMAUTHDIRNAME
• SMAUTHDIRNAMESPACE
• SMAUTHDIROID
• SMAUTHDIRSERVER
• SMAUTHENTIC
• SMAUTHORIZED
• SMAUTHREASON
• SMAUTHTYPE
• SMDOMINOCN
• SMREALM
• SMREALMOID
• SMSDOMAIN
• SMSERVERIDENTITYSPEC
• SMSERVERSESSIONID
• SMSERVERSESSIONSPEC
• SMSESSIONDRIFT
• SMTIMETOEXPIRE
• SMTRANSACTIONID
• SMUNIVERSALID
• SMUSER
• SMUSERDN
• SMUSERMSG
• REMOTEUSER

For information about these default headers, see the SiteMinder Web Agent Guide.

Parameters:

headerName - The name of the SiteMinder header.

Returns:

The header information for the specified SiteMinder header.

Since:

IdentityMinder 6.0

getTSContext

TSContext getTSContext()
                       throws java.lang.Exception

Retrieves the task session context information for the current task session. For example, you can retrieve the current task, the administrator who is executing the task, and the subject of the task.

TSContext is passed into methods of provider objects such as UserProvider.

Returns:

The task session context information.

Throws:

java.lang.Exception

Since:

IdentityMinder 6.0

sendAuditEvent

void sendAuditEvent(AuditEvent event)
                    throws java.lang.Exception

Sends an auditing event to the Identity Manager auditing mechanism.

Parameters:

event - The event to be audited.

Throws:

java.lang.Exception

Since:

Identity Manager 8.1

See Also:

GenericAuditEvent

createRuntimeStatusDetail

RuntimeStatusDetail createRuntimeStatusDetail()

Get a instance of a RuntimeStatusDetail record. This object will need to be submitted using the addStatusDetail method

Since:

Identity Manager r12

addStatusDetail

void addStatusDetail(RuntimeStatusDetail rst)
                     throws java.lang.Exception

Add a statusDetail record to the Runtime status detail.

Parameters:

rst - A RuntimeStatusDetail object that contains the auxiliary information to be used for additional information reporting to the Submitted Tasks subsystem. This record will be reported against the Task if invoked on the TaskContext or the Event if invoked at the EventContext level.

Throws:

java.lang.Exception

Since:

Identity Manager r12

See Also:

#createStatusDetail()

addErrorObject

void addErrorObject(java.lang.String key,
                    java.lang.Object[] values,
                    java.lang.String tabName)
                    throws java.lang.Exception

Add a task error object to the task session. Usually done when a validation error is detected. These objects can prevent the task session from being submitted, and cause their text to be displayed in the UI or in TEWS error codes.

Parameters:

key - - localization key for error message

values - - array of values for use in the rendering of the key, if it is a pattern

tabName - - the name of the tab giving rise to the error

Throws:

java.lang.Exception

getSubject

ManagedObject getSubject()

Return the subject for the current task. This is valid for tasks with a single-subject action type only.

getSubjects

java.util.Vector getSubjects()

Return the subjects for the current task. This is valid for tasks with a multiple-subject action type only.

Returns:

Vector of ManagedObject

getActionType

ActionType getActionType()

Return the ActionType of the current task.