Monitor

java.lang.Object
- org.qbroker.monitor.Monitor

All Implemented Interfaces:

MonitorAction, MonitorReport

Direct Known Subclasses:

AgeMonitor, ChannelMonitor, DBQuery, DBRecord, ExpectedLog, FileComparator, FileMonitor, IncrementalMonitor, JMSHealthChecker, JMSLogMonitor, JMSMonitor, JMXQMonitor, JVMMonitor, LatestRecord, MultiFileMonitor, NumberMonitor, ProcessMonitor, PropertyMonitor, QMFQMonitor, QueueMonitor, RMQMonitor, ScriptLauncher, ServiceMonitor, SonicMQMonitor, SyntheticMonitor, UnixlogMonitor, URLMonitor, WebOperator, WinlogMonitor
```
public abstract class Monitor
extends java.lang.Object
implements MonitorReport, MonitorAction
```
Monitor is an abstract class with partial implementation of both MonitorReport and MonitorAction. It has two abstract methods, generateReport() and performAction(). Other methods can be overridden if it is necessary.

Author:

yannanlu@yahoo.com

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`actionCount`
`protected EventActionGroup`	`actionGroup`
`protected org.apache.oro.text.regex.Pattern[][]`	`aPatternGroup`
`protected int`	`cachedSkip`
`protected java.lang.String`	`category`
`protected java.util.List[]`	`dependencyGroup`
`protected java.lang.String`	`description`
`protected boolean`	`disabledWithReport`
`protected int`	`disableMode`
`protected int`	`exceptionCount`
`protected int`	`exceptionTolerance`
`protected static java.lang.String`	`FILE_SEPARATOR`
`protected static java.lang.String[]`	`formatText`
`protected java.lang.String[]`	`keyList`
`protected int`	`maxPage`
`protected int`	`maxRetry`
`protected java.lang.String`	`name`
`protected int`	`normalStep`
`protected org.apache.oro.text.regex.Perl5Matcher`	`pm`
`protected int`	`previousStatus`
`protected int`	`repeatPeriod`
`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 java.lang.String`	`site`
`protected int`	`skip`
`protected GenericLogger`	`statsLogger`
`protected int`	`statusOffset`
`protected static java.lang.String[]`	`statusText`
`protected int`	`step`
`protected Template`	`template`
`protected java.text.SimpleDateFormat[]`	`timeFormat`
`protected Template`	`timeTemplate`
`protected int`	`tolerance`
`protected java.lang.String`	`type`
`protected org.apache.oro.text.regex.Pattern[][]`	`xPatternGroup`

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

Monitor(java.util.Map props)

Constructors
Constructor and Description
`Monitor(java.util.Map props)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.Map<java.lang.String,java.lang.Object>`	`checkpoint()` returns the checkpoint Map for the action
`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`	`getName()` returns the name of the action
`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
`abstract Event`	`performAction(int status, long currentTime, java.util.Map<java.lang.String,java.lang.Object> latest)` examines the report on the monitored entity and reacts to it as an action
`void`	`restoreFromCheckpoint(java.util.Map<java.lang.String,java.lang.Object> chkpt)` restores the state of the action from the checkpoint Map
`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
```
  - site
```
protected java.lang.String site
```
  - category
```
protected java.lang.String category
```
  - type
```
protected java.lang.String type
```
  - description
```
protected java.lang.String description
```
  - template
```
protected Template template
```
  - report
```
protected java.util.Map<java.lang.String,java.lang.Object> report
```
  - actionGroup
```
protected EventActionGroup actionGroup
```
  - dependencyGroup
```
protected java.util.List[] dependencyGroup
```
  - maxRetry
```
protected int maxRetry
```
  - maxPage
```
protected int maxPage
```
  - tolerance
```
protected int tolerance
```
  - exceptionTolerance
```
protected int exceptionTolerance
```
  - repeatPeriod
```
protected int repeatPeriod
```
  - step
```
protected int step
```
  - normalStep
```
protected int normalStep
```
  - serialNumber
```
protected int serialNumber
```
  - previousStatus
```
protected int previousStatus
```
  - skip
```
protected int skip
```
  - actionCount
```
protected int actionCount
```
  - exceptionCount
```
protected int exceptionCount
```
  - disableMode
```
protected int disableMode
```
  - reportMode
```
protected int reportMode
```
  - statusOffset
```
protected int statusOffset
```
  - cachedSkip
```
protected int cachedSkip
```
  - resolution
```
protected int resolution
```
  - disabledWithReport
```
protected boolean disabledWithReport
```
  - statsLogger
```
protected GenericLogger statsLogger
```
  - aPatternGroup
```
protected org.apache.oro.text.regex.Pattern[][] aPatternGroup
```
  - xPatternGroup
```
protected org.apache.oro.text.regex.Pattern[][] xPatternGroup
```
  - pm
```
protected org.apache.oro.text.regex.Perl5Matcher pm
```
  - reportName
```
protected java.lang.String reportName
```
  - keyList
```
protected java.lang.String[] keyList
```
  - timeFormat
```
protected java.text.SimpleDateFormat[] timeFormat
```
  - timeTemplate
```
protected Template timeTemplate
```
  - statusText
```
protected static final java.lang.String[] statusText
```
  - formatText
```
protected static final java.lang.String[] formatText
```
  - FILE_SEPARATOR
```
protected static final java.lang.String FILE_SEPARATOR
```
- Constructor Detail
  - Monitor
```
public Monitor(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
  - performAction
```
public abstract Event performAction(int status,
                                    long currentTime,
                                    java.util.Map<java.lang.String,java.lang.Object> latest)
```
    Description copied from interface: MonitorAction
    
    examines the report on the monitored entity and reacts to it as an action
    
    Specified by:
    
    performAction in interface MonitorAction
  - getName
```
public java.lang.String getName()
```
    Description copied from interface: MonitorAction
    
    returns the name of the action
    
    Specified by:
    
    getName in interface MonitorAction
  - 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
  - checkpoint
```
public java.util.Map<java.lang.String,java.lang.Object> checkpoint()
```
    Description copied from interface: MonitorAction
    
    returns the checkpoint Map for the action
    
    Specified by:
    
    checkpoint in interface MonitorAction
  - restoreFromCheckpoint
```
public void restoreFromCheckpoint(java.util.Map<java.lang.String,java.lang.Object> chkpt)
```
    Description copied from interface: MonitorAction
    
    restores the state of the action from the checkpoint Map
    
    Specified by:
    
    restoreFromCheckpoint in interface MonitorAction
  - 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

Class Monitor

Field Summary

Fields inherited from interface org.qbroker.monitor.MonitorReport

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

site

category

type

description

template

report

actionGroup

dependencyGroup

maxRetry

maxPage

tolerance

exceptionTolerance

repeatPeriod

step

normalStep

serialNumber

previousStatus

skip

actionCount

exceptionCount

disableMode

reportMode

statusOffset

cachedSkip

resolution

disabledWithReport

statsLogger

aPatternGroup

xPatternGroup

pm

reportName

keyList

timeFormat

timeTemplate

statusText

formatText

FILE_SEPARATOR

Constructor Detail

Monitor

Method Detail

generateReport

performAction

getName

getSkippingStatus

getReportMode

getReportName

getReportKeys

checkpoint

restoreFromCheckpoint

initTimeTemplate

updateContent

destroy

finalize