com.adventnet.nms.fe.event.ejb
Interface EventSessionRemote

All Superinterfaces:

CustomSessionRemote, javax.ejb.EJBObject, java.rmi.Remote

public interface EventSessionRemote

extends CustomSessionRemote

This is the "Remote" interface for the EventSessionBean. Using the EventSessionBean (the associated EJBean), both CustomView related operations and EventAPI related operations can be performed.

Since:

Web NMS 2.3

See Also:

CustomSessionRemote

Method Summary

int	getCleanEventInterval(java.lang.String userName) Gets the CLEAN_EVENT_INTERVAL value in days.
int	getEventWindowSize(java.lang.String userName) Gets the Event Window size configured in Web NMS.
java.util.Vector	getObjects(java.lang.String userName, java.lang.String classname, java.util.Properties match) Gets the Vector of objects matching the given properties.
int	getTotalEventCount(java.lang.String userName) Returns the total number of Events in the WebNMS system.
int[]	getTrapPort(java.lang.String userName) Returns the port numbers on which EventMgr is listening for traps.
void	setCleanEventInterval(java.lang.String userName, int CLEAN_EVENT_INTERVAL) This method sets the CLEAN_EVENT_INTERVAL value.

Methods inherited from interface com.adventnet.nms.fe.common.ejb.CustomSessionRemote

createCustomView, createCustomView, getAllViewIDsAndProps, getData, getObjectNamesWithProps, getPropertiesOfObject, getTotalCount, getTotalCount, getTotalCount, getViewProperties, modifyCustomView, removeCustomView, renameCustomView, saveViewState

Methods inherited from interface javax.ejb.EJBObject

getEJBHome, getHandle, getPrimaryKey, isIdentical, remove

Method Detail

getTrapPort

public int[] getTrapPort(java.lang.String userName)
                  throws java.rmi.RemoteException

Returns the port numbers on which EventMgr is listening for traps.

Parameters:

userName - 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

public int getCleanEventInterval(java.lang.String userName)
                          throws java.rmi.RemoteException

Gets the CLEAN_EVENT_INTERVAL value in days.

Parameters:

userName - 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

public void setCleanEventInterval(java.lang.String userName,
                                  int CLEAN_EVENT_INTERVAL)
                           throws java.rmi.RemoteException

This method sets the CLEAN_EVENT_INTERVAL value.

Parameters:

userName - 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

public int getTotalEventCount(java.lang.String userName)
                       throws java.rmi.RemoteException

Returns the total number of Events in the WebNMS 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 WebNMS system change.

Parameters:

userName - the userName as ticket for authentication and logging

Returns:

Number of Events that WebNMS manages at any point of time

Throws:

java.rmi.RemoteException - if error occurs at remote machine

java.rmi.RemoteException - if error occurs at remote machine.

getObjects

public java.util.Vector getObjects(java.lang.String userName,
                                   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

userName - the userName as ticket for authentication and logging

Returns:

Vector of Alerts.

Throws:

java.rmi.RemoteException - if error occurs at remote machine

getEventWindowSize

public int getEventWindowSize(java.lang.String userName)
                       throws java.rmi.RemoteException,
                              NmsStorageException

Gets the Event Window size configured in Web NMS.

Parameters:

userName - 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.