com.netegrity.imapi
Interface IMPersistentContext

All Superinterfaces:

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

All Known Subinterfaces:

BLTHContext, EventContext, FieldContext, ScreenContext, TabControllerContext, TabSequenceContext, WorkflowContext

public interface IMPersistentContext
extends IMContext

Allows custom objects to persist user-defined data within the lifetime of the current task session. For example, data can be persisted:

• Between business logic task handlers for a given task.
• Across event listeners for a given event.
• Between different scripts for a given workflow activity.
• Between different types of custom objects for a given task. For example, user-defined data can be set by a business logic task handler during the synchronous phase of task processing, and then retrieved by an event listener during the asynchronous phase of the same task session.

The IMPersistentContext interface is part of the core Identity Manager API architecture.

Since:

IdentityMinder 5.6

Method Summary

java.lang.Object	getPersistentData(java.lang.String Key) Deprecated. Deprecated in IdentityMinder 6.0. Use getSessionAttribute().
void	setPersistentData(java.lang.String key, java.lang.Object value) Deprecated. Deprecated in IdentityMinder 6.0. Use setSessionAttribute().

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

getPersistentData

java.lang.Object getPersistentData(java.lang.String Key)

Deprecated. Deprecated in IdentityMinder 6.0. Use getSessionAttribute().

Retrieves data associated with the specified key.

This method allows you to persist user-defined data between objects of the same type in the same task session -- for example, between two business logic task handlers, or between two event listeners.

Parameters:

Key - The key for the data object.

Returns:

The data object to be persisted.

setPersistentData

void setPersistentData(java.lang.String key,
                       java.lang.Object value)

Deprecated. Deprecated in IdentityMinder 6.0. Use setSessionAttribute().

Sets the data to be persisted.

This method allows you to persist user-defined data between objects of the same type in the same task session -- for example, between two business logic task handlers, or between two event listeners.

Parameters:

key - The key to reference the data.

value - The data to be persisted.