Installing the IBM Sterling Control Center Monitor API

The IBM® Sterling Control Center Monitor Application Programming Interface for Java (CCAPI) enables a Java application to connect to IBM Sterling Control Center Monitor and initiate node configuration-related tasks and create, update, and obtain, IBM Sterling Control Center Monitor role, user, server, server group, and data visibility group (DVG) objects.

Before you begin

Knowledge of the Java programming language and basic IBM Sterling Control Center Monitor operations is necessary to use this application programming interface (API). If you plan to use a secure connection to an IBM Sterling Control Center Monitor engine, you also need knowledge of the JSSE (Java Secure Sockets Extension).

About this task

To install the CCAPI:

Procedure

  1. Create a directory and copy the CCAPIxxxx.zip distribution file into this directory.
  2. Extract the files from the compressed CCAPIxxxx.zip distribution file by typing a command similar to the following command:
    jar -xvf CCAPIxxxx.zip
    Note: If you use an archive utility to extract the files, be sure to select the Use folder names check box.

Results

The following files and folders are extracted:
  • Readme.txt.
  • Sample.java - a sample Java application that uses the CCAPI.
  • conf - a folder that contains CCAPI.log4j, the logging configuration file.
  • doc - a folder that contains the Javadoc based documentation of the CCAPI. To view this file, open index.html.
  • lib - a folder to hold the JAR files necessary for using the CCAPI. You must copy the JAR files to this folder. For a list of the JAR files that must be copied, see the Readme.txt file.
    Note: The JAR files used with the CCAPI must be at the same level as the IBM Sterling Control Center Monitor engine. This structure is checked when the CCAPI attempts to sign on to the IBM Sterling Control Center Monitor engine. Each time you apply maintenance to IBM Sterling Control Center Monitor or upgrade to a new release, you must copy these JAR files into your CCAPI folder again.
  • log - a folder that contains the log file, CCAPI.log, which is generated when running CCAPI-based applications.

What to do next

For information about getting started with the CCAPI, see the Javadoc in the \doc directory.