org.rhq.enterprise.server.support

Interface SupportManagerRemote

All Known Implementing Classes:

SupportManagerBean

public interface SupportManagerRemote

Provides some methods that are useful for supporting managed resources. This includes being able to take a snapshot report of a managed resource, such as its log files, data files, and anything the managed resource wants to expose.

Author:

John Mazzitelli

Method Summary

Methods

Modifier and Type	Method and Description
URL	getSnapshotReport(org.rhq.core.domain.auth.Subject subject, int resourceId, String name, String description) Asks that a snapshot report be taken of the given resource.

Method Detail

getSnapshotReport

URL getSnapshotReport(org.rhq.core.domain.auth.Subject subject,
                    int resourceId,
                    String name,
                    String description)
                      throws Exception

Asks that a snapshot report be taken of the given resource. Snapshot reports consist of things like log files, data files and configuration files. What is included in snapshot reports is controlled by the resource's plugin configuration. A snapshot report is compressed as a zip file.

Parameters:

subject - the user requesting the snapshot

resourceId - the resource whose snapshot report is to be taken

name - the name of the snapshot report

description - a description for the caller to use to describe the purpose for taking the snapshot report

Returns:

a URL that the caller can use to obtain the snapshot report

Throws:

Exception