com.netegrity.imapi
Interface IMContext

All Superinterfaces:

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

All Known Subinterfaces:

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

public interface IMContext
extends Logger, TaskInfo, ServiceProvider, ProviderAccessor

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

Since:

IdentityMinder 5.6

Method Summary

AuxDataElement	getAuxDataRoot() Get the root of the auxiliary data tree for this environment
Localizer	getLocalizer()
Localizer	getLocalizer(java.lang.String bundleName)
java.lang.Object	getSessionAttribute(java.lang.String key) Retrieves a user-defined data object from the current task session.
void	removeSessionAttribute(java.lang.String key) Removes a user-defined data object from the current task session.
void	setSessionAttribute(java.lang.String key, java.lang.Object value) Sets a user-defined data object for the current task session.

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

getSessionAttribute

java.lang.Object getSessionAttribute(java.lang.String key)
                                     throws java.lang.Exception

Retrieves a user-defined data object from the current task session.

This method retrieves user-defined data that was set through setSessionAttribute() in this task session -- whether the data was set by the same type of object or by a different type of object. For example, user-defined data can be persisted between two business logic task handlers in the same task session, or it can be set by a business logic task handler and retrieved by an event listener in the same task session.

Parameters:

key - The key associated with the user-defined object being retrieved.

Returns:

The user-defined data object associated with the specified key, or null if no matching key is found.

Throws:

java.lang.Exception

Since:

IdentityMinder 6.0

setSessionAttribute

void setSessionAttribute(java.lang.String key,
                         java.lang.Object value)
                         throws java.lang.Exception

Sets a user-defined data object for the current task session.

Any object set to the task session must implement the interface Serializable in java/io.

A custom object calls getSessionAttribute() to retrieve user-defined data set in this task session through setSessionAttribute() -- whether the data was set by the same type of object or by a different type of object. For example, user-defined data can be persisted between two business logic task handlers in the same task session, or it can be set by a business logic task handler and retrieved by an event listener in the same task session.

Parameters:

key - The key to associate with the user-defined object.

value - The user-defined data object.

Throws:

java.lang.Exception

Since:

IdentityMinder 6.0

removeSessionAttribute

void removeSessionAttribute(java.lang.String key)

Removes a user-defined data object from the current task session.

Use this method to remove an attribute set through setSessionAttribute().

Any object to be removed from the task session must implement the interface Serializable in java/io.

Parameters:

key - The key associated with the user-defined object.

Since:

Identity Manager 8.1

getAuxDataRoot

AuxDataElement getAuxDataRoot()

Get the root of the auxiliary data tree for this environment

Returns:

getLocalizer

Localizer getLocalizer()

getLocalizer

Localizer getLocalizer(java.lang.String bundleName)