com.axway.ats.common.performance.monitor

Class PerformanceMonitor

java.lang.Object

com.axway.ats.common.performance.monitor.PerformanceMonitor

public abstract class PerformanceMonitor
extends Object

A Monitor that can be used by the ATS Performance Monitor Service to collect statistical data about a tested system

Constructor Summary

Constructors

Constructor and Description
PerformanceMonitor()

Method Summary

Modifier and Type	Method and Description
abstract void	deinit() Called to do some clean up procedures, for example to release some resources allocated in the init() method
abstract String	getDescription()
int	getPollInterval()
abstract void	init(ReadingBean[] readings) Called before start polling the monitor for statistical data.
boolean	isInitialized()
abstract List<ReadingBean>	pollNewData() Called repetitively in intervals specified by the user.
abstract List<ReadingBean>	pollNewDataForFirstTime() Called only once, then the pollNewData method is called repetitively in intervals specified by the user.
void	setInitialized()
void	setPollInterval(int pollInterval) Set polling interval in seconds

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PerformanceMonitor

public PerformanceMonitor()

Method Detail

init

public abstract void init(ReadingBean[] readings)
                   throws Exception

Called before start polling the monitor for statistical data.
It can be used to take some preparation steps(for example to establish a DB connection)

The user will provide a list of statistics to the monitor. If this monitor supports for example 10 statistics, but the user wants just 2 of them - the monitor class is notified to collect information only about the 2 specified statistics.

Parameters:

readings - list of statistical readings the user wants to get monitored

Throws:

Exception

setPollInterval

public void setPollInterval(int pollInterval)

Set polling interval in seconds

Parameters:

pollInterval - the polling interval in seconds

getPollInterval

public int getPollInterval()

Returns:

the polling interval

isInitialized

public boolean isInitialized()

setInitialized

public void setInitialized()

pollNewDataForFirstTime

public abstract List<ReadingBean> pollNewDataForFirstTime()
                                                   throws Exception

Called only once, then the pollNewData method is called repetitively in intervals specified by the user.

Returns:

the new data

Throws:

Exception

pollNewData

public abstract List<ReadingBean> pollNewData()
                                       throws Exception

Called repetitively in intervals specified by the user.

Returns:

the new data

Throws:

Exception

deinit

public abstract void deinit()
                     throws Exception

Called to do some clean up procedures, for example to release some resources allocated in the init() method

Throws:

Exception

getDescription

public abstract String getDescription()

Returns:

some human understandable description, it is included in some error messages