com.netegrity.imapi
Interface ExposedEventContextInformation

All Superinterfaces:

EventROContext, IMContext, Logger, ProviderAccessor, java.io.Serializable, ServiceProvider, TaskInfo

public interface ExposedEventContextInformation
extends EventROContext

Makes context information for the current event available to an Identity Manager email template.

The methods in this interface plus all of its inherited methods are provided to the object _eventContextInformation. You can use this object to call ExposedEventContextInformation methods from an Identity Manager email template.

The _eventContextInformation object is available to email messages based on Approved, Pending, and Rejected templates.

This interface inherits information about the task session from TaskInfo. The following TaskInfo methods are particularly useful to an email template:

• getAdministrator(). Retrieves a User object for the administrator who is executing the current task.
• getAdminTask(). Retrieves an Admin Task object for the current task.

For information on using the _eventContextInformation object in an email template, see the email chapter of the CA Identity Manager Operations Guide.

Since:

IdentityMinder 5.5

Method Summary

java.lang.String	getAdminAttribute(java.lang.String attribute, java.lang.String delimiter) Gets the value of a managed object attribute on the administrator.
java.lang.String	getAdminName() Deprecated. Deprecated in IdentityMinder 5.6 -- use getAdministrator() or getAdminFriendlyName().
java.lang.String	getApprovalStatus() Retrieves the approval status of the event.
java.lang.String	getApprovalTime() Retrieves the time the event was approved.
java.lang.String	getEventName() Retrieves the name of the event.
java.lang.String	getOrgName() Deprecated. Deprecated in IdentityMinder 5.6 -- use getObjectOrganizationFriendlyName().
java.lang.String	getPassword() Retrieves the user's password.
java.lang.String	getPrimaryObjectAttribute(java.lang.String attribute, java.lang.String delimiter) Gets the value of a managed object attribute on the event primary object.
java.lang.String	getPrimaryObjectName() Retrieves the name of the primary object affected by the event.
java.lang.String	getPrimaryObjectTypeName() Retrieves the primary object type associated with the event.
java.lang.String	getSecondaryObjectAttribute(java.lang.String attribute, java.lang.String delimiter) Gets the value of a managed object attribute on the event secondary object..
java.lang.String	getSecondaryObjectName() Returns the name of the secondary object if a secondary object was affected by the event.
java.lang.String	getSecondaryObjectTypeName() Returns the secondary object type if a secondary object was affected by the event.
java.lang.String	getTaskSubjectAttribute(java.lang.String attribute, java.lang.String delimiter) Gets the value of a managed object attribute on the task subject.

Methods inherited from interface com.netegrity.imapi.EventROContext

getEvent, getEventDescription

Methods inherited from interface com.netegrity.imapi.IMContext

getAuxDataRoot, getLocalizer, getLocalizer, getSessionAttribute, removeSessionAttribute, setSessionAttribute

Methods inherited from interface com.netegrity.imapi.Logger

logDebugMessage, logErrorMessage, logInfoMessage, logWarningMessage

Methods inherited from interface com.netegrity.imapi.TaskInfo

addErrorObject, addMessageObject, addMessageObject, addStatusDetail, createRuntimeStatusDetail, getActionType, getAdminFriendlyName, getAdministrator, getAdminTask, getAdminUniqueName, getAuthDirFriendlyName, getAuthDirUniqueName, getEnvironmentFriendlyName, getEnvironmentUniqueName, getObjectOrganization, getObjectOrganizationFriendlyName, getSessionCreateTime, getSessionId, getSiteMinderSessionId, getSiteMinderSessionSpec, getSiteMinderTransactionId, getSMHeader, getSubject, getSubjects, getTaskApplication, getTaskCategory, getTaskFriendlyName, getTaskUniqueName, getTSContext, getUserLocale, isAuditableTask, isTaskReadOnly, isWorkflowTask, sendAuditEvent

Methods inherited from interface com.netegrity.imapi.ServiceProvider

canUserAdministerGroup, convertLogicalToPhysical, convertPhysicalToLogical, decryptString, decryptString, doesSupportGroup, doesSupportOrganization, encryptString, encryptString, findAdminTask, getAllUsersAccessRoles, getGroupAdmins, getGroupMembers, getGroups, getGroupsAdminCanAdminister, getManagedObject, getManagedObjects, getManagedObjects, getOrg, getOrgMembers, getRootOrg, getSubOrgs, getTemporaryPassword, getTempPassword, isPasswordValid, isPasswordValid, isTopMostOrgWhichTaskIsBoundTo, validatePassword, validatePassword

Methods inherited from interface com.netegrity.imapi.ProviderAccessor

getAccessControlProvider, getAccessRoleProvider, getAccessTaskProvider, getAdminRoleProvider, getAdminTaskProvider, getAnalyticsEngineProvider, getEnvironmentSettingsProvider, getGroupProvider, getManagedObjectProvider, getOrganizationProvider, getProvisioningPolicyProvider, getProvisioningRoleProvider, getRelationshipProvider, getSecurityProvider, getSynchronizationProvider, getTabDefinitionProvider, getUserProvider

Method Detail

getApprovalStatus

java.lang.String getApprovalStatus()

Retrieves the approval status of the event.

Returns:

One of these values:

• APPROVAL_STATUS_APPROVED.
• APPROVAL_STATUS_REJECTED

getApprovalTime

java.lang.String getApprovalTime()

Retrieves the time the event was approved.

Returns:

The time the event was approved.

getEventName

java.lang.String getEventName()

Retrieves the name of the event.

Specified by:

getEventName in interface EventROContext

Returns:

The event name.

getOrgName

java.lang.String getOrgName()

Deprecated. Deprecated in IdentityMinder 5.6 -- use getObjectOrganizationFriendlyName().

Retrieves the friendly name of the organization where the task is being executed.

Returns:

The name of the organization where the task is being executed.

getPassword

java.lang.String getPassword()

Retrieves the user's password.

Returns:

The user's password.

getPrimaryObjectTypeName

java.lang.String getPrimaryObjectTypeName()

Retrieves the primary object type associated with the event. The primary object types are:

• ACCESSROLE
• ACCESSTASK
• ADMINROLE
• ADMINTASK
• GROUP
• ORGANIZATION
• USER

Returns:

The primary object type.

See Also:

getPrimaryObjectName()

getPrimaryObjectName

java.lang.String getPrimaryObjectName()

Retrieves the name of the primary object affected by the event.

A primary object is the object directly affected by the event. A secondary object is the object that the primary object is bound to, if any. For example:

• The primary object type for CreateUserEvent is USER. The secondary object is the object where the user is created--that is, ORGANIZATION.
• The primary object type for CreateAdminRoleEvent is ADMINROLE. This object is not bound to other objects, so no secondary object exists.

With a primary object of type USER, getPrimaryObjectName() might return John Jones.

Returns:

The name of the primary object.

getSecondaryObjectTypeName

java.lang.String getSecondaryObjectTypeName()

Returns the secondary object type if a secondary object was affected by the event. Possible secondary object types returned are:

• ACCESSROLE
• ACCESSTASK
• ADMINROLE
• ADMINTASK
• GROUP
• ORGANIZATION
• USER

Returns:

The secondary object type.

See Also:

getPrimaryObjectName()

getSecondaryObjectName

java.lang.String getSecondaryObjectName()

Returns the name of the secondary object if a secondary object was affected by the event.

With a secondary object of type ORGANIZATION, the method getSecondaryObjectName() might return HR.

Returns:

The name of the secondary object.

See Also:

getPrimaryObjectName()

getAdminName

java.lang.String getAdminName()

Deprecated. Deprecated in IdentityMinder 5.6 -- use getAdministrator() or getAdminFriendlyName().

Retrieves the friendly name of the administrator who is performing the current task.

Returns:

The name of the administrator who is performing the current task.

getAdminAttribute

java.lang.String getAdminAttribute(java.lang.String attribute,
                                   java.lang.String delimiter)
                                   throws java.lang.Exception

Gets the value of a managed object attribute on the administrator. Loads the attribute if it isn't already present on the object

Parameters:

attribute - attribute name

delimiter - string to place in between values if the attribute is multi-valued

Returns:

attribute value

Throws:

java.lang.Exception

getPrimaryObjectAttribute

java.lang.String getPrimaryObjectAttribute(java.lang.String attribute,
                                           java.lang.String delimiter)
                                           throws java.lang.Exception

Gets the value of a managed object attribute on the event primary object. Loads the attribute if it isn't already present on the object

Parameters:

attribute - attribute name

delimiter - string to place in between values if the attribute is multi-valued

Returns:

attribute value

Throws:

java.lang.Exception

getSecondaryObjectAttribute

java.lang.String getSecondaryObjectAttribute(java.lang.String attribute,
                                             java.lang.String delimiter)
                                             throws java.lang.Exception

Gets the value of a managed object attribute on the event secondary object.. Loads the attribute if it isn't already present on the object

Parameters:

attribute - attribute name

delimiter - string to place in between values if the attribute is multi-valued

Returns:

attribute value

Throws:

java.lang.Exception

getTaskSubjectAttribute

java.lang.String getTaskSubjectAttribute(java.lang.String attribute,
                                         java.lang.String delimiter)
                                         throws java.lang.Exception

Gets the value of a managed object attribute on the task subject. Loads the attribute if it isn't already present on the object

Parameters:

attribute - attribute name

delimiter - string to place in between values if the attribute is multi-valued

Returns:

attribute value

Throws:

java.lang.Exception