org.rhq.core.pluginapi.support
Interface SupportFacet

public interface SupportFacet

Facet that exposes a component's supportability features, such as taking a snapshot report of its logs, config and other data.

Author:

John Mazzitelli

Method Summary

SnapshotReportResults

getSnapshotReport(SnapshotReportRequest request) Takes a snapshot and returns the snapshot report content in the given stream.

Method Detail

getSnapshotReport

SnapshotReportResults getSnapshotReport(SnapshotReportRequest request)
                                        throws Exception

Takes a snapshot and returns the snapshot report content in the given stream. A facet implementation can support different kinds of snapshots, the given name determines which kind of snapshot to take.

Parameters:

request - identifies the type of snapshot to take

Returns:

snapshot results, including a stream containing the contents of the snapshot report

Throws:

Exception - if failed to generate the snapshot report