"WEBNMS_5 API Docs"

Package com.adventnet.nms.util

Interface Summary
ClientConnectionObserver This is the interface that needs to be implemented for getting notification when a user tries to Login, Logout and Login Failure using Application,Applet, Webstart and WebClient.
CommonAPI This is the interface that contains methods that are common for the different modules in NMS.
CommonFEAPI  
CommonModuleAPI This is a common interface which is implemented by most of the api's that are bound to the rmi registry.
ConfigurableObj interface class for Encodable Objects
CustomClassInterface The interface needs to be implemented by the class which is invoked from the INVOKE_CLASS action of the menu item defined in the appropriate menu file.
HelpUserClassInterface This interface should be implemented if the user needs to customize the manner in which context sensitive help is displayed in the NMS client.
HotStandbyListener This is an interface for modules present in the standby server which want to notified when standby server identify the primary server failure.
ListViewHandler  
ListViewModel  
LockableObject This is the API interface for implementing the locking mechanism for the various objects in the Web NMS system (viz.  ManagedObject, Event, Alert etc. ).
MouseWheelListenerWrapper An interface which is used intead of the MouseWheelListener (see java documentation for MouseWheelListener) to support backward compatibility with runtime versions lower than JRE1.4 This is used in components which do not want any direct dependency over jre1.4, but also want the MouseWheel support when the runtime version is 1.4.
NmsCommonUtil An interface that has all the methods that are used in both server and client side.
NmsPanelEventListener This listener interface is for receiving NmsPanelEvent events .
PropComponent Component interface for handling properties.
ResultEventListener The Class that is interested in Communicating with the WebNMS Server sould implement this Interface.
RunProcessInterface This interface provides methods that allow various Web NMS modules and user applications to be run as separate processes in the Web NMS BE or FE server.
Searchable This interface has to be implemented by the class which wants to use the Search dialog that appears in the WebNMS client.
ServerShutDownInterface This interface can be implemented by the client(GUI), which use the ClientFrameWorkAPI for establshing client-server communication.
ShutDownObserver This is an interface for objects which want to register to Web NMS Server and get notified when Web NMS Server is shutting down.
UserClassInterface This interface needs to be implemented by the classes which are to be invoked via the "invokeclasson*" option as menu item action.The UserClassInterface can be used to invoke classes on the BE server, FE server as well as the client.
WindowMenuCustomizer This is an interface to configure the strings of the menuitems which represents the hierarchy of the panel in the tree.
 

Class Summary
AbstractFailOverTransmitter In normal BE Failover,it will take minimum three minute for standby server to take over after primary server failure.Any operation or request in the Network during the intervening period (i.e., the time period between the failure of primary and the subsequent complete take over by standby) will be lost.This abstract class is used to identify the primary failover quickly and avoid the loss of device notifications.
ButtonPanel  
CellColorRenderer  
CellIconRenderer  
ClientFrameWorkAPI This class can be used by the user to initialize the FrameWork utilities of NMS.
ClientParameters  
CommonLockTable  
CommonUtil This is an utility class that has methods that are common to all modules both on server and client side.
CommonUtilCarrier This class contains the reference of NmsCommonUtil class so that it can be used by other sources that are used both in server and client side.
CommonUtilHelper  
CorbaNamingServiceUtil  
CustomTreeCellEditor  
CustomViewObject This class serves as a container for the indivijual properties that are part of property form dealing with custom views .
DataFormCustomizer This abstract class should be extended by all user defined classes which intend to replace the Data Forms that are shown by default by Web NMS across various modules.
DBAliasesParser This class parses the DatabaseAliases.conf file and using the methods getAlias() and getAntiAlias() that are present in this file one can get the alias and antialias values as required.
DBParamsParser  
DefaultLockableObject  
DeviceQuery  
FieldObject This class serves as a container for the properties of various Objects present in the WebNMS.
FindInList  
FormObject This class serves as a container for the indivijual properties that are part of a Customizable property form in the WebNMS.
FormView  
FrameworkAPI This class contains API methods that should be used before starting framework module, as a initialization step.
GenericConstants GenericConstants.java Created: Tue Mar 20 20:55:30 2001
GenericUtility Used by many files to access comman methods and static variables .
GroupedDataFormCustomizer This abstract class should be extended by all user defined classes which intend to replace the group of Data Forms that are shown by default by Web NMS across various modules.
GUIElement  
LedPanel This implements LedPanelnms which extends Panel
ListView  
MenuParser Menu parser is used for building the object specific menu for the given menu name.
MoreFewerPanel  
MouseWheelEventWrapper A wrapper for the MouseWheelEvent .
NmsClientUtil A class which has static methods and static fields.
NmsLogMgr This class manages the printing of log out and error messages from the various modules.The NmsLogMgr reads the initial settings of the log from the configuration file conf/logging_parameters.conf.By default, the log messages are placed in the directory named logs, Web NMS general messages in the nmsout.txt file and error messages in the nmserr.txt.
NmsMenu This class represent menus for the nms menus this will include the table popup menu and tree popup menu also.
NmsMenuItem  
NmsPanelEvent Using this class users can invoke the existing predefined Actions which are defined in NmsPanel interface for all the supported Events in NMS.
NmsUiAPI NmsUiAPI is one of the core APIs in Web NMS Java Client Framework, which is used in Tree and Custom View related customizations from the client side.
NmsUtil An important utility class that contains static constants and methods that are used by all modules across NMS.
NmsWaitDialog  
NonEditableTextField This textfield does not allow any modification by the user directly.
ParseOptions  
Ping This Utility class is used to ping a machine to check if it is alive.This class is used by the NMS Discovery engine if ICMP discovery is enabled.It also contains other utility methods to determine the interfaces of local host and the ipAddress contained in the ARP and Routing table of the local host.
PropForm This class defines the form used in viewing and changing properties.
PureClientUtils  
PureServerUtils This utility class that contains static fileds and methods that are used by many modules across Web NMS.
PureServerUtilsBE  
PureServerUtilsFE An utility class used only by the Front End Server classes.
PureUtils  
ResultEventAdapter This is an Abstract class used by the ResultEventListener(s) to register for responses from the WebNMS Server.
ResultEventObject This Object is used to propagate the data that has been received from the WebNMS Server to all the listeners who have registered for responses.
RunCmd Class to run any application in a separate thread.
RunExeModule This is a module that allows starting any executable as a module.
RunProcessSmall This class loads the individual module specified in the processSmallBegin.conf_BE/FE.
Search  
SearchAttributes This class is for implementing search.
SearchDialog  
SnmpPing This Utility class is used to do a SNMP query to the machine to check if it is SNMP enabled.
Title  
ToolBar It creates a toolbar and places the image buttons on it and locates that toolbar below the menu bar.
WatchUtil A class containg utility methods related to IP address manipulations.
XMLDataReader This class uses the JAXP parser to read data from an XML file and constructs the XMLNode tree.
XMLDataWriter This Utility class is used for writing xml data in the form of xml file.
XMLNode This class represents an XML data element.
 

Exception Summary
AccessDeniedException  
NmsException NmsException which extends java.lang.Exception provides us the to decide next course of action based on action type provided.This will be enhanced in future
TimeoutException  
XMLDataException This exception signifies an error in the XML data file
 


"WEBNMS_5 API Docs"

Copyright © 2011 ZOHO Corp., All Rights Reserved.