Cisco SCMS SM Java API Programmer Guide, Release 5.1.x
Bias-Free Language
The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
- Updated:
- March 6, 2015
Chapter: Getting Started
Getting Started
Introduction
This chapter identifies the platforms on which you can use the Java API. The chapter also describes how to install, compile, and run the API.
The Java API
The following sections provide information about the Java API:
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.
|
|
|
|
|---|---|---|
Provides an implementation of the Java Cryptography Extension API |
Installing the Java API
The Java API is part of the Cisco Service Control Subscriber Manager Login Event Generator (LEG) distribution file and is located in the SM_API directory.
The Cisco Service Control Subscriber Manager Java API is packaged in a UNIX tar file. The API is compiled with log4j 1.2. You can extract the Java API by using the UNIX tar utility or most Windows compression utilities:
- Cisco Service Control Subscriber Manager Setup
- Installing on a UNIX Platform
- Installing on a Windows Platform
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
Compiling and Running a Program That Uses API
To compile and run a program that uses the Cisco Service Control Subscriber Manager Java API, smapi.jar must be in the CLASSPATH.
For example, if the program source is in SMApiProgram.java, use the following command to compile the program:
After compiling the program, use the following command to run the program:
Feedback