Cisco SCMS SM Java API Programmer Guide, Release 5.1.x

Introduction

The Java API enables you to update, query, and configure the Cisco Service Control Subscriber Manager. The API has two parts, which you can use separately or together without restriction.

• Cisco Service Control Subscriber Manager Nonblocking Java API—High-performance API with low visibility to errors and other operation results. This API supports automatic integrations with OSS/AAA systems.
• Cisco Service Control Subscriber Manager Blocking Java API—Supports user-interface applications that enable you to access and manage the Cisco Service Control Subscriber Manager.

Platforms

The Cisco Service Control Subscriber Manager Java API was developed and tested on a Windows platform, but it is operable on any platform that supports Java Version 5.0.

Package Content

For brevity, <installdir> refers to the installation directory, sm-java-api-vvv.bb.

The <installdir>/javadoc folder contains the API JAVADOC documentation.

The <installdir>lib folder contains the smapi.jar file, which is the API executable. It also contains additional JAR files that are required to operate the API.

Table 1-1 provides the layout of the installation directory.

Cisco Service Control Subscriber Manager Setup

The API connects to the Proprietary Remote Procedure Call (PRPC) server on the Cisco Service Control Subscriber Manager. To enable the API to operate, the following conditions must be met:

• The Cisco Service Control Subscriber Manager must be operating, and reachable from the machine that hosts the API.
• The PRPC server must be started.

The PRPC server is a proprietary RPC protocol designed by Cisco. For more information about the PRPC server, see the Cisco Service Control Management Suite Subscriber Manager User Guide.

Installing on a UNIX Platform

Note The abbreviations vvv and bb represent the Cisco Service Control Subscriber Manager Java API version and build number.

To install Cisco Service Control Subscriber Manager Java API:

Step 1 Extract the Cisco Service Control Subscriber Manager LEG distribution file.

Step 2 Locate the Cisco Service Control Subscriber Manager Java API distribution tar, sm-java-api-dist.tar.

Step 3 Extract the Cisco Service Control Subscriber Manager Java API distribution tar and obtain sm-java-api-vvv.bb.tar.

Step 4 Extract the Cisco Service Control Subscriber Manager Java API package tar.

Installing on a Windows Platform

Use a zip extractor (such as WinZip).