org.qbroker.monitor

Class Report

java.lang.Object

org.qbroker.monitor.Report

All Implemented Interfaces:

MonitorReport

Direct Known Subclasses:

ActionSkipper, FileTester, FTPTester, GenericList, QReportQuery, RedisTester, ReportAggregator, ReportQuery, StaticReport, SysDataCollector, WebTester

public abstract class Report
extends java.lang.Object
implements MonitorReport

Author:

yannanlu@yahoo.com

Field Summary

Fields

Modifier and Type	Field and Description
protected int	cachedSkip
protected java.util.List[]	dependencyGroup
protected boolean	disabledWithReport
protected int	disableMode
protected static java.lang.String	FILE_SEPARATOR
protected static java.lang.String[]	formatText
protected java.lang.String[]	keyList
protected java.lang.String	name
protected org.apache.oro.text.regex.Perl5Matcher	pm
protected java.util.Map<java.lang.String,java.lang.Object>	report
protected int	reportMode
protected java.lang.String	reportName
protected int	resolution
protected int	serialNumber
protected int	skip
protected GenericLogger	statsLogger
protected int	step
protected Template	template
protected java.text.SimpleDateFormat[]	timeFormat
protected Template	timeTemplate
protected java.lang.String	type

Fields inherited from interface org.qbroker.monitor.MonitorReport

DISABLED, EXCEPTION, NOSKIP, REPORT_CACHED, REPORT_CLUSTER, REPORT_FINAL, REPORT_FLOW, REPORT_LOCAL, REPORT_NODE, REPORT_NONE, REPORT_SHARED, SKIPPED

Constructor Summary

Constructors

Constructor and Description
Report(java.util.Map props)

Method Summary

Modifier and Type	Method and Description
void	destroy() closes and releases all opened resources
protected void	finalize()
abstract java.util.Map<java.lang.String,java.lang.Object>	generateReport(long currentTime) generates a report on a monitored entity and returns it as a Map.
java.lang.String[]	getReportKeys() returns a copy of the shared report keys
int	getReportMode() returns the report mode
java.lang.String	getReportName() returns the name of the report
int	getSkippingStatus() returns the skipping status
protected int	initTimeTemplate(java.lang.String text) initializes the time-dependent template for dynamic support
protected java.lang.String	updateContent(long currentTime) returns the updated time-dependent content or null if it is static

Methods inherited from class java.lang.Object

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

Field Detail

name

protected java.lang.String name

type

protected java.lang.String type

step

protected int step

skip

protected int skip

disableMode

protected int disableMode

serialNumber

protected int serialNumber

reportMode

protected int reportMode

cachedSkip

protected int cachedSkip

resolution

protected int resolution

disabledWithReport

protected boolean disabledWithReport

template

protected Template template

report

protected java.util.Map<java.lang.String,java.lang.Object> report

dependencyGroup

protected java.util.List[] dependencyGroup

statsLogger

protected GenericLogger statsLogger

reportName

protected java.lang.String reportName

keyList

protected java.lang.String[] keyList

pm

protected org.apache.oro.text.regex.Perl5Matcher pm

timeFormat

protected java.text.SimpleDateFormat[] timeFormat

timeTemplate

protected Template timeTemplate

formatText

protected static final java.lang.String[] formatText

FILE_SEPARATOR

protected static final java.lang.String FILE_SEPARATOR

Constructor Detail

Report

public Report(java.util.Map props)

Method Detail

generateReport

public abstract java.util.Map<java.lang.String,java.lang.Object> generateReport(long currentTime)
                                                                         throws java.lang.Exception

Description copied from interface: MonitorReport

generates a report on a monitored entity and returns it as a Map. The report Map will be passed to the associated MonitorAction as an opaque object. The action object is supposed to know how to retrieve the information from the report Map.

Specified by:

generateReport in interface MonitorReport

Throws:

java.lang.Exception

getSkippingStatus

public int getSkippingStatus()

Description copied from interface: MonitorReport

returns the skipping status

Specified by:

getSkippingStatus in interface MonitorReport

getReportMode

public int getReportMode()

Description copied from interface: MonitorReport

returns the report mode

Specified by:

getReportMode in interface MonitorReport

getReportName

public java.lang.String getReportName()

Description copied from interface: MonitorReport

returns the name of the report

Specified by:

getReportName in interface MonitorReport

getReportKeys

public java.lang.String[] getReportKeys()

Description copied from interface: MonitorReport

returns a copy of the shared report keys

Specified by:

getReportKeys in interface MonitorReport

initTimeTemplate

protected int initTimeTemplate(java.lang.String text)

initializes the time-dependent template for dynamic support

updateContent

protected java.lang.String updateContent(long currentTime)

returns the updated time-dependent content or null if it is static

destroy

public void destroy()

Description copied from interface: MonitorReport

closes and releases all opened resources

Specified by:

destroy in interface MonitorReport

finalize

protected void finalize()

Overrides:

finalize in class java.lang.Object