Cisco SCMS SM Java API Programmer Guide, Rel. 3.5.0 - About this Guide [Cisco Service Control Subscriber Manager]

Table Of Contents

About this Guide

Document Revision History

Organization

Related Documentation

Conventions

Obtaining Documentation and Submitting a Service Request

About this Guide

This document explains the Cisco Service Control Management Suite (SCMS) Subscriber Manager (SM) Java application programming interface (API).

The SCMS SM Java API is used for updating, querying, and configuring the subscriber manager (SM). It consists of two parts, which may be used separately or together without restriction:

1. SM Nonblocking Java API—A high-performance API with low visibility to errors and other operation results. Supports automatic integrations with OSS/AAA systems.

2. SM Blocking Java API—A more user-friendly API. Supports user interface applications for accessing and managing the SM.

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

This guide is for the networking or computer technician responsible for configuring the subscriber manager. It is also intended for the operator who manages Cisco Service Control Engine (SCE) platforms.

Document Revision History

The Document Revision History below records changes to this document.

Revision

Cisco Service Control Release and Date

Change Summary

OL-7204-08

3.5.0
January, 2009

The SM Java API is operable on platforms that support version 5.0 and is no longer operable on platforms that support version 1.4.

OL-7204-07

3.1.6
May, 2008

Private IP address over VPN and private IP range over VPN are now supported for the Network ID. See Information About Network ID Mappings, page 2-4 and Specifying Private IP Address or Private IP Range over VPN Mapping, page 2-5.

OL-7204-06

3.1.5
November, 2007

VLAN mapping type deprecated and replaced by VPN mapping type. See Information About Network ID Mappings, page 2-4.

OL-7204-05

3.1.0
May, 2007

•Support for moving subscribers between domains. See Subscriber Domains, page 2-6 and the Parameters, page 3-5 section of the login method.

•Updated Subscriber Name Format, page 2-4.

OL-7204-04

3.0.5
November, 2006

Updated documentation for Release 3.0.5.

OL-7204-03

3.0.3
May, 2006

Updated documentation for Release 3.0.3.

OL-7204-02

3.0
December, 2005

Reorganized the documentation. No major changes or new features were added to this revision.

OL-7204-01

2.5.7
May, 2005

First version of this document.

Organization

This guide contains the following sections:

Section

Title

Description

1

Getting Started, page 1-1

Describes the platforms on which the Java API can be used, and how to install, compile, and start running the Java API component.

2

General API Concepts, page 2-1

Describes various concepts that are used when working with the SM Java API.

3

Blocking API, page 3-1

Describes features and operation of the blocking API and provides code examples.

4

Nonblocking API, page 4-1

Describes features and operation of the nonblocking API and provides code examples.

A

List of Error Codes, page A-1

Lists error codes that are used in the Java API.

Related Documentation

Use this SCMS SM Java API Programmer Guide in conjunction with all of the SCMS Subscriber Manager user, API, and reference guides.

Conventions

This document uses the following 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 the 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.