com.ibm.websphere.externalnode
Interface PeriodicStatsCollector

All Superinterfaces:
StatsCollector

public interface PeriodicStatsCollector
extends StatsCollector

This is the PeriodicStatsCollector interface a plugin class for the ExternalNodeStatsService framework must implement.

This interface extends the base StatsCollector interface.

See Also:
StatsCollector

Method Summary
 void removeStatsListener()
          Removes the StatsListener that was set previously by setStatsListener().
 void setStatsListener(StatsListener listener, long interval)
          Sets a StatsListener to receive statistics update from the Plugin instance at specified interval in milliseconds.
 
Methods inherited from interface com.ibm.websphere.externalnode.StatsCollector
getNodeName, initialize, setProperties
 

Method Detail

setStatsListener

void setStatsListener(StatsListener listener,
                      long interval)
Sets a StatsListener to receive statistics update from the Plugin instance at specified interval in milliseconds.

It is expected that the Plugin instance will call the statsUpdated() method of the StatsListener at the specified interval till removeStatsListener is called.

Parameters:
listener - the StatsListener to report updated statistics on a periodic basis.
interval - the interval in milliseconds
See Also:
StatsListener

removeStatsListener

void removeStatsListener()
Removes the StatsListener that was set previously by setStatsListener(). This is also a signal to stop the periodic reporting of statistics updates.