org.rhq.core.clientapi.agent.support
Interface SupportAgentService

public interface SupportAgentService

The interface to agent's support subsystem which allows the server to request support tasks to be performed, such as asking a snapshot report to be generated for any resource that supports snapshot reporting.

Method Summary

InputStream

getSnapshotReport(int resourceId, String name, String description) Takes a snapshot and returns the snapshot report content in the given stream.

Method Detail

getSnapshotReport

InputStream getSnapshotReport(int resourceId,
                              String name,
                              String description)
                              throws Exception

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

Parameters:

resourceId - identifies the resource that is to take a snapshot

name - identifies the type of snapshot to take

description - a generic description that can be used to identify the specific snapshot being taken or it can describe why the snapshot was being taken. This is typically text entered by a user.

Returns:

a stream containing the contents of the snapshot report

Throws:

Exception - if failed to generate the snapshot report