WebNMS 5 API Specification

This document is the complete API specification for the Management Server module in WebNMS, version 5.

See:
Description

Packages

com.adventnet.management	WebNMS Management Server providesAPIs for building protocol independent management applications.
com.adventnet.management.cli	This package contains the CLI protocol provider specific classes used for making CLI sessions through the Management Server.
com.adventnet.management.client	This package contain utility classes for the client applications.
com.adventnet.management.client.xml	This package contain utility classes for the client applications.
com.adventnet.management.corba	This package implements Corba Provider and property functionality to use Management Server.
com.adventnet.management.ftp
com.adventnet.management.snmp	This package implements SNMP provier and property functionality to use Management Server.
com.adventnet.management.tftp	This package contains classes that are used for transferring of files through the TFTP protocol.
com.adventnet.management.tl1	This package implements TL1 provier and property functionality to use Management Server.

This document is the complete API specification for the Management Server module in WebNMS, version 5.

The Management Server provides a framework for performing generic protocol neutral transactions such as Request-response , Polling requests and Event notifications . It is build on the ProtocolProvider interface which allows any protocol to be plugged in the Management Server framework .

Management Server supports two types of framework architecture modes.

Two Tier Mode

User client applications can build generic , lightweight , protocol neutral applications using the ManagementServices API in two tier mode .

API Diagram :

Features Offered By Management Server Framework In Two Tier Mode

• The user client applications interface directly with Management Server through Java API . i.e. they run in the same JVM as the Management Server.
• Suited for single application/client managing the network devices.

Three Tier Mode

User client applications can build generic , lightweight , protocol neutral applications using the ManagementServices API in three tier mode.

This mode supports more features like scalability , loose-coupling and suitable for advanced features like load-balancing and failover support .

API Diagram :

Features Offered By Management Server Framework In Three Tier Mode

• Light weight Client .
• Loose coupling between Management Client and Management Server.
• Scalablility in a distributed environment where many Management Clients can be used with a single Management Server
• performing all the protocol related processing .
• The Client User application and the Management Server can reside on two different platforms / machines.
• Suited for advanced functionality such as load-balancing and fail-over.

List Of API's , Classes and Interfaces Used By User Client Applications

List Of Abstract Classes and Interfaces Implemented By The Protocol Provider Implementations

Code Snippets