com.adventnet.nms.fe.perf.ejb
Interface PerfSessionRemote

All Superinterfaces:

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

public interface PerfSessionRemote

extends CustomSessionRemote

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

Since:

Web NMS 2.3

See Also:

CustomSessionRemote

Method Summary

void	deletePoll(java.lang.String userName, java.lang.String name) Stops data collection for all the PolledData objects whose agent name is the name passed as a parameter and removes the PolledData objects from the Polling Engine database .
boolean	deleteThresholdObject(java.lang.String userName, java.lang.String name) Deletes the ThresholdObject with the name as the name passed, from the system.
java.util.Vector	getActivePollers(java.lang.String userName) Returns the names of all the active pollers at that time.
java.util.Vector	getAllThresholdObjectsProps(java.lang.String userName) Returns properties of all the available ThresholdObjects.
CollectedData	getCollectedData(java.lang.String userName, java.lang.String index, java.lang.String key, long timeStart, long timeEnd) Returns the data collected for the PolledData object whose key matches with the key passed, which is collected between the specified time, and for the specified instance.
int	getNumPollObjects(java.lang.String userName) Returns the total number of PolledData objects currently present in the Polling engine.
java.util.Vector	getObjectsProps(java.lang.String userName, java.lang.String classname, java.util.Properties match) Returns the Vector of Properties of PolledData objects matching the given properties.
java.util.Vector	getPollingObjects(java.lang.String userName) Returns all PollingObjects in NMS
java.util.Vector	getPollsForAgent(java.lang.String userName, java.lang.String agentname) Returns the keys of all the PolledData objects configured for an agent.
boolean	removePoll(java.lang.String userName, java.lang.String key) Stops the data collection for the PolledData object identified by the key and deletes the corresponding PolledData object from the polling engine database.

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

deletePoll

public void deletePoll(java.lang.String userName,
                       java.lang.String name)
                throws java.rmi.RemoteException

Stops data collection for all the PolledData objects whose agent name is the name passed as a parameter and removes the PolledData objects from the Polling Engine database .

Parameters:

name - The agent name of the PolledData object for which data collection is to be stopped and the PolledData objects are deleted.

Throws:

java.rmi.RemoteException - if an error occurs during remote call

removePoll

public boolean removePoll(java.lang.String userName,
                          java.lang.String key)
                   throws java.rmi.RemoteException

Stops the data collection for the PolledData object identified by the key and deletes the corresponding PolledData object from the polling engine database.

Parameters:

key - The key for the PolledData object. The key for a PolledData pd is pd.name+"\t"+pd.agent.toLowerCase().trim()+"\t"+pd.oid

Returns:

boolean specifying the status of the operation .

Throws:

java.rmi.RemoteException - if an error occurs during remote call

getCollectedData

public CollectedData getCollectedData(java.lang.String userName,
                                      java.lang.String index,
                                      java.lang.String key,
                                      long timeStart,
                                      long timeEnd)
                               throws java.rmi.RemoteException

Returns the data collected for the PolledData object whose key matches with the key passed, which is collected between the specified time, and for the specified instance. This is used only in case of MultiplePolledDatas. This method requires the start time and end time as long. This method can be used only in database mode and in serialized mode this returns null. This method is used to get the Collected Data when the PolledData is an instance of MultiplePolledData.

Parameters:

index - the instance string whose value is needed.

key - The key of the PolledData Object whose data are required. The key for a PolledData pd is pd.name+"\t"+pd.agent.toLowerCase().trim()+"\t"+pd.oid

timeStart - The starting time from when the collected data is required. The time is given as a long.

timeEnd - The end time until when the collected data is required as long.

Returns:

CollectedData containing the collected statistics.

Throws:

java.rmi.RemoteException - if an error occurs during remote call

getPollsForAgent

public java.util.Vector getPollsForAgent(java.lang.String userName,
                                         java.lang.String agentname)
                                  throws java.rmi.RemoteException

Returns the keys of all the PolledData objects configured for an agent. The Key for the PolledData object pd is pd.name+"\t"+pd.agent.toLowerCase().trim()+"\t"+pd.oid

Parameters:

agentname - Name of the agent whose keys to the PolledData has to be returned.

Returns:

Vector of keys to the PolledData objects as String. Empty Vector if there is no PolledData configured for that agent.

Throws:

java.rmi.RemoteException - if an error occurs during remote call

getObjectsProps

public java.util.Vector getObjectsProps(java.lang.String userName,
                                        java.lang.String classname,
                                        java.util.Properties match)
                                 throws java.rmi.RemoteException

Returns the Vector of Properties of PolledData objects matching the given properties. The classname is the name of the class the objects belong to. This method can be used only if the object's properties are stored in an RDBMS. It is also assumed one object is stored in only one table. If one object is stored in multiple tables, then only partial object will be returned.

Parameters:

classname - name of the class the object belongs.

match - properties which is to be matched with the object's properties.

Returns:

Vector of properties of objects matching the properties given.

Throws:

java.rmi.RemoteException - if an error occurs during remote call

getNumPollObjects

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

Returns the total number of PolledData objects currently present in the Polling engine.

Returns:

int number of PolledData objects.

Throws:

java.rmi.RemoteException - if an error occurs during remote call

getActivePollers

public java.util.Vector getActivePollers(java.lang.String userName)
                                  throws java.rmi.RemoteException

Returns the names of all the active pollers at that time.

Returns:

Vector containing names of ActivePollers as String.

Throws:

java.rmi.RemoteException - if an error occurs during remote call

deleteThresholdObject

public boolean deleteThresholdObject(java.lang.String userName,
                                     java.lang.String name)
                              throws java.rmi.RemoteException

Deletes the ThresholdObject with the name as the name passed, from the system.

Parameters:

name - Name of the thresholdObject to be deleted.

Returns:

boolean representing the status of the operation.

Throws:

java.rmi.RemoteException - if an error occurs during remote call

getAllThresholdObjectsProps

public java.util.Vector getAllThresholdObjectsProps(java.lang.String userName)
                                             throws java.rmi.RemoteException

Returns properties of all the available ThresholdObjects.

Returns:

the Vector containing Properties of all ThresholdObjects.

Throws:

java.rmi.RemoteException - if an error occurs during remote call

getPollingObjects

public java.util.Vector getPollingObjects(java.lang.String userName)
                                   throws java.rmi.RemoteException,
                                          NmsPollException

Returns all PollingObjects in NMS

Returns:

A Vector contains all the Polling Object in NMS

Throws:

java.rmi.RemoteException - if an error occurs during remote call

NmsPollException - if an error occurs while getting Polling Objects.