org.opennms.systemreport

Interface SystemReportPlugin

All Superinterfaces:

Comparable<SystemReportPlugin>

All Known Implementing Classes:

AbstractSystemReportPlugin, ConfigurationReportPlugin, JavaReportPlugin, LogReportPlugin, LsofReportPlugin, OpenNMSReportPlugin, OSReportPlugin, ThreadReportPlugin, TopEventReportPlugin, TopReportPlugin

public interface SystemReportPlugin
extends Comparable<SystemReportPlugin>

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription() Get a short description of the plugin's operation.
Map<String,org.springframework.core.io.Resource>	getEntries() Get a map of key/value pairs of data exposed by the plugin.
String	getName() Get the name of this report plugin.
int	getPriority() Get the priority of this plugin.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getName

String getName()

Get the name of this report plugin.

Returns:

the name

getDescription

String getDescription()

Get a short description of the plugin's operation.

Returns:

the description

getPriority

int getPriority()

Get the priority of this plugin. This will be used to sort the various plugins' output when creating an aggregate report. 1-10: system-level plugins 11-50: related to core system functionality (eg, events, alarms, notifications) 51-98: related to non-essential system functionality (eg, UI, reporting) 99: unknown priority

Returns:

the priority, from 1 to 99

getEntries

Map<String,org.springframework.core.io.Resource> getEntries()

Get a map of key/value pairs of data exposed by the plugin.

Returns:

the plugin's data