com.adventnet.nms.poll
Interface CustomDataCollection

public interface CustomDataCollection

This interface is primarily used to customize datacollection. This is useful when the user wants to manipulate the polling parameters in the run time. Before proceeding with any data collection the canProceedDataCollection method of the class implementing this interface is invoked by the Poll Engine with the agent name for which the data collection is to be done. This method is very much useful to check whether to proceed with data collection for a particular agent since if the agent is down it is an unncessary process to send request to the agent for collecting data. In case of dial-up connections, the connection to the agent can be sometimes unavailable and the same can be restored after sometime. In this situation user can check the status of the agent and proceed with the data collection. The method is also useful if the user wants to use his own way of data collection and storage instead of using the Polling Engine for data collection. In these cases user can do the necessary manipulation in this method and return a boolean which will have its effect on data collection. User can return a "false" to abort data collection. If the user returns "true then it is an intimation to the Poll Engine to proceed with normal data collection.

After implementing the interface the user has to specify the class file name in the NmsProcessesBE.conf file available under <Web NMS Home> /conf directory. The class file name should be given as an argument for Collector process as shown below.

 
 PROCESS                        com.adventnet.nms.poll.Collector
 ARGS                   POLL_OBJECTS_IN_MEMORY 25 POLL_JDBC true MAX_OIDS_IN_ONE_POLL 15 
 AUTHORIZATION true CUSTOMIZED_DATA_COLLECTOR test.CustomCollector
 
 

where test.CustomCollector is the fully qualified class name of the implementing class.

Since:

2.2.1

Method Summary

boolean

canProceedDataCollection(java.lang.String agent) Method which is implemented by the user to customize data collection.

Method Detail

canProceedDataCollection

boolean canProceedDataCollection(java.lang.String agent)

Method which is implemented by the user to customize data collection. This method is invoked by the Poll Engine with agent name for which data collection is done. User can do the necessary manipulations in this method and return boolean which will have its effect on data collection. User can return a "false" to abort data collection. If the user returns "true" then it is an intimation to the Poll Engine to proceed with normal data collection.

Parameters:

agent - name of the agent from which data is going to be collected.

Returns:

boolean - indicating whether to proceed with data collection or not.