Table Of Contents

Introduction

What is Contained in this Guide?

Who is this Guide for?

Where Should I Start to Read this Book?

Why use an Application Programming Interface?

Styles Used in this Guide

Note on Command Line Examples

What Typographic Conventions and Symbols Mean

Summary

Introduction

---

This chapter provides an outline of the contents of the Cisco Mobile Wireless Fault
Mediator 2.2 - Java API Guide documentation. An overview of each chapter is provided along with additional information on Cisco typographic conventions. Finally, we will discuss why you would use an API as well as the functionality of the NMOS Java API.

What is Contained in this Guide?

This guide contains a detailed description of the NMOS Java Application Programming Interface (API).

Table 1-1 provides a brief summary of the contents of the chapters contained in this book.

Table 1-1 Chapter Contents

Chapter	Description
Introduction	Illustrates the styles and conventions used in this document.
MWFM TIBCO/Rendezvous	Introduces the concepts behind Rendezvous and describes how it is utilized in the MWFM NMOS Java API.
Examples	Provides examples of some NMOS Java API programming.
The NMOS Java API Classes	Provides an overview of the NMOS Java API followed by a detailed list of all the published classes, interfaces, fields, constructors, and methods. Diagrams of class hierarchies are included.
Differences between Version 2 and NMOS Java API's	Details the differences in packages and classes between the version 2 Java API and the NMOS Java API. Classes which are superseded, or have become obsolete are highlighted.

Who is this Guide for?

This guide is written for developers and technical services personnel who intend to write applications in Java that integrate with, or extend, the MWFM NMOS.

Readers should already be familiar with the Java programming language and Unix, as well as the material in the following documents:

•Cisco Mobile Wireless Fault Mediator 2.2 - Fault Engineering Reference Guide

•Cisco Mobile Wireless Fault Mediator 2.2 - Topology and Platform Modeling Reference Guide

•Cisco Mobile Wireless Fault Mediator 2.2 - GUI User Guide

Where Should I Start to Read this Book?

"MWFM TIBCO/Rendezvous," describes the installation process and requirements and can be read independently for that purpose. "Examples," is a recommended starting point for new users of the MWFM NMOS Java API. Users that are familiar with MWFM and Java can refer to "The NMOS Java API Classes," for details of classes.

Why use an Application Programming Interface?

An Application Programming Interface (API) is composed of the calls, subroutines, or software interrupts that enable programmers to build, customize, or link software applications. Its function is to enable a, usually, higher-level program to make use of, usually, lower-level services and functions of another software program. This particular API is used to interface to the core applications in MWFM and consists of a library of Java classes, fields, constructors, and methods that can be used for this purpose.

What are the capabilities of the NMOS Java API?

The NMOS Java API enables the user to interface into existing processes, but also to query any databases that have been set up.

---

Note In order to query a database, the process that you are trying to access (e.g. riv_model, riv_class), must be running.

---

For example, the NMOS Java API could be used in the following instances:

•To query riv_model to get the class name of a device that has generated an event.

•To select all entries in a certain table.

•To show all events with a severity equal to critical.

•To insert new entries into a table. For instance, if you wanted to add new classes to riv_class.

•To modify entries in databases, such as clearing events.

•To delete entries from databases. For instance, entities could be deleted from riv_model.

•To add listeners to listen for updates.

MWFM uses TIB®/Rendezvous™ for inter-process communications. This layer can be invisible to users of this API who only need to provide a domain name.

Styles Used in this Guide

Throughout the Cisco Mobile Wireless Fault Mediator 2.2 - Java API Guide we use certain specialized styles to highlight significant items. In the following sections, we describe how to interpret the meaning of those styles.

Note on Command Line Examples

Command line examples in this guide use the `C' shell environment.

What Typographic Conventions and Symbols Mean

Table 1-2 Typographic Conventions and Symbols

Typeface or symbol	Meaning	Example
Emphasis	Signals the class/interface/field/constructor/method being documented.	public CRivASN1Address().
Code	This typeface signals the names of commands, files and processes; On-screen computer output.	$ cd $RIV_HOME
File Name/Path	Denotes file and path names. Used throughout the installation chapter.	$RIV_HOME

Summary

This chapter outlined the contents of the Cisco Mobile Wireless Fault Mediator 2.2 - Java API Guide. The next chapter will discuss areas of Rendezvous that are relevant to the MWFM NMOS API.