MonitorReport

All Known Implementing Classes:

ActionSkipper, AgeMonitor, ChannelMonitor, DBQuery, DBRecord, ExpectedLog, FileComparator, FileMonitor, FileTester, FTPTester, GenericList, IncrementalMonitor, JMSHealthChecker, JMSLogMonitor, JMSMonitor, JMXQMonitor, JVMMonitor, LatestRecord, Monitor, MultiFileMonitor, NumberMonitor, ProcessMonitor, PropertyMonitor, QMFQMonitor, QReportQuery, QueueMonitor, RedisTester, Report, ReportAggregator, ReportQuery, RMQMonitor, ScriptLauncher, ServiceMonitor, SonicMQMonitor, StaticReport, SyntheticMonitor, SysDataCollector, UnixlogMonitor, URLMonitor, WebOperator, WebTester, WinlogMonitor
```
public interface MonitorReport
```
MonitorReport is an Interface to get a report on a monitored entity

Author:

yannanlu@yahoo.com

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DISABLED` report process is disabled
`static int`	`EXCEPTION` report process gets exception
`static int`	`NOSKIP` report process is done
`static int`	`REPORT_CACHED` private cached report
`static int`	`REPORT_CLUSTER` shared report for all nodes of cluster
`static int`	`REPORT_FINAL` shared final report for the local instance
`static int`	`REPORT_FLOW` shared report for a MessageFlow on the current node
`static int`	`REPORT_LOCAL` private report
`static int`	`REPORT_NODE` shared report for the current node
`static int`	`REPORT_NONE` not a report
`static int`	`REPORT_SHARED` shared report for the local instance
`static int`	`SKIPPED` report process is skipped

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`destroy()` closes and releases all opened resources
`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

- Field Detail
  - EXCEPTION
```
static final int EXCEPTION
```
    report process gets exception
    
    See Also:
    
    Constant Field Values
  - DISABLED
```
static final int DISABLED
```
    report process is disabled
    
    See Also:
    
    Constant Field Values
  - NOSKIP
```
static final int NOSKIP
```
    report process is done
    
    See Also:
    
    Constant Field Values
  - SKIPPED
```
static final int SKIPPED
```
    report process is skipped
    
    See Also:
    
    Constant Field Values
  - REPORT_NONE
```
static final int REPORT_NONE
```
    not a report
    
    See Also:
    
    Constant Field Values
  - REPORT_LOCAL
```
static final int REPORT_LOCAL
```
    private report
    
    See Also:
    
    Constant Field Values
  - REPORT_CACHED
```
static final int REPORT_CACHED
```
    private cached report
    
    See Also:
    
    Constant Field Values
  - REPORT_FINAL
```
static final int REPORT_FINAL
```
    shared final report for the local instance
    
    See Also:
    
    Constant Field Values
  - REPORT_SHARED
```
static final int REPORT_SHARED
```
    shared report for the local instance
    
    See Also:
    
    Constant Field Values
  - REPORT_NODE
```
static final int REPORT_NODE
```
    shared report for the current node
    
    See Also:
    
    Constant Field Values
  - REPORT_FLOW
```
static final int REPORT_FLOW
```
    shared report for a MessageFlow on the current node
    
    See Also:
    
    Constant Field Values
  - REPORT_CLUSTER
```
static final int REPORT_CLUSTER
```
    shared report for all nodes of cluster
    
    See Also:
    
    Constant Field Values
- Method Detail
  - generateReport
```
java.util.Map<java.lang.String,java.lang.Object> generateReport(long currentTime)
                                                         throws java.lang.Exception
```
    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.
    
    Throws:
    
    java.lang.Exception
  - getSkippingStatus
```
int getSkippingStatus()
```
    returns the skipping status
  - getReportName
```
java.lang.String getReportName()
```
    returns the name of the report
  - getReportMode
```
int getReportMode()
```
    returns the report mode
  - getReportKeys
```
java.lang.String[] getReportKeys()
```
    returns a copy of the shared report keys
  - destroy
```
void destroy()
```
    closes and releases all opened resources

Interface MonitorReport

Field Summary

Method Summary

Field Detail

EXCEPTION

DISABLED

NOSKIP

SKIPPED

REPORT_NONE

REPORT_LOCAL

REPORT_CACHED

REPORT_FINAL

REPORT_SHARED

REPORT_NODE

REPORT_FLOW

REPORT_CLUSTER

Method Detail

generateReport

getSkippingStatus

getReportName

getReportMode

getReportKeys

destroy