Overview     Tree     Deprecated     Index     Help
AdventNet Web NMS 4 API Specification


AdventNet Home
AdventNet Web NMS 4 - API Specification
Complete API Specification

The following are the various services offered by the Web NMS platform and each of these services can be customized / extended based on the application needs. The table below gives quick links to the javadoc specification of each service to enable developers easily locate the hook they are looking for.

Web NMS Management Services APIs
 
Service
Description
Packages
Discovery  Service Scans through the network, discovers the network elements, and collects basic information for further management. com.adventnet.nms.netwatch
com.adventnet.nms.util
Topology Service Enables to model the network resources for effective management. com.adventnet.nms.topodb
com.adventnet.nms.topodb.tl1
com.adventnet.nms.topodb.corba 
com.adventnet.nms.netwatch 
com.adventnet.nms.fe.topo 
com.adventnet.nms.fe.topo.ejb 
com.adventnet.nms.topoui
Map Service Enables to customize the visual representation of the managed resources.  com.adventnet.nms.mapdb
com.adventnet.nms.fe.map
com.adventnet.nms.fe.map.ejb
com.adventnet.nms.mapui
Fault Management Enables to identify network happenings, correlate and categorize them, precisely determine the failure and its severity, define administrative messages effectively and initiate necessary actions.  com.adventnet.nms.alertdb 
com.adventnet.nms.alertui 
com.adventnet.nms.eventdb 
com.adventnet.nms.eventui
com.adventnet.nms.fe.alert 
com.adventnet.nms.fe.event 
com.adventnet.nms.server 
com.adventnet.nms.trap
com.adventnet.nms.jsp
com.adventnet.nms.fe.alert.ejb
com.adventnet.nms.fe.event.ejb
Configuration Management Facilitates configuring a variety of Network Elements, configuring multiple devices concurrently, defining a profile that maintains the configuration attributes for repetitive configurations, allows specification of the data at the point of configuration.  com.adventnet.management.config 
com.adventnet.management.config.xml
com.adventnet.management.config.snmp
com.adventnet.management.config.telnet 
com.adventnet.management.config.tl1
com.adventnet.management.config.tftp
com.adventnet.management.config.ftp
com.adventnet.management.config.corba
com.adventnet.nms.config
com.adventnet.nms.fe.config
com.adventnet.nms.fe.config.ejb
Performance Management Helps you in effective performance monitoring of network by collecting the requisite amount of data, keeping track of the data levels, meaningfully present the data and also to periodically generate reports on the network health. com.adventnet.nms.poll 
com.adventnet.nms.pollui 
com.adventnet.nms.pollui.tl1 
com.adventnet.nms.fe.perf
com.adventnet.nms.fe.perf.ejb
Provisioning Framework Helps to provision/configure devices in a multi-vendor network. Provides an extensible framework to customize and extend the provisioning capabilities and add new support for multi-vendor networks.  com.adventnet.nms.provisioning
com.adventnet.nms.provisioning.ext 
com.adventnet.nms.provisioning.server
com.adventnet.nms.provisioning.xml
Web NMS JMX Agent Provides interface and classes to filter out the manager list, whereby Web NMS JMX Agent can send the SNMP traps for specific managers.  com.adventnet.nms.jmxagent

Web NMS Framework Services APIs
 
Service
Description
Packages
Module Service Enables to integrate any external process that may require to run independently, but still interact with the various Web NMS Server processes for specific application needs.  com.adventnet.nms.util
com.adventnet.nms.admin
Logging Service Provides APIs for logging information and for writing own logging module.  com.adventnet.management.log
Scheduling Service Enables to schedule the various processes of web NMS like the Network Discovery, Status Check, Data Collection, Report Generation etc, to be executed at periodic intervals of time.  com.adventnet.management.scheduler
Policy Framework An extension of Scheduling Service - this provides with a way to schedule a process based on a set of rules or conditions.  com.adventnet.management.policydb
com.adventnet.nms.policyui
Communication Framework Enables user processes to make use of the Client-Server Communication mechanism, and also provides an option to have Client-Server Communication using any custom Protocol.  com.adventnet.nms.startnms
com.adventnet.management.transport
com.adventnet.nms.broadcast
Persistence Services Allows for storing the data in a variety of RDBMS and also caching the data for better performance. com.adventnet.nms.store
com.adventnet.nms.store.relational 
Resource Pools A central point of control for database connections, that conserves the system resources to provide effective and efficient database operations.  com.adventnet.management.transaction
Transaction Service Enables to execute a set of database operations as a single unified transaction with provisions to define custom transactions, sending notifications on completion, and so on.  com.adventnet.management.transaction
Java Client Framework Helps you to customize the Java Client Interface and  the communication mechanism to suit application specific needs. com.adventnet.nms.broadcast 
com.adventnet.nms.client
com.adventnet.nms.failover
com.adventnet.nms.startclient 
com.adventnet.nms.util 
Java Beans components It provides a wide range of reusable java bean components that simplify the process of Java Client Application development.  com.adventnet.apiutils 
com.adventnet.beans 
com.adventnet.beans.digit 
com.adventnet.beans.gauges 
com.adventnet.beans.images 
com.adventnet.beans.panels 
com.adventnet.beans.probeans 
com.adventnet.beans.probeans.editor 
com.adventnet.beans.probeans.renderer 
com.adventnet.beans.table 
com.adventnet.beans.text 
com.adventnet.beans.threshold 
com.adventnet.beans.utilbeans 
com.adventnet.beans.utilbeans.help 
Web Client Enables customization of the web page layout, web components, login page, menus, and toolbars. Web Client javadocs
Custom View Service Enables manipulation of information in the database using SQL, and performing all custom view related operations. com.adventnet.nms.db
com.adventnet.nms.db.util
com.adventnet.nms.fe.common
com.adventnet.nms.fe.common.ejb
com.adventnet.nms.fe.common.naming
Security Services Enables you to develop a secure management platform providing with Authentication, Authorization & Fine grained access control mechanisms, to restrict user access to the data, ensuring confidentiality and data integrity  com.adventnet.security
com.adventnet.security.audit
com.adventnet.security.authentication
com.adventnet.security.authorization
com.adventnet.security.crypto
com.adventnet.nms.authentication
Failover Service The service that ensures an uninterrupted resource management facility with the system latching automatically to the standby secondary server, when the primary server fails.  com.adventnet.nms.fe.common
com.adventnet.nms.failover
Severity Enables to determine the criticality of an event for further management with options to define the levels. com.adventnet.nms.severity
Backup Service Helps you in backing up the management information. Also facilitates the user processes to avail this service.  com.adventnet.management.backup
TFTP Service A file transfer service to complement the management operations. com.adventnet.nms.tftp
Platform Utilities Provides various utility services for all modules in Web NMS, like customizing the context sensitive help for Web NMS client. It also enables implementing the locking mechanism for the various objects in the Web NMS system, and enables various Web NMS modules and user applications to be run as separate processes in the Web NMS BE or FE server. com.adventnet.nms.util
com.adventnet.nms.commonfe
com.adventnet.nms.rmi

Middleware and Management Protocol APIs
 
Management Protocol
Description
API
Management Server A powerful middleware component, that enables communication with a variety of network elements and allows for communication with elements supporting even proprietary protocol. Management Server API
SNMP Set of java libraries implementing SNMP stack as defined in standards RFC 1155 & RFC 1157 that enable communication with SNMP agents.  By default SNMP v1, v2c and v3 stacks are supported. In addition it provides MIBs API and other high level APIs abstracting low-level communication details from user, which make developing network management applications very easy.  AdventNet SNMP API
TL1 Set of Java libraries implementing TL1 Stack defined as per the Bellcore GR-831-CORE Standard. It has useful set of APIs that support TL1Message framing , parsing etc. These APIs can be used to build management applications to operate, administer and manage NEs that support TL1 interface.  AdventNet TL1 API
CLI Set of Java libraries that enables user to build applications to manage network devices that support command line based interface (CLI) for management. AdventNet CLI API

Client Builder
 
Module Name
Description
Packages
Management Components and Classes Components and classes to facilitate transaction with any device through Management Server Framework for Client Builder tools. com.adventnet.beans.chassis
com.adventnet.beans.configuration
com.adventnet.beans.configuration.snmp
com.adventnet.beans.configuration.tl1
com.adventnet.beans.management
com.adventnet.beans.management.fault.table
com.adventnet.beans.management.protocol
com.adventnet.beans.management.protocol.snmp
com.adventnet.beans.management.protocol.tl1
com.adventnet.beans.threshold

Studio
 
Module Name
Description
Packages
Integrating Third Party Version Control System Interfaces for integrating other Version Control systems into Studio. com.adventnet.qengine.client.versioning
com.adventnet.qengine.server.versioning

Distributed Mediation Server (DMS) - Applicable only for Web NMS Remote Management Edition
 
Module Name
Description
Packages
DMS Customizing the communication framework, data transfer, etc. for remote management. DMS javadocs