About this Guide

---

Revised: September 20, 2011, OL-24191-02

Introduction

This document describes the Cisco Service Control Management Suite (SCMS) Subscriber Manager (SM) Java API.

You use the SCMS SM Java API to update, query, and configure the Subscriber Manager. The API has of two parts, which you can use separately or together without restriction:

1. Subscriber Manager Nonblocking Java API—High-performance API with low visibility to errors and other operation results. Supports automatic integrations with operations support (OSS) systems and authentication, authorization, and accounting (AAA) systems.

2. Subscriber Manager Blocking Java API—Supports user-interface applications for accessing and managing the Subscriber Manager.

---

Note A set of APIs with the same functionality is also available for the C/C++ environment.

---

This document is for networking or computer technicians who are responsible for configuring the Subscriber Manager. It is also intended for operators who manage Cisco Service Control Engine (SCE) platforms.

Document Revision History

lists the changes made to this document since it was first released.

Table 1 Document Revision History 

Revision	Cisco Service Control Release and Date	Change Summary
OL-24191-02	September 20, 2011	Improved the quality of the user documentation by adding customer and internal feedback.
OL-24191-01	Release 3.7.x June 13, 2011	Initial document release.

Organization

lists the major sections of this document.

Table 2 Document Organization 

Section	Title	Description
1	Getting Started	Describes the platforms on which you can use the Java API. This chapter also describes how to install, compile, and run the Java API component.
2	General API Concepts	Describes various concepts that pertain to working with the Subscriber Manager Java API.
3	Blocking API	Describes the features and operation of the blocking API and provides code examples.
4	Nonblocking API	Describes the features and operation of the nonblocking API and provides code examples.
A	List of Error Codes	Lists error codes that are used in the Java API.

Related Documentation

Use this document in conjunction with all the SCMS Subscriber Manager user, API, and reference guides.

Conventions

lists the conventions used in this document.

Table 3 Conventions 

Convention	Indication
bold font	Commands and keywords and user-entered text appear in bold font.
italic font	Document titles, new or emphasized terms, and arguments for which you supply values are in italic font.
[ ]	Elements in square brackets are optional.
{x | y | z }	Required alternative keywords are grouped in braces and separated by vertical bars.
[ x | y | z ]	Optional alternative keywords are grouped in brackets and separated by vertical bars.
string	A nonquoted set of characters. Do not use quotation marks around the string or the string will include the quotation marks.
courier font	Terminal sessions and information the system displays appear in courier font.
< >	Nonprinting characters such as passwords are in angle brackets.
[ ]	Default responses to system prompts are in square brackets.
!, #	An exclamation point (!) or a pound sign (#) at the beginning of a line of code indicates a comment line.

---

Note Means reader take note.

---

---

Tip Means the following information will help you solve a problem.

---

---

Caution Means reader be careful. In this situation, you might perform an action that could result in equipment damage or loss of data.

---

---

Timesaver Means the described action saves time. You can save time by performing the action described in the paragraph.

---

Warning Means reader be warned. In this situation, you might perform an action that could result in bodily injury.

Obtaining Documentation and Submitting a Service Request

For information on obtaining documentation, submitting a service request, and gathering additional information, see the monthly What's New in Cisco Product Documentation, which also lists all new and revised Cisco technical documentation, at:

http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html

Subscribe to What's New in Cisco Product Documentation as a Really Simple Syndication (RSS) feed and set content to be delivered directly to your desktop using a reader application. The RSS feeds are a free service and Cisco currently supports RSS version 2.0.