AdventNet Web NMS 4 API Specification

This document is the complete API specification for the AdventNet Web NMS, version 4.

See:
Description

Packages

com.adventnet.db
com.adventnet.management.backup	This package contains the Java documentation for the API's used in Web NMS backup system
com.adventnet.management.config	Provides classes and interfaces for creating and applying configuration over Network Elements.
com.adventnet.management.config.corba	Provides classes which can be used for configuring CORBA enabled agents.
com.adventnet.management.config.ftp
com.adventnet.management.config.snmp	Provides classes which can be used for configuring SNMP enabled agents.
com.adventnet.management.config.telnet	Provides classes which can be used for configuring CLI enabled agents.
com.adventnet.management.config.tftp	Provides classes which can be used for defining TFTP Tasks to do file transfers.
com.adventnet.management.config.tl1	Provides classes which can be used for configuring TL1 enabled agents.
com.adventnet.management.config.xml	Contains classes for representing fundamental configuration details.
com.adventnet.management.log	This package contains Java documentation for various API's used in Web NMS logging module.
com.adventnet.management.policydb	Java documentation for this package contains information about the various API's available in Policy framework service
com.adventnet.management.scheduler	This package contains information about the Scheduler, the one which is used widely to execute assigned task at a specified time with the control over no of threads .
com.adventnet.management.transaction	This package contains classes which are useful for utilizing the transaction support provided by Web NMS.
com.adventnet.management.transport	This package defines some basic interfaces for a generic transport provider framework for communication between a client and server.
com.adventnet.nms.admin	Provides the API for performing administrative operations on the Web NMS servers.
com.adventnet.nms.alertdb	This package contains classes and interfaces that provide useful mechanism to handle the server side Alert management functionalities.
com.adventnet.nms.alertui	This package provides classes to handle Alert management functionalities on the Client side with APIs to build standalone Alert client, based on the Custom View Framework.
com.adventnet.nms.authentication	This package consists of set of classes that are related to WebNMS User Administration.
com.adventnet.nms.broadcast	This package contains documentation for the Web NMS Client side API classes that help user written classes to register as Broadcast Clients that could receive the broadcast messages that are communicated between the client(s) through the Web NMS server(s).
com.adventnet.nms.client	This package contains the java documentation for the API classes that form the client side building blocks in developing a Stand Alone client.
com.adventnet.nms.commonfe	Provides the API for getting useful information about the FE server.
com.adventnet.nms.config	Provides classes and interfaces for creating configuration audit views.
com.adventnet.nms.db	Provides the classes and interfaces, to manipulate the information in the database using SQL.
com.adventnet.nms.db.util	Provides classes and interfaces for the utility classes for database query.
com.adventnet.nms.eventdb	This package contains classes and interfaces that provide useful mechanism to handle the server side Event management functionalities.
com.adventnet.nms.eventdb.tl1	This package contains classes and interfaces that provide useful mechanism to handle the TL1 autonomous messages.
com.adventnet.nms.eventdb.trapstore	Provides an interface that enables the user to plugin his own mechanism to receive the traps, and hand over to the Common Trap Receiver when requested, for further processing.
com.adventnet.nms.eventui	This package contains the java documentation for the API classes that provide useful mechanism to handle the client side Event management functionalities.The classes present in this package importantly provide the Client Event API functionality that helps users to build standalone Event client, through the mechanism of Event Custom View.
com.adventnet.nms.failover	This package contains java documentation for the API classes that provide useful information about the status of the client when it detects connection loss with the front end server.
com.adventnet.nms.fault
com.adventnet.nms.fe.alert	Provides classes and interfaces of AlertSessionBean, proxy implementation and thin APIs.
com.adventnet.nms.fe.alert.ejb	Provides EJB specific classes and interfaces that are required for AlertSessionBean.
com.adventnet.nms.fe.common	Provides the API for manipulating the Custom Views on the FE server.
com.adventnet.nms.fe.common.ejb	This package contains EJB specific classes and interfaces that are common to all modules, to publish custom view related operations via JNDI.
com.adventnet.nms.fe.common.naming	This package contains classes that are used to get RMIAPIs, that are used by SessionBeans.
com.adventnet.nms.fe.config	Provides Proxy & Thin APIs for configuring Network Elements from Applet Clients.
com.adventnet.nms.fe.config.ejb	Provides EJB specific classes and interfaces that are required for ConfigSessionBean.
com.adventnet.nms.fe.event	Provides classes and interfaces of EventSessionBean, proxy implimentation and thin APIs.
com.adventnet.nms.fe.event.ejb	Provides EJB specific classes and interfaces that are required for EventSessionBean.
com.adventnet.nms.fe.log	Provides classes and interfaces for the logging service via RMI.
com.adventnet.nms.fe.map	Provides classes and interfaces of MapSessionBean, proxy implimentation and thin APIs.
com.adventnet.nms.fe.map.ejb	Provides EJB based classes and interface that are used by MapSessionBean.
com.adventnet.nms.fe.perf	Provides classes and interfaces for implementation of PerfSession, thin APIs and proxy implementation including functionality to read the details of Poll units and the collected data from database.
com.adventnet.nms.fe.perf.ejb	Provides EJB specific classes and interfaces to achieve performance monitoring in EJB mode. 1.
com.adventnet.nms.fe.topo	Provides classes and interfaces of TopoSessionBean, proxy implimentation and thin APIs.
com.adventnet.nms.fe.topo.ejb	Provides EJB specific classes and interfaces that are required for TopoSessionBean.
com.adventnet.nms.jmxagent	Provides interface(s) and classes to filter out the manager list, whereby Web NMS JMX Agent can send the SNMP traps for specific managers.
com.adventnet.nms.jsp	Provides classes, that are used for data display and manipulation in the HTML UI.
com.adventnet.nms.mapdb	Provides interfaces and classes for representing the topology ManagedObjects (which represent network elements) as various map symbols.
com.adventnet.nms.mapui	This package contains interfaces and classes that form the essential building components of the Web NMS Map Client.
com.adventnet.nms.netwatch	Provides interfaces for plugging user defined discovery process and to customize the test that is done during the status polling of the ManagedObjects.
com.adventnet.nms.policyui	Java documentation for this package contains information about the Customizer class which is useful in customizing UI related stuff corresponding to Policy viewer.
com.adventnet.nms.poll	Provides classes and interfaces for handling server side functions for Performance Management.
com.adventnet.nms.pollui	Provides classes and interfaces for handling client side functions for Performance Management such as the following: Fetching data from the server and displaying them in the client. implementing custom views to display data providing interface for implementing custom views
com.adventnet.nms.pollui.tl1	Provides classes to build and customize Current Statistics graphs and Collected Statistics graphs for TL1 protocol.
com.adventnet.nms.provisioning	Provides classes and interfaces to access Provisioning Module functions.
com.adventnet.nms.provisioning.ext	Contains classes and interfaces which can be implemented to provide domain and ventor-specific extensions.
com.adventnet.nms.provisioning.inventorydb	Provides interfaces and classes for modelling the inventory details and manipulating the inventory database.
com.adventnet.nms.provisioning.server	Provides classes that are fundamental to the design of the Provisioning Module.
com.adventnet.nms.provisioning.ui	Provides classes to access the ProvisioningAPI in any kind of Communication mode.
com.adventnet.nms.provisioning.ui.uielements	Provides interfaces and classes for creating ui components which can be used for rendering the Forms present in a template.
com.adventnet.nms.provisioning.xml	Contains classes that represent provisioning xml template.
com.adventnet.nms.rmi	Provides the API for performing RMI related utility functions.
com.adventnet.nms.server	This package contains the java documentation for the API classes that form the server side building blocks in developing a Stand Alone client.
com.adventnet.nms.severity	This package contains the java documentation for the API classes that provide useful mechanism to handle the severities that are defined in Web NMS. The classes present in this package essentially helps in accessing information about the Severities that have been configured in the Web NMS server.
com.adventnet.nms.startclient	This package contains interfaces and classes that form the essential building units of the Web NMS Java Client.
com.adventnet.nms.startclient.rmi	This package contains generic interfaces that are to be implemented by the Client side classes to participate in RMI based communication between the Back End Server and Client (or Front End Server).
com.adventnet.nms.startnms	Provides interfaces and classes that define the communication layer of the Web NMS BE and FE servers.
com.adventnet.nms.store	Java documentation for this package contains information about various classes used for storing Objects ,highly scalable Vector and Hashtable.
com.adventnet.nms.store.relational	This package contains the Java documentation about the various API's used to store information about Objects incase of database storage
com.adventnet.nms.tftp	This package com.adventnet.nms.tftp describes the classes used for performing Tftp operation .Tftp is basically used for transferring the files from the local machine to remote machine or vice versa.
com.adventnet.nms.tl1.config
com.adventnet.nms.topodb	Provides interfaces and classes for modelling the network elements (NEs) as ManagedObjects and manipulating the topology database.
com.adventnet.nms.topodb.corba
com.adventnet.nms.topodb.tl1	Provides classes used for modelling the TL1 network elements (NEs) These classes extend the core Managed Object Information Model of Web NMS These TL1 Managed Objects store all necessary device specific information. These TL1 Managed Objects store the details of the TCP connection established between the TL1 device and Web NMS BE Server.
com.adventnet.nms.topoui	This package contains the java documentation for the API classes that provide useful mechanism to handle the client side Topological management functionalities.
com.adventnet.nms.trap	This package now contains an interface that needs to be implemented by external Applications to register for trap notification.
com.adventnet.nms.util	Java documentation for this package contains information about various utility classes which are used across all modules in Web NMS.
com.adventnet.security	Java Documentation for this package contains information about utility classes which are used across the security framework.
com.adventnet.security.audit	This package consist of auditing related interfaces and classes which are used to perform auditing in Security Management.
com.adventnet.security.authentication	This package defines the primary authentication interface which provides the API's to verify the user credentials.
com.adventnet.security.authorization	This package consists of authorization related interfaces and classes which are used to perform Access Control to the users for different applications and also to add/delete the Access Control Data to the data store.
com.adventnet.security.crypto	This package consist of cryptograph related interfaces and classes which are used to perform encryption and decryption in Security Management.

This document is the complete API specification for the AdventNet Web NMS, version 4.