org.rhq.enterprise.server.support

Class SupportManagerBean

java.lang.Object

org.rhq.enterprise.server.support.SupportManagerBean

All Implemented Interfaces:

SupportManagerLocal, SupportManagerRemote

public class SupportManagerBean
extends Object
implements SupportManagerLocal, 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. This Support subsystem provides things like snapshot reports that are potentially very sensitive and gives the user access to far sweeping data, (e.g. they can contain configuration settings, data files and logs - all of which can contain confidential information). Because of this, most of the methods in this subsystem will require the user to be an "inventory manager" with Permission.MANAGE_INVENTORY permissions.

Author:

John Mazzitelli

Constructor Summary

Constructors

Constructor and Description
SupportManagerBean()

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.
InputStream	getSnapshotReportStream(org.rhq.core.domain.auth.Subject subject, int resourceId, String name, String description)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SupportManagerBean

public SupportManagerBean()

Method Detail

getSnapshotReportStream

public InputStream getSnapshotReportStream(org.rhq.core.domain.auth.Subject subject,
                                  int resourceId,
                                  String name,
                                  String description)
                                    throws Exception

Specified by:

getSnapshotReportStream in interface SupportManagerLocal

Throws:

Exception

getSnapshotReport

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

Description copied from interface: SupportManagerRemote

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.

Specified by:

getSnapshotReport in interface SupportManagerLocal

Specified by:

getSnapshotReport in interface SupportManagerRemote

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