XML API information model overview

Overview

The XML API information model maps to the NFM-P Java code base. The model is defined by an XML schema that is organized in packages.

The information model consists of:

• packages with one or more groups of related domain objects (classes), data types, bitmasks, and enumerations

• classes that contain:

  • properties of the class

  • information structures for both the domain objects (classes) and properties of the information, which are called elements in the XML API but are known as parameters in CLI and the NFM-P GUI

  • NE-specific properties

• relationships between domain objects that indicate the inheritance and containment of these objects

• standard and specific XML schema definitions of types and methods, as well as XML schema definitions specific to NFM-P functions.

The information model provides a type of object model of the NFM-P-managed network. The following figure shows an example of the information model in terms of subscriber configuration.

Figure 7-1: Information model - subscriber package

More details about the information model can be found in the following:

• XML API Reference—Provides information about the XML interface, including package descriptions, object property values and descriptions, UML inheritance drawings, domain objects, or classes, parent relationships, inherited properties and methods, and supported NE types. The XML API Reference is downloadable from the Documentation Center.

• Schema Reference—Provides a definition of the XML schema for each package, and includes a list of the methods and types that are associated with the package. See the Network Developer Portal to access the Schema Reference.