Enterprise Information Portal Java APIs

IBM Enterprise Information Portal Java APIs

These classes and application programming interfaces (API) are for programming applications that use IBM Enterprise Information Portal. Use the information contained here when programming with these classes and APIs, and as an addition to the programming information in the IBM Content Manager and Enterprise Information Portal for Multiplatforms Workstation Application Programming Guide.

You can use these Java classes and APIs to access content in a variety of content servers.

API Messages

The error messages and codes returned by these APIs are listed in the Content Management Information Center under troubleshooting and in the Content Manager and Enterprise Information Portal Messages and Codes.

Constants

Constants used in these classes and APIs are defined in the interface DKDConstant.

For more information on the constants, refer to the file x:\CMBROOT\LIB\DKConstant.txt on Windows (where X is the drive on which you installed EIP, or /usr/lpp/cmb/lib/DKConstant.txt on AIX. DKConstant.txt is an copy of DKConstant.java and contains the constant values.

Samples

Sample programs are included with the Enterprise Information Portal to show you how to use these classes and APIs. These samples are located in:

     X:\cmbroot\SAMPLES\...
where X: is the drive on which you installed Enterprise Information Portal.

The readme files in each of the sample subdirectories explain how to use the samples.

Class Hierarchy for DataStores and Content

The following diagram shows the class hierarchy for accessing content in a content server:

class hierarchy

In the hierarchy, note the following:

For each content server, concrete implementations of these classes are provided that are specific to that content server. The implementations have a suffix to distinguish them, as follows:

Content Server Suffix
IBM Content Manager ICM
Content Manager for AS/400 (VisualInfo for AS/400) V4
Domino.Doc DD
Extended Search DES
Content Manager ImagePlus for OS/390 IP
Content Manager OnDemand OD
Relation databases DB2, JDBC
Data Warehouse Manager Information Catalog Manager IC
earlier Content Manager (Version 7 and earlier) DL

For example, the dkDatastore implementation for OnDemand is DKDatastoreOD; the dkEntityDef implementation for Content Manager is DKEntityDefICM.