CA Identity Manager Javadoc Reference

This Javadoc Reference documents the API specification for CA Identity Manager.

See:
Description

Packages

com.ca.identitymanager.feeder.util	Contains the CA Identity Manager base interface for the Bulk Loader.
com.ca.identitymanager.provisioning.managedobject	Contains the CA Identity Manager interface for provisioning managed objects.
com.ca.identitymanager.provisioning.managedobjectprovider	Contains the CA Identity Manager interface for provisioning managed object providers.
com.netegrity.imapi	Contains the base interfaces used in all the CA Identity Manager APIs, the context interfaces and adapter classes for each CA Identity Manager API, and base interfaces for CA Identity Manager events.
com.netegrity.ims	Contains a class for setting and retrieving the auditable properties of the current event.
com.netegrity.ims.adapters	Contains ForgottenPasswordHandler, which you can extend to create a custom forgotten password handler.
com.netegrity.ims.events	Contains the CA Identity Manager base interface for provisioning role events.
com.netegrity.ims.exception	Contains the CA Identity Manager exception class.
com.netegrity.ims.tabhandlers	Contains the CA Identity Manager tab handler interfaces and support classes.
com.netegrity.ims.util	Contains the CA Identity Manager class for retrieving localized messages.
com.netegrity.llsdk6.imsapi.abstractinterface	Contains interfaces for retrieving and setting managed object attributes, and also for performing some role and group operations.
com.netegrity.llsdk6.imsapi.collections	Contains the property dictionary and collections such as the attribute rights collection.
com.netegrity.llsdk6.imsapi.exception	Contains the exception class for attribute validation exceptions.
com.netegrity.llsdk6.imsapi.managedobject	Contains interfaces for CA Identity Manager managed objects.
com.netegrity.llsdk6.imsapi.metadata	Contains methods for performing attribute validation operations.
com.netegrity.llsdk6.imsapi.plugin	This package allows “plug-in” components to be added to the system.
com.netegrity.llsdk6.imsapi.policy	Contains interfaces for managing policies associated with Identity Manager roles and provisioning accounts defined in the Identity Manager Environment.
com.netegrity.llsdk6.imsapi.policy.rule	Contains a base interface and classes for determining the objects that can be associated with a particular role.
com.netegrity.llsdk6.imsapi.policy.rule.constraints	Contains interfaces and classes for defining search constraints, scope constraints, and object identifiers.
com.netegrity.llsdk6.imsapi.provider	Contains interfaces for the CA Identity Manager managed object providers.
com.netegrity.llsdk6.imsapi.search	Contains classes for performing search operations in a CA Identity Manager environment.
com.netegrity.llsdk6.imsapi.type	Contains a variety of type constants, such as password message types, managed object types, and operator types used in search expressions.
com.netegrity.llsdk6.imsapi.utility	Contains utility items such as task context information that you pass into provider methods, and methods for retrieving information about invalid passwords.

This Javadoc Reference documents the API specification for CA Identity Manager. You use the APIs to perform custom operations during CA Identity Manager task processing.

The following APIs include an ...Adapter base class that custom objects extend. The APIs and their associated ...Adapter base classes are:

API	Base Class
Business Logic Task Handler	BLTHAdapter
Event Listener	EventListenerAdapter
Logical Attribute	LogicalAttributeAdapter
Notification Rule	NotificationRuleAdapter
Participant Resolver	ParticipantResolverAdapter

The following APIs have no ...Adapter base class because the methods in the APIs are called from scripts:

API	Description
Email Template API	The methods in this API are called from a CA Identity Manager email template. For usage information, see the CA Identity Manager Administration Guide. For reference information, see ExposedEventContextInformation and ExposedTaskContextInformation.
Workflow API	The methods in this API are called from a script in a WorkPoint workflow process. For reference information, see WorkflowContext.

About the CA Identity Manager Programming Guide for Java

The integrated HTML version of the CA Identity Manager Programming Guide for Java includes two parts:

• Javadoc Reference - Accessible through the Javadoc tab in the navigation pane. This tab applies to the Javadoc Reference only.
• Programming Guide - Accessible through the Content, Index, and Search tabs in the navigation pane. These tabs apply to the Programming Guide only.

The integrated CA Identity Manager Programming Guide for Java also includes hyperlinks between the Javadoc Reference and the Programming Guide where necessary to cross-reference relevant information.

Note: The PDF version of the CA Identity Manager Programming Guide for Java does not include the Javadoc Reference information.