"WEBNMS 6.0 API Docs"

com.adventnet.nms.fe.event
Interface ThinEventAPI

All Superinterfaces:
CommonAPI, CommonModuleAPI, java.rmi.Remote

public interface ThinEventAPI
extends CommonAPI

A wrapper over EventAPI which has no dependencies over other Event Objects. The methods in this API receive and return Java objects.


Method Summary
 int getCleanEventInterval(java.lang.String ticket)
          This method Gets the CLEAN_EVENT_INTERVAL value in days.
 int getEventWindowSize(java.lang.String ticket)
          Gets the Event Window size configured in Web NMS.
 java.util.Vector getObjects(java.lang.String ticket, java.lang.String classname, java.util.Properties match)
          Gets the Vector of objects matching the given properties.
 int getTotalEventCount(java.lang.String ticket)
          Returns the total number of Events in the Web NMS system.
 int[] getTrapPort(java.lang.String ticket)
          Returns the port number on which EventMgr is listening for traps.
 void setCleanEventInterval(java.lang.String ticket, int CLEAN_EVENT_INTERVAL)
          This method sets the CLEAN_EVENT_INTERVAL value
 
Methods inherited from interface com.adventnet.nms.util.CommonAPI
getCompleteList, getObjectNamesWithProps, getPropertiesOfObject
 

Method Detail

getTrapPort

int[] getTrapPort(java.lang.String ticket)
                  throws java.rmi.RemoteException
Returns the port number on which EventMgr is listening for traps.

Parameters:
ticket - String value which gets the userName as ticket for authentication and logging.
Returns:
Ports at which Event module listens for Traps
Throws:
java.rmi.RemoteException - if error occurs at remote machine.

getCleanEventInterval

int getCleanEventInterval(java.lang.String ticket)
                          throws java.rmi.RemoteException
This method Gets the CLEAN_EVENT_INTERVAL value in days.

Parameters:
ticket - String value which gets the userName as ticket for authentication and logging.
Returns:
Cutoff time in days. Events older than this value, will be deleted by Web NMS.
Throws:
java.rmi.RemoteException - if error occurs at remote machine.

setCleanEventInterval

void setCleanEventInterval(java.lang.String ticket,
                           int CLEAN_EVENT_INTERVAL)
                           throws java.rmi.RemoteException
This method sets the CLEAN_EVENT_INTERVAL value

Parameters:
ticket - String value which gets the userName as ticket for authentication and logging.
CLEAN_EVENT_INTERVAL - Cutoff time in days. Events older than this value, will be deleted by Web NMS.
Throws:
java.rmi.RemoteException - if error occurs at remote machine.

getTotalEventCount

int getTotalEventCount(java.lang.String ticket)
                       throws java.rmi.RemoteException
Returns the total number of Events in the Web NMS system. The total number of events can vary with time because events older than a specified time are deleted. This is set as a parameter "CLEAN_EVENTS_INTERVAL" to EventMgr in NmsProcessesBE.conf It is to be noted that the total number of events has a higher limit which is configurable. This is set as a parameter "EVENT_WINDOW_SIZE" to EventMgr. Once the number of events exceeds this limit, the old events are deleted. So, although the total number of events may not change because of this, the events in the Web NMS system change.

Parameters:
ticket - the userName as ticket for authentication and logging
Returns:
Number of Events that Web NMS manages at any point of time
Throws:
java.rmi.RemoteException - if error occurs at remote machine.

getObjects

java.util.Vector getObjects(java.lang.String ticket,
                            java.lang.String classname,
                            java.util.Properties match)
                            throws java.rmi.RemoteException
Gets the Vector of objects matching the given properties. The classname is the name of the class the objects belong to.

Parameters:
classname - Classname of the objects which have to be retrived
match - matching criteria
ticket - the userName as ticket for authentication and logging
Returns:
Vector of Alerts.
Throws:
java.rmi.RemoteException - if error occurs at remote machine

getEventWindowSize

int getEventWindowSize(java.lang.String ticket)
                       throws java.rmi.RemoteException,
                              NmsStorageException
Gets the Event Window size configured in Web NMS.

Parameters:
ticket - the userName as ticket for authentication and logging
Returns:
The Event Window size configured in Web NMS.
Throws:
java.rmi.RemoteException - if error occurs at remote machine
NmsStorageException - if error occurs.

"WEBNMS 6.0 API Docs"

Copyright © 2018 ZOHO Corp., All Rights Reserved.