Management Console API

This reference documentation serves as an overview of the application programming interfaces (APIs) that can be used to integrate Management Console functions in customized Java applications and programs. It is intended for advanced users who have a comprehensive knowledge of InfoSphere® Data Replication - CDC Replication data replication concepts. It also assumes a comprehensive knowledge of the Java programming language.

To view the API Javadoc documentation, you will have to refer to the Management Console API reference – Javadocs. Certain elements of the API that are documented in Javadoc are not covered in this documentation. Omitting these elements indicates that they are not intended for use in Java programs and applications that are created for your working environment.

By providing an API for accessing Management Console functions within a Java application or program, organizations are able to create specialized software to satisfy needs and requirements unique to a specific business or industry. In particular, customized Java interfaces that include necessary enhancements and the ability to access some or all of Management Console functions can be created in-house.

Management Console API packages
The API shipped with Management Console contains three packages.
Management Console API architecture
The API supports a number of interfaces and classes, but it is important to understand the association between a specific interface or class and a Management Console entity in a replication configuration.
Sample Java programs
Management Console API reference – Javadocs
The API documentation is available in Javadoc format in your Management Console installation directory.
Management Console API exceptions
The API throws different exceptions that can be caught and handled by your Java programs and applications. This section identifies each exception and describes the situations that result in the exception being raised.
User roles
There are four roles available for a Management Console user .
User permissions
There are some methods in the Management Console API that are only accessible by specific user roles.
Access Manager, CHCCLP and security reporting
Access Manager security and reporting features can be accessed through the Access Manager perspective in Management Console and through the CHCCLP program.
API support for Access Manager
Previously, customized Java programs could only manipulate a Management Console user currently connected to an Access Server.