Preface

---

This preface describes who should read the Cisco Internet Streamer CDS 2.0-2.3 API Guide, how it is organized, and its document conventions. It contains the following sections:

•Audience

•Document Organization

•Document Conventions

•Related Publications

•Obtaining Documentation and Submitting a Service Request

Audience

This application program interface (API) guide is written for the knowledgeable application programmer who understands the basic architecture of the Cisco Content Delivery System (CDS) software product and Java servlets. The user should be fluent in the Java programming language and have prior practical experience developing content networking solutions. This guide is not intended to direct the user in how to program in the Java language and limits itself to describing how related CDS software servlets are used.

Document Organization

This API guide includes the following chapters:

Chapter or Appendix	Title	Description
Chapter 1	Introduction to Cisco CDS Software APIs	Provides an introduction to the CDS software application program interfaces.
Chapter 2	Replication Status APIs	Describes the Replication Status API and the servlet actions it performs.
Chapter 3	Provisioning APIs	Describes the Delivery Service Provisioning API, Location Provisioning API, Service Engine Provisioning API, and Program API and the servlet actions they perform.
Chapter 4	Listing APIs	Describes the Listing API and the servlet actions it performs.
Chapter 5	Statistics APIs	Describes the Monitoring Statistics API and Streaming Statistics API and the servlet actions they perform.
Appendix A	Program Files in the CDS Software	Describes the attributes of program files and examples for different program types.

Document Conventions

This API guide uses basic conventions to represent text and table information.

Convention	Description
boldface font	Commands, keywords, and button names are in boldface.
italic font	Variables for which you supply values are in italics. Directory names and filenames are also in italics.
screen font	Terminal sessions and information the system displays are printed in screen font.
boldface screen font	Information you must enter is in boldface screen font.
italic screen font	Variables you enter are printed in italic screen font.
string	Defined as a nonquoted set of characters. For example, when setting a community string for SNMP to "public," do not use quotation marks around the string, or the string will include the quotation marks.
vertical bars ( | )	Vertical bars separate alternative, mutually exclusive, elements.
< >	Variable for which you supply a value.
{ }	Elements in braces are required elements.
[ ]	Elements in square brackets are optional.
{x | y | z}	Required keywords are grouped in braces and separated by vertical bars.
[x | y | z]	Optional keywords are grouped in brackets and separated by vertical bars.
[{ }]	Braces within square brackets indicate a required choice within an optional element.

---

Note Means reader take note. Notes contain helpful suggestions or references to materials not contained in the manual.

---

---

Tip Means the following information will help you solve a problem. The tips information might not be troubleshooting or even an action, but could be useful information, similar to a Timesaver.

---

Related Publications

These documents provide complete information about the CDS and are available from the Cisco.com site:

•Cisco Internet Streamer CDS 2.0-2.3 Software Configuration Guide

•Cisco Internet Streamer CDS 2.0-2.3 Quick Start Guide

•Release Notes for Cisco Internet Streamer CDS 2.0

•Release Notes for Cisco Internet Streamer CDS 2.1

•Release Notes for Cisco Internet Streamer CDS 2.2

•Release Notes for Cisco Internet Streamer CDS 2.3

•Cisco Content Delivery Engine 100/200/300/400 Hardware Installation Guide

•Cisco Content Delivery System 2.x Documentation Roadmap

•Regulatory Compliance and Safety Information for Cisco Content Delivery Engines 100/200/300/400

You can access the software documents at the following URL:

http://www.cisco.com/en/US/products/ps7127/tsd_products_support_series_home.html

You can access the hardware documents at the following URL:

http://www.cisco.com/en/US/products/ps7126/tsd_products_support_series_home.html

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.