A B C D E F G H I L M O P R S T U V

A

accept(File, String) - Method in class org.rhq.core.pluginapi.util.SnapshotReport.RegexFilenameFilter

ApplicationServerComponent - Interface in org.rhq.core.pluginapi.inventory

Interface marking a resource component as a server for web applications (EARs, WARs).

applyTransforms(String) - Method in class org.rhq.core.pluginapi.util.ResponseTimeLogParser

auditDeployment(BundleResourceDeployment, String, String, BundleResourceDeploymentHistory.Category, BundleResourceDeploymentHistory.Status, String, String) - Method in interface org.rhq.core.pluginapi.bundle.BundleManagerProvider

Bundle plugins call back into this manager to add progressive auditing of a deployment.

AvailabilityCollectorRunnable - Class in org.rhq.core.pluginapi.availability

A class that can be used by plugins whose components may not be able to collect availability statuses fast enough.

AvailabilityCollectorRunnable(AvailabilityFacet, long, ClassLoader, Executor) - Constructor for class org.rhq.core.pluginapi.availability.AvailabilityCollectorRunnable

Creates a collector instance that will perform availability checking for a particular managed resource.

AvailabilityFacet - Interface in org.rhq.core.pluginapi.availability

Provides the basic availability checking for all managed resources.

B

BundleDeployRequest - Class in org.rhq.core.pluginapi.bundle

A request to deploy a bundle.

BundleDeployRequest() - Constructor for class org.rhq.core.pluginapi.bundle.BundleDeployRequest

BundleDeployResult - Class in org.rhq.core.pluginapi.bundle

The results after an attempt to deploy a bundle has been completed.

BundleDeployResult() - Constructor for class org.rhq.core.pluginapi.bundle.BundleDeployResult

BundleFacet - Interface in org.rhq.core.pluginapi.bundle

Facet that exposes a component's capabilities to process a bundle.

BundleManagerProvider - Interface in org.rhq.core.pluginapi.bundle

Provides bundle functionality that plugin components will need in order to process bundles.

BundlePurgeRequest - Class in org.rhq.core.pluginapi.bundle

A request to purge a bundle, essentially erasing the bundle files from the destination.

BundlePurgeRequest() - Constructor for class org.rhq.core.pluginapi.bundle.BundlePurgeRequest

BundlePurgeResult - Class in org.rhq.core.pluginapi.bundle

The results after an attempt to purge a bundle has been completed.

BundlePurgeResult() - Constructor for class org.rhq.core.pluginapi.bundle.BundlePurgeResult

C

changed() - Method in class org.rhq.core.pluginapi.event.log.LogFileInfo

ClassLoaderFacet<T extends ResourceComponent<?>> - Interface in org.rhq.core.pluginapi.inventory

This allows a discovery component to provide additional jars to placement in a plugin classloader.

ConfigurationFacet - Interface in org.rhq.core.pluginapi.configuration

Components that implement this facet expose the ability to configure resources.

ConfigurationFacetSupport - Interface in org.rhq.core.pluginapi.configuration

ConfigurationUpdateReport - Class in org.rhq.core.pluginapi.configuration

Represents the configuration update request and its results.

ConfigurationUpdateReport(Configuration) - Constructor for class org.rhq.core.pluginapi.configuration.ConfigurationUpdateReport

ContentContext - Interface in org.rhq.core.pluginapi.content

Resource specific context through which to make content related calls back into the plugin container.

ContentFacet - Interface in org.rhq.core.pluginapi.content

Components that implement this facet expose the ability to detect and manage packaged content.

ContentServices - Interface in org.rhq.core.pluginapi.content

This is the interface to the content services provided to a plugin's ContentFacet.

createAvailabilityCollectorRunnable(AvailabilityFacet, long) - Method in class org.rhq.core.pluginapi.inventory.ResourceContext

Under certain circumstances, a resource component may want to perform asynchronous availability checks, as opposed to getAvailability() blocking waiting for the managed resource to return its availability status.

CreateChildResourceFacet - Interface in org.rhq.core.pluginapi.inventory

Components that implement this facet have defined at least one of its child resources is creatable.

createProcessExecution(File) - Static method in class org.rhq.core.pluginapi.util.ProcessExecutionUtility

Creates a ProcessExecution for the specified file for the current platform.

createProcessExecution(String, File) - Static method in class org.rhq.core.pluginapi.util.ProcessExecutionUtility

Creates a ProcessExecution for the specified file for the current platform.

createResource(CreateResourceReport) - Method in interface org.rhq.core.pluginapi.inventory.CreateChildResourceFacet

Creates a new resource.

CreateResourceReport - Class in org.rhq.core.pluginapi.inventory

Value object used between the plugin container and a plugin to carry all data necessary for a create resource operation as well as the resulting status code.

CreateResourceReport(String, ResourceType, Configuration, Configuration, ResourcePackageDetails) - Constructor for class org.rhq.core.pluginapi.inventory.CreateResourceReport

Creates a report with immutable information the plugin should not be able to change.

D

DATE_FORMAT - Static variable in class org.rhq.core.pluginapi.event.log.LogFileEventResourceComponentHelper.LogEventSourcePropertyNames

dateFormat - Variable in class org.rhq.core.pluginapi.event.log.MultiLineLogEntryProcessor

DEFAULT_TIME_MULTIPLIER - Static variable in class org.rhq.core.pluginapi.util.ResponseTimeLogParser

deleteResource() - Method in interface org.rhq.core.pluginapi.inventory.DeleteResourceFacet

Indicates the resource has been deleted.

DeleteResourceFacet - Interface in org.rhq.core.pluginapi.inventory

Components that implement this facet are responsible for deleting resources managed by the component.

deployBundle(BundleDeployRequest) - Method in interface org.rhq.core.pluginapi.bundle.BundleFacet

deployPackages(Set<ResourcePackageDetails>, ContentServices) - Method in interface org.rhq.core.pluginapi.content.ContentFacet

Requests that the content for the given packages be deployed to the resource.

diff() - Method in class org.rhq.core.pluginapi.event.log.LogFileInfo

diff(DirStat) - Method in class org.rhq.core.pluginapi.event.log.LogFileInfo

diff(FileInfo) - Method in class org.rhq.core.pluginapi.event.log.LogFileInfo

discoverDeployedPackages(PackageType) - Method in interface org.rhq.core.pluginapi.content.ContentFacet

Asks that the component run a discovery and return information on all currently installed packages of the specified type.

DiscoveredResourceDetails - Class in org.rhq.core.pluginapi.inventory

This contains all the details for a resource that was discovered by a ResourceDiscoveryComponent.

DiscoveredResourceDetails(ResourceType, String, String, String, String, Configuration, ProcessInfo) - Constructor for class org.rhq.core.pluginapi.inventory.DiscoveredResourceDetails

This creates a new instance that provides details for a newly discovered resource.

discoverResource(Configuration, ResourceDiscoveryContext<T>) - Method in interface org.rhq.core.pluginapi.inventory.ManualAddFacet

Using the specified plugin configuration, creates a DiscoveredResourceDetails object describing a new Resource to be added to inventory.

discoverResources(ResourceDiscoveryContext<T>) - Method in interface org.rhq.core.pluginapi.inventory.ResourceDiscoveryComponent

Asks the discovery component to discover all of its resources.

downloadPackageBits(ContentContext, PackageDetailsKey, OutputStream, boolean) - Method in interface org.rhq.core.pluginapi.content.ContentServices

Requests that the plugin container download and stream the bits for the specified package.

downloadPackageBitsForChildResource(ContentContext, String, PackageDetailsKey, OutputStream) - Method in interface org.rhq.core.pluginapi.content.ContentServices

Requests the plugin container download and stream the bits for the specified package.

downloadPackageBitsRange(ContentContext, PackageDetailsKey, OutputStream, long, long, boolean) - Method in interface org.rhq.core.pluginapi.content.ContentServices

Requests that the plugin container download and stream the bits for the specified package.

E

ENABLED - Static variable in class org.rhq.core.pluginapi.event.log.LogFileEventResourceComponentHelper.LogEventSourcePropertyNames

enableDirStat(boolean) - Method in class org.rhq.core.pluginapi.event.log.LogFileInfo

equals(Object) - Method in class org.rhq.core.pluginapi.event.log.LogFileInfo

equals(Object) - Method in class org.rhq.core.pluginapi.inventory.DiscoveredResourceDetails

EventContext - Interface in org.rhq.core.pluginapi.event

EventPoller - Interface in org.rhq.core.pluginapi.event

A class that polls at a designated interval for Events of a specific type from a specific source.

eventType - Variable in class org.rhq.core.pluginapi.event.log.MultiLineLogEntryProcessor

excludes - Variable in class org.rhq.core.pluginapi.util.ResponseTimeLogParser

F

FILENAME - Static variable in class org.rhq.core.pluginapi.content.version.PackageVersions

Name of the file used to persist the version data.

FileUtils - Class in org.rhq.core.pluginapi.util

A set of utilities for working with files and file paths.

findString(String, String) - Static method in class org.rhq.core.pluginapi.util.FileUtils

G

gather(Sigar, String) - Method in class org.rhq.core.pluginapi.event.log.LogFileInfo

generate() - Method in class org.rhq.core.pluginapi.util.SnapshotReport

generateInstallationSteps(ResourcePackageDetails) - Method in interface org.rhq.core.pluginapi.content.ContentFacet

Returns a list of installation steps that will take place when installing the specified package.

getAbsoluteDestinationDirectory() - Method in class org.rhq.core.pluginapi.bundle.BundleDeployRequest

Returns the full, absolute directory as found on the local machine's file system where the bundle should be deployed.

getAbsoluteDestinationDirectory() - Method in class org.rhq.core.pluginapi.bundle.BundlePurgeRequest

Returns the full, absolute directory as found on the local machine's file system where the bundle should be deployed.

getAdditionalClasspathUrls(ResourceDiscoveryContext<T>, DiscoveredResourceDetails) - Method in interface org.rhq.core.pluginapi.inventory.ClassLoaderFacet

This method provides the location for additional jars that are needed in the resource's classloader in order to properly connect and talk to the managed resource.

getAdditionalFilesToSnapshot() - Method in class org.rhq.core.pluginapi.util.SnapshotReport

getAllBundleVersionPackageVersions(BundleVersion) - Method in interface org.rhq.core.pluginapi.bundle.BundleManagerProvider

Bundle plugins call back into this manager to obtain the bundle files that belong to a given bundle version.

getAllFilesToSnapshot() - Method in class org.rhq.core.pluginapi.util.SnapshotReport

getAtime() - Method in class org.rhq.core.pluginapi.event.log.LogFileInfo

getAutoDiscoveredProcesses() - Method in class org.rhq.core.pluginapi.inventory.ResourceDiscoveryContext

After having scanned all running processes, if the plugin container auto-discovered some resources for the discovery component, those processes will be returned.

getAvailability() - Method in interface org.rhq.core.pluginapi.availability.AvailabilityFacet

The plugin container will occasionally call this method at the server level to see if the server is available.

getBundleFilesLocation() - Method in class org.rhq.core.pluginapi.bundle.BundleDeployRequest

This returns the location where the plugin container has downloaded the bundle files.

getBundleManagerProvider() - Method in class org.rhq.core.pluginapi.bundle.BundleDeployRequest

getBundleManagerProvider() - Method in class org.rhq.core.pluginapi.bundle.BundlePurgeRequest

getCanonicalPath(String) - Static method in class org.rhq.core.pluginapi.util.FileUtils

Canonicalize the specified file path according to the current platform's rules: Condense multiple consecutive path separators into a single path separator.

getComplexResults() - Method in class org.rhq.core.pluginapi.operation.OperationResult

Returns the Configuration object that is used to contain all the complex data that resulted from an operation invocation.

getComplexResults() - Method in class org.rhq.core.pluginapi.operation.OperationServicesResult

getConfigFilesToSnapshot() - Method in class org.rhq.core.pluginapi.util.SnapshotReport

getConfiguration() - Method in class org.rhq.core.pluginapi.configuration.ConfigurationUpdateReport

getConfiguration() - Method in class org.rhq.core.pluginapi.util.SnapshotReport

getConfigurationPath() - Method in interface org.rhq.core.pluginapi.inventory.ApplicationServerComponent

Returns the working path of the application server.

getContentContext() - Method in class org.rhq.core.pluginapi.inventory.ResourceContext

Returns a ContentContext that allows the plugin to access the content functionality provided by the plugin container.

getContentServices() - Method in interface org.rhq.core.pluginapi.content.ContentContext

The object that allows the plugin to obtain content-related information from the plugin container.

getCtime() - Method in class org.rhq.core.pluginapi.event.log.LogFileInfo

getDataDirectory() - Method in class org.rhq.core.pluginapi.inventory.ResourceContext

Directory where plugins can store persisted data that survives plugin container restarts.

getDataDirectory() - Method in class org.rhq.core.pluginapi.plugin.PluginContext

Directory where plugins can store persisted data that survives agent restarts.

getDataFilesToSnapshot() - Method in class org.rhq.core.pluginapi.util.SnapshotReport

getDefaultDateFormat() - Method in class org.rhq.core.pluginapi.event.log.Log4JLogEntryProcessor

getDefaultDateFormat() - Method in class org.rhq.core.pluginapi.event.log.MultiLineLogEntryProcessor

getDefaultPluginConfiguration() - Method in class org.rhq.core.pluginapi.inventory.ResourceDiscoveryContext

Returns the default plugin configuration as defined in the resource type's default template.

getDescription() - Method in class org.rhq.core.pluginapi.support.SnapshotReportRequest

A generic description that can be used to identify the specific snapshot being taken or it can describe why the snapshot was being taken.

getDescription() - Method in class org.rhq.core.pluginapi.upgrade.ResourceUpgradeContext

getDescription() - Method in class org.rhq.core.pluginapi.util.SnapshotReport

getDevice() - Method in class org.rhq.core.pluginapi.event.log.LogFileInfo

getDtdAndXsdSkippingInstance() - Static method in class org.rhq.core.pluginapi.util.SelectiveSkippingEntityResolver

getDuration() - Method in class org.rhq.core.pluginapi.util.ResponseTimeLogParser.LogEntry

getError() - Method in class org.rhq.core.pluginapi.configuration.ValidationError

The error that indicates how or why the value was invalid.

getErrorMessage() - Method in class org.rhq.core.pluginapi.bundle.BundleDeployResult

getErrorMessage() - Method in class org.rhq.core.pluginapi.bundle.BundlePurgeResult

getErrorMessage() - Method in class org.rhq.core.pluginapi.configuration.ConfigurationUpdateReport

getErrorMessage() - Method in class org.rhq.core.pluginapi.inventory.CreateResourceReport

getErrorMessage() - Method in class org.rhq.core.pluginapi.operation.OperationResult

Returns the plugin-specific error message for this operation, or null if the operation was successful.

getErrorStackTrace() - Method in class org.rhq.core.pluginapi.operation.OperationServicesResult

getEventContext() - Method in class org.rhq.core.pluginapi.inventory.ResourceContext

Returns an EventContext, if the resource supports one or more types of Events, or null otherwise.

getEventType() - Method in interface org.rhq.core.pluginapi.event.EventPoller

Returns the type of event (i.e. the EventDefinition name) that this poller checks for.

getEventType() - Method in class org.rhq.core.pluginapi.event.log.LogFileEventPoller

getException() - Method in class org.rhq.core.pluginapi.inventory.CreateResourceReport

getExcludes() - Method in class org.rhq.core.pluginapi.util.ResponseTimeConfiguration

getExcludes() - Method in class org.rhq.core.pluginapi.util.ResponseTimeLogParser

getFileContent(PackageVersion, OutputStream) - Method in interface org.rhq.core.pluginapi.bundle.BundleManagerProvider

Bundle plugins call back into this manager to obtain the bundle file content for the given package.

getGid() - Method in class org.rhq.core.pluginapi.event.log.LogFileInfo

getInode() - Method in class org.rhq.core.pluginapi.event.log.LogFileInfo

getInputStream() - Method in class org.rhq.core.pluginapi.support.SnapshotReportResults

getInvalidValue() - Method in class org.rhq.core.pluginapi.configuration.ValidationError

The value that did not pass the validation tests.

getIpAddress() - Method in class org.rhq.core.pluginapi.util.ResponseTimeLogParser.LogEntry

getLastKnownAvailability() - Method in class org.rhq.core.pluginapi.availability.AvailabilityCollectorRunnable

This returns the last known availability status that was most recently retrieved from the managed resource.

getLiveResourceDeployment() - Method in class org.rhq.core.pluginapi.bundle.BundlePurgeRequest

This is information about the last known live resource deployment - this is to be purged.

getLogFile() - Method in class org.rhq.core.pluginapi.util.ResponseTimeConfiguration

getLogFile() - Method in class org.rhq.core.pluginapi.util.ResponseTimeLogParser

getLogFilesToSnapshot() - Method in class org.rhq.core.pluginapi.util.SnapshotReport

getMode() - Method in class org.rhq.core.pluginapi.event.log.LogFileInfo

getMtime() - Method in class org.rhq.core.pluginapi.event.log.LogFileInfo

getName() - Method in class org.rhq.core.pluginapi.event.log.LogFileInfo

getName() - Method in class org.rhq.core.pluginapi.support.SnapshotReportRequest

Returns the name that identifies the type of snapshot to take.

getName() - Method in class org.rhq.core.pluginapi.upgrade.ResourceUpgradeContext

getName() - Method in class org.rhq.core.pluginapi.util.SnapshotReport

getNativeProcess() - Method in class org.rhq.core.pluginapi.inventory.ResourceContext

Returns the information on the native operating system process in which the managed resource is running.

getNativeProcessesForType() - Method in class org.rhq.core.pluginapi.inventory.ResourceContext

Scans the current list of running processes and returns information on all processes that may contain resources of the same type as this resource.

getNlink() - Method in class org.rhq.core.pluginapi.event.log.LogFileInfo

getOperationContext() - Method in class org.rhq.core.pluginapi.inventory.ResourceContext

Returns an OperationContext that allows the plugin to access the operation functionality provided by the plugin container.

getOperationServices() - Method in interface org.rhq.core.pluginapi.operation.OperationContext

Returns the implementation of the hook into the plugin container.

getPackageBitsLength(ContentContext, PackageDetailsKey) - Method in interface org.rhq.core.pluginapi.content.ContentServices

Requests the size, in bytes, of the identified package version.

getPackageDetails() - Method in class org.rhq.core.pluginapi.inventory.CreateResourceReport

getPackageVersionFiles() - Method in class org.rhq.core.pluginapi.bundle.BundleDeployRequest

Maps all the package versions associated with the bundle and the locations where the package version contents can be found.

getPackageVersionMetadata(ContentContext, PageControl) - Method in interface org.rhq.core.pluginapi.content.ContentServices

Requests all metadata for all package versions that the calling resource component is subscribed to see.

getParentResourceComponent() - Method in class org.rhq.core.pluginapi.inventory.ResourceContext

The parent of the resource component that is associated with this context.

getParentResourceComponent() - Method in class org.rhq.core.pluginapi.inventory.ResourceDiscoveryContext

The resource components for all newly discovered resources will become children of this parent resource component.

getParentResourceContext() - Method in class org.rhq.core.pluginapi.inventory.ResourceDiscoveryContext

Provides access to the parent's resource context.

getParentResourceContext() - Method in class org.rhq.core.pluginapi.upgrade.ResourceUpgradeContext

getPattern() - Method in class org.rhq.core.pluginapi.event.log.Log4JLogEntryProcessor

getPattern() - Method in class org.rhq.core.pluginapi.event.log.MultiLineLogEntryProcessor

getPattern() - Method in class org.rhq.core.pluginapi.util.RegexSubstitution

getPermissions() - Method in class org.rhq.core.pluginapi.event.log.LogFileInfo

getPermissionsString() - Method in class org.rhq.core.pluginapi.event.log.LogFileInfo

getPluginConfiguration() - Method in class org.rhq.core.pluginapi.inventory.CreateResourceReport

getPluginConfiguration() - Method in class org.rhq.core.pluginapi.inventory.DiscoveredResourceDetails

Returns the discovered resource's plugin configuration.

getPluginConfiguration() - Method in class org.rhq.core.pluginapi.inventory.ResourceContext

Returns the resource's plugin configuration.

getPluginConfigurations() - Method in class org.rhq.core.pluginapi.inventory.ResourceDiscoveryContext

Deprecated. discovery components should implement the ManualAddFacet interface, instead of calling this method

getPluginContainerDeployment() - Method in class org.rhq.core.pluginapi.inventory.ResourceContext

Indicates where the plugin container (and therefore where the plugins) are deployed and running.

getPluginContainerDeployment() - Method in class org.rhq.core.pluginapi.inventory.ResourceDiscoveryContext

Indicates where the plugin container (and therefore where the plugins) are deployed and running.

getPluginContainerName() - Method in class org.rhq.core.pluginapi.inventory.ResourceContext

The name of the plugin container in which the resource component is running.

getPluginContainerName() - Method in class org.rhq.core.pluginapi.inventory.ResourceDiscoveryContext

The name of the plugin container in which the discovery component is running.

getPluginContainerName() - Method in class org.rhq.core.pluginapi.plugin.PluginContext

The name of the plugin container in which the plugin is running.

getPluginName() - Method in class org.rhq.core.pluginapi.plugin.PluginContext

The name of the plugin which corresponds to this context object.

getPreviousInfo() - Method in class org.rhq.core.pluginapi.event.log.LogFileInfo

getProcessInfo() - Method in class org.rhq.core.pluginapi.inventory.DiscoveredResourceDetails

Returns the information on the operating system process in which the resource is running.

getProcessInfo() - Method in class org.rhq.core.pluginapi.inventory.ProcessScanResult

Represents the operating system process that matched the process scan's query.

getProcessScan() - Method in class org.rhq.core.pluginapi.inventory.ProcessScanResult

Returns information on the process scan, such as the query that was used to match the process and the process scan's name, if one was provided.

getPropertyName() - Method in class org.rhq.core.pluginapi.configuration.ValidationError

Returns the name of the property whose value did not pass the validation tests.

getReplacement() - Method in class org.rhq.core.pluginapi.util.RegexSubstitution

getResourceConfiguration() - Method in class org.rhq.core.pluginapi.inventory.CreateResourceReport

getResourceConfiguration() - Method in class org.rhq.core.pluginapi.upgrade.ResourceUpgradeContext

getResourceDeployment() - Method in class org.rhq.core.pluginapi.bundle.BundleDeployRequest

getResourceDescription() - Method in class org.rhq.core.pluginapi.inventory.DiscoveredResourceDetails

Gets the simple description of the resource, which may or may not be an internationalized string

getResourceKey() - Method in class org.rhq.core.pluginapi.inventory.CreateResourceReport

getResourceKey() - Method in class org.rhq.core.pluginapi.inventory.DiscoveredResourceDetails

The discovered resource's key where the key must be unique among the resource's sibling resources; that is, a parent's direct child resources must all have unique resource keys, but those keys need not be unique across the entire inventory of all resources.

getResourceKey() - Method in class org.rhq.core.pluginapi.inventory.ResourceContext

The resource key of the resource this context is associated with.

getResourceName() - Method in class org.rhq.core.pluginapi.inventory.CreateResourceReport

getResourceName() - Method in class org.rhq.core.pluginapi.inventory.DiscoveredResourceDetails

The name of the discovered resource, which is used mainly for UI display purposes.

getResourceSubscriptionMD5(ContentContext) - Method in interface org.rhq.core.pluginapi.content.ContentServices

Gets the MD5 hash which identifies a resource "content subscription".

getResourceType() - Method in class org.rhq.core.pluginapi.inventory.CreateResourceReport

getResourceType() - Method in class org.rhq.core.pluginapi.inventory.DiscoveredResourceDetails

The type of resource that was discovered.

getResourceType() - Method in class org.rhq.core.pluginapi.inventory.ResourceContext

The resource type of the resource this context is associated with.

getResourceType() - Method in class org.rhq.core.pluginapi.inventory.ResourceDiscoveryContext

The ResourceDiscoveryComponent that is assigned this context will have the responsibility to discover resources of the resource type returned by this method.

getResourceVersion() - Method in class org.rhq.core.pluginapi.inventory.DiscoveredResourceDetails

The discovered resource's version string (which may have any form or syntax that is appropriate for the resource and may be null)

getResultCode() - Method in class org.rhq.core.pluginapi.operation.OperationServicesResult

getSigar() - Method in interface org.rhq.core.pluginapi.event.EventContext

Gets an instance of Sigar.

getSimpleResult() - Method in class org.rhq.core.pluginapi.operation.OperationResult

Gets the simple string result that was stored in this object.

getSize() - Method in class org.rhq.core.pluginapi.event.log.LogFileInfo

getSnapshotReport(SnapshotReportRequest) - Method in interface org.rhq.core.pluginapi.support.SupportFacet

Takes a snapshot and returns the snapshot report content in the given stream.

getSnapshotReportFile() - Method in class org.rhq.core.pluginapi.util.SnapshotReport

This only returns the file where the snapshot will be stored.

getSourceLocation() - Method in class org.rhq.core.pluginapi.event.log.LogFileEventPoller

getStartTime() - Method in class org.rhq.core.pluginapi.util.ResponseTimeLogParser.LogEntry

getStatus() - Method in class org.rhq.core.pluginapi.configuration.ConfigurationUpdateReport

getStatus() - Method in class org.rhq.core.pluginapi.inventory.CreateResourceReport

getStatusCode() - Method in class org.rhq.core.pluginapi.util.ResponseTimeLogParser.LogEntry

getSystemInformation() - Method in class org.rhq.core.pluginapi.inventory.ResourceContext

Returns a SystemInfo object that contains information about the platform/operating system that the resource is running on.

getSystemInformation() - Method in class org.rhq.core.pluginapi.inventory.ResourceDiscoveryContext

Returns a SystemInfo object that contains information about the platform/operating system that the plugin is running on.

getSystemInformation() - Method in class org.rhq.core.pluginapi.plugin.PluginContext

Returns a SystemInfo object that contains information about the platform/operating system that the plugin is running on.

getTemporaryDirectory() - Method in class org.rhq.core.pluginapi.inventory.ResourceContext

A temporary directory for plugin use that is destroyed at plugin container shutdown.

getTemporaryDirectory() - Method in class org.rhq.core.pluginapi.plugin.PluginContext

A temporary directory for plugin use that is destroyed at agent shutdown.

getTimeMultiplier() - Method in class org.rhq.core.pluginapi.util.ResponseTimeLogParser

getTransforms() - Method in class org.rhq.core.pluginapi.util.ResponseTimeConfiguration

getTransforms() - Method in class org.rhq.core.pluginapi.util.ResponseTimeLogParser

getType() - Method in class org.rhq.core.pluginapi.event.log.LogFileInfo

getTypeChar() - Method in class org.rhq.core.pluginapi.event.log.LogFileInfo

getTypeString() - Method in class org.rhq.core.pluginapi.event.log.LogFileInfo

getUid() - Method in class org.rhq.core.pluginapi.event.log.LogFileInfo

getUrl() - Method in class org.rhq.core.pluginapi.util.ResponseTimeLogParser.LogEntry

getUserSpecifiedResourceName() - Method in class org.rhq.core.pluginapi.inventory.CreateResourceReport

getValues(MeasurementReport, Set<MeasurementScheduleRequest>) - Method in interface org.rhq.core.pluginapi.measurement.MeasurementFacet

Collects measurement data exposed by managed resources and returns that data in a measurement report. the provided set of requests specify which metrics are being requested.

getVersion(String) - Method in class org.rhq.core.pluginapi.content.version.PackageVersionData

Returns the package version associated with the package identified by the specified key.

getVersion(String) - Method in class org.rhq.core.pluginapi.content.version.PackageVersions

Retrieves the version for the package identified by the supplied package key.

getVersion() - Method in class org.rhq.core.pluginapi.inventory.ResourceContext

The version of the resource this context is associated with.

H

hashCode() - Method in class org.rhq.core.pluginapi.event.log.LogFileInfo

hashCode() - Method in class org.rhq.core.pluginapi.inventory.DiscoveredResourceDetails

I

INCLUDES_PATTERN - Static variable in class org.rhq.core.pluginapi.event.log.LogFileEventResourceComponentHelper.LogEventSourcePropertyNames

includesPattern - Variable in class org.rhq.core.pluginapi.event.log.MultiLineLogEntryProcessor

initialize(PluginContext) - Method in interface org.rhq.core.pluginapi.plugin.PluginLifecycleListener

When a plugin is being loaded, this method will be called.

InvalidPluginConfigurationException - Exception in org.rhq.core.pluginapi.inventory

This exception is thrown by plugin resource components when an attempt to connect to a managed resource fails due to an invalid plugin configuration.

InvalidPluginConfigurationException(String) - Constructor for exception org.rhq.core.pluginapi.inventory.InvalidPluginConfigurationException

InvalidPluginConfigurationException(Throwable) - Constructor for exception org.rhq.core.pluginapi.inventory.InvalidPluginConfigurationException

InvalidPluginConfigurationException(String, Throwable) - Constructor for exception org.rhq.core.pluginapi.inventory.InvalidPluginConfigurationException

invokeOperation(String, Configuration) - Method in interface org.rhq.core.pluginapi.operation.OperationFacet

Invoke the operation with the specified name and returns a result set consisting of configuration propeties.

invokeOperation(OperationContext, String, Configuration, long) - Method in interface org.rhq.core.pluginapi.operation.OperationServices

Synchronously invokes an operation on the resource.

isCleanDeployment() - Method in class org.rhq.core.pluginapi.bundle.BundleDeployRequest

isExcluded(String) - Method in class org.rhq.core.pluginapi.util.ResponseTimeLogParser

isRevert() - Method in class org.rhq.core.pluginapi.bundle.BundleDeployRequest

isSuccess() - Method in class org.rhq.core.pluginapi.bundle.BundleDeployResult

isSuccess() - Method in class org.rhq.core.pluginapi.bundle.BundlePurgeResult

L

LEGACY_FILENAME - Static variable in class org.rhq.core.pluginapi.content.version.PackageVersions

Name of the file used in JON 2.1 and earlier to persist the version data.

loadFromDisk() - Method in class org.rhq.core.pluginapi.content.version.PackageVersions

Loads the last known application (package) versions for the plugin this instance is scoped to.

loadRawConfigurations() - Method in interface org.rhq.core.pluginapi.configuration.ResourceConfigurationFacet

loadResourceConfiguration() - Method in interface org.rhq.core.pluginapi.configuration.ConfigurationFacet

Returns the current values for the specified resource.

loadStructuredConfiguration() - Method in interface org.rhq.core.pluginapi.configuration.ResourceConfigurationFacet

log - Variable in class org.rhq.core.pluginapi.event.log.MultiLineLogEntryProcessor

log - Variable in class org.rhq.core.pluginapi.util.ResponseTimeLogParser

Log4JLogEntryProcessor - Class in org.rhq.core.pluginapi.event.log

A LogEntryProcessor for Log4J log files.

Log4JLogEntryProcessor(String, File) - Constructor for class org.rhq.core.pluginapi.event.log.Log4JLogEntryProcessor

LOG_ENTRY_EVENT_TYPE - Static variable in class org.rhq.core.pluginapi.event.log.LogFileEventResourceComponentHelper

LOG_EVENT_SOURCE_CONFIG_PROP - Static variable in class org.rhq.core.pluginapi.event.log.LogFileEventResourceComponentHelper

LOG_EVENT_SOURCES_CONFIG_PROP - Static variable in class org.rhq.core.pluginapi.event.log.LogFileEventResourceComponentHelper

LOG_FILE_PATH - Static variable in class org.rhq.core.pluginapi.event.log.LogFileEventResourceComponentHelper.LogEventSourcePropertyNames

LogEntryProcessor - Interface in org.rhq.core.pluginapi.event.log

A processor for entries from a log file.

logFile - Variable in class org.rhq.core.pluginapi.event.log.MultiLineLogEntryProcessor

logFile - Variable in class org.rhq.core.pluginapi.util.ResponseTimeLogParser

LogFileEventPoller - Class in org.rhq.core.pluginapi.event.log

An Event poller that polls a log file for new entries.

LogFileEventPoller(EventContext, String, File, LogEntryProcessor) - Constructor for class org.rhq.core.pluginapi.event.log.LogFileEventPoller

LogFileEventResourceComponentHelper - Class in org.rhq.core.pluginapi.event.log

LogFileEventResourceComponentHelper(ResourceContext<?>) - Constructor for class org.rhq.core.pluginapi.event.log.LogFileEventResourceComponentHelper

LogFileEventResourceComponentHelper.LogEventSourcePropertyNames - Class in org.rhq.core.pluginapi.event.log

LogFileEventResourceComponentHelper.LogEventSourcePropertyNames() - Constructor for class org.rhq.core.pluginapi.event.log.LogFileEventResourceComponentHelper.LogEventSourcePropertyNames

LogFileInfo - Class in org.rhq.core.pluginapi.event.log

LogFileInfo(FileInfo) - Constructor for class org.rhq.core.pluginapi.event.log.LogFileInfo

LogFileInfo() - Constructor for class org.rhq.core.pluginapi.event.log.LogFileInfo

lookupAttributeProperty(Object, String) - Static method in class org.rhq.core.pluginapi.util.ObjectUtil

Returns the value of the property with the specified name for the given Object, or null if the Object has no such property.

lookupDeepAttributeProperty(Object, String) - Static method in class org.rhq.core.pluginapi.util.ObjectUtil

Looks up deep object graph attributes using a dot delimited java bean spec style path.

lookupDeepNumericAttributeProperty(Object, String) - Static method in class org.rhq.core.pluginapi.util.ObjectUtil

Reads a numeric value from a deep object graph as per ObjectUtil.lookupDeepAttributeProperty()

M

ManualAddFacet<T extends ResourceComponent<?>> - Interface in org.rhq.core.pluginapi.inventory

This allows a discovery component to support Resources being manually added.

MeasurementFacet - Interface in org.rhq.core.pluginapi.measurement

Implementations of this facet perform the collection of measurement data exposed by a managed resource.

mergeRawConfiguration(Configuration, RawConfiguration) - Method in interface org.rhq.core.pluginapi.configuration.ResourceConfigurationFacet

mergeStructuredConfiguration(RawConfiguration, Configuration) - Method in interface org.rhq.core.pluginapi.configuration.ResourceConfigurationFacet

MIN_INTERVAL - Static variable in class org.rhq.core.pluginapi.availability.AvailabilityCollectorRunnable

The minimum interval allowed between availability checks, in milliseconds.

MINIMUM_POLLING_INTERVAL - Static variable in interface org.rhq.core.pluginapi.event.EventContext

Minimum polling interval, in seconds.

MINIMUM_SEVERITY - Static variable in class org.rhq.core.pluginapi.event.log.LogFileEventResourceComponentHelper.LogEventSourcePropertyNames

minimumSeverity - Variable in class org.rhq.core.pluginapi.event.log.MultiLineLogEntryProcessor

modified() - Method in class org.rhq.core.pluginapi.event.log.LogFileInfo

MultiLineLogEntryProcessor - Class in org.rhq.core.pluginapi.event.log

A LogEntryProcessor for multi-line log files - provides several abstract methods that subclasses must implement.

MultiLineLogEntryProcessor(String, File) - Constructor for class org.rhq.core.pluginapi.event.log.MultiLineLogEntryProcessor

MultiLineLogEntryProcessor.LogEntry - Class in org.rhq.core.pluginapi.event.log

MultiLineLogEntryProcessor.LogEntry(Date, EventSeverity, String) - Constructor for class org.rhq.core.pluginapi.event.log.MultiLineLogEntryProcessor.LogEntry

MultiLineLogEntryProcessor.ParseException - Exception in org.rhq.core.pluginapi.event.log

MultiLineLogEntryProcessor.ParseException(String) - Constructor for exception org.rhq.core.pluginapi.event.log.MultiLineLogEntryProcessor.ParseException

MultiLineLogEntryProcessor.ParseException(String, Throwable) - Constructor for exception org.rhq.core.pluginapi.event.log.MultiLineLogEntryProcessor.ParseException

O

ObjectUtil - Class in org.rhq.core.pluginapi.util

OperationContext - Interface in org.rhq.core.pluginapi.operation

Resource specific context through which to make operation calls back into the plugin container.

OperationFacet - Interface in org.rhq.core.pluginapi.operation

This facet must be implemented by resource components that want to expose one or more operations.

OperationResult - Class in org.rhq.core.pluginapi.operation

An object that encapsulates the results of a single operation invocation.

OperationResult() - Constructor for class org.rhq.core.pluginapi.operation.OperationResult

Constructor that builds an empty result.

OperationResult(String) - Constructor for class org.rhq.core.pluginapi.operation.OperationResult

Convenience constructor that builds a result that contains a single, simple result string.

OperationServices - Interface in org.rhq.core.pluginapi.operation

This interface is used by a plugin to communicate back into the plugin container for operations related tasks.

OperationServicesResult - Class in org.rhq.core.pluginapi.operation

Transfer object between the plugin container and the plugin.

OperationServicesResult(OperationServicesResultCode) - Constructor for class org.rhq.core.pluginapi.operation.OperationServicesResult

OperationServicesResultCode - Enum in org.rhq.core.pluginapi.operation

Indicates the results of an operation invocation.

org.rhq.core.pluginapi.availability - package org.rhq.core.pluginapi.availability

org.rhq.core.pluginapi.bundle - package org.rhq.core.pluginapi.bundle

org.rhq.core.pluginapi.configuration - package org.rhq.core.pluginapi.configuration

org.rhq.core.pluginapi.content - package org.rhq.core.pluginapi.content

org.rhq.core.pluginapi.content.version - package org.rhq.core.pluginapi.content.version

org.rhq.core.pluginapi.event - package org.rhq.core.pluginapi.event

org.rhq.core.pluginapi.event.log - package org.rhq.core.pluginapi.event.log

org.rhq.core.pluginapi.inventory - package org.rhq.core.pluginapi.inventory

org.rhq.core.pluginapi.measurement - package org.rhq.core.pluginapi.measurement

org.rhq.core.pluginapi.operation - package org.rhq.core.pluginapi.operation

org.rhq.core.pluginapi.plugin - package org.rhq.core.pluginapi.plugin

org.rhq.core.pluginapi.support - package org.rhq.core.pluginapi.support

org.rhq.core.pluginapi.upgrade - package org.rhq.core.pluginapi.upgrade

org.rhq.core.pluginapi.util - package org.rhq.core.pluginapi.util

P

PackageVersionData - Class in org.rhq.core.pluginapi.content.version

Object that will be persisted to store the versions for packages detected by plugins.

PackageVersionData() - Constructor for class org.rhq.core.pluginapi.content.version.PackageVersionData

PackageVersions - Class in org.rhq.core.pluginapi.content.version

Access to the persistent storage of package versions.

PackageVersions(String, String) - Constructor for class org.rhq.core.pluginapi.content.version.PackageVersions

Creates a new entry point to the persisted version data.

parseDateString(String) - Method in class org.rhq.core.pluginapi.event.log.Log4JLogEntryProcessor

parseDateString(String) - Method in class org.rhq.core.pluginapi.event.log.MultiLineLogEntryProcessor

parseLine(String) - Method in class org.rhq.core.pluginapi.util.ResponseTimeLogParser

Parses a line from a response time log and returns a LogEntry.

parseLog(CallTimeData) - Method in class org.rhq.core.pluginapi.util.ResponseTimeLogParser

Parse the log file, starting at the offset corresponding to the file's size after the last time this method was called.

persistRawConfiguration(RawConfiguration) - Method in interface org.rhq.core.pluginapi.configuration.ResourceConfigurationFacet

persistStructuredConfiguration(Configuration) - Method in interface org.rhq.core.pluginapi.configuration.ResourceConfigurationFacet

PluginContainerDeployment - Enum in org.rhq.core.pluginapi.inventory

This enum indicates where the plugin container (and therefore the plugins) are deployed.

PluginContext - Class in org.rhq.core.pluginapi.plugin

A global context containing information about a plugin.

PluginContext(String, SystemInfo, File, File, String) - Constructor for class org.rhq.core.pluginapi.plugin.PluginContext

Creates a new PluginContext object.

PluginLifecycleListener - Interface in org.rhq.core.pluginapi.plugin

Performs global initialization and shutdown of a plugin.

poll() - Method in interface org.rhq.core.pluginapi.event.EventPoller

Poll for new Events (i.e.

poll() - Method in class org.rhq.core.pluginapi.event.log.LogFileEventPoller

ProcessExecutionUtility - Class in org.rhq.core.pluginapi.util

processLine(String, Set<Event>, MultiLineLogEntryProcessor.LogEntry) - Method in class org.rhq.core.pluginapi.event.log.MultiLineLogEntryProcessor

processLines(BufferedReader) - Method in interface org.rhq.core.pluginapi.event.log.LogEntryProcessor

Processes the specified lines from a log file, and returns a set of Events if appropriate, or otherwise, null.

processLines(BufferedReader) - Method in class org.rhq.core.pluginapi.event.log.MultiLineLogEntryProcessor

processPrimaryLine(Matcher) - Method in class org.rhq.core.pluginapi.event.log.Log4JLogEntryProcessor

processPrimaryLine(Matcher) - Method in class org.rhq.core.pluginapi.event.log.MultiLineLogEntryProcessor

ProcessScanResult - Class in org.rhq.core.pluginapi.inventory

An individual result from a process scan which includes information on the process that matched and the ProcessScan itself.

ProcessScanResult(ProcessScan, ProcessInfo) - Constructor for class org.rhq.core.pluginapi.inventory.ProcessScanResult

PROP_ADDITIONAL_FILES_DIRECTORY - Static variable in class org.rhq.core.pluginapi.util.SnapshotReport

A config property whose value is a directory relative to the base directory where additional files are located.

PROP_ADDITIONAL_FILES_LIST - Static variable in class org.rhq.core.pluginapi.util.SnapshotReport

The property name for the list of of additional files.

PROP_ADDITIONAL_FILES_RECURSIVE - Static variable in class org.rhq.core.pluginapi.util.SnapshotReport

A config property whose value is the boolean flag to indicate if the snapshot should include files found in subdirectories of the additional files directory.

PROP_ADDITIONAL_FILES_REGEX - Static variable in class org.rhq.core.pluginapi.util.SnapshotReport

A config property whose value is a regular expression that matches all additional files that are to be snapshotted.

PROP_BASE_DIRECTORY - Static variable in class org.rhq.core.pluginapi.util.SnapshotReport

A config property whose value is the base directory where all config, logs and data files are under.

PROP_CONFIG_DIRECTORY - Static variable in class org.rhq.core.pluginapi.util.SnapshotReport

A config property whose value is the directory relative to the base directory where the configuration files are located.

PROP_CONFIG_RECURSIVE - Static variable in class org.rhq.core.pluginapi.util.SnapshotReport

A config property whose value is the boolean flag to indicate if the snapshot should include files found in subdirectories of the config directory.

PROP_CONFIG_REGEX - Static variable in class org.rhq.core.pluginapi.util.SnapshotReport

A config property whose value is a regular expression that matches all config files that are to be snapshotted.

PROP_DATA_DIRECTORY - Static variable in class org.rhq.core.pluginapi.util.SnapshotReport

A config property whose value is the directory relative to the base directory where the data files are located.

PROP_DATA_RECURSIVE - Static variable in class org.rhq.core.pluginapi.util.SnapshotReport

A config property whose value is the boolean flag to indicate if the snapshot should include files found in subdirectories of the data directory.

PROP_DATA_REGEX - Static variable in class org.rhq.core.pluginapi.util.SnapshotReport

A config property whose value is a regular expression that matches all data files that are to be snapshotted.

PROP_LOG_DIRECTORY - Static variable in class org.rhq.core.pluginapi.util.SnapshotReport

A config property whose value is the directory relative to the base directory where the log files are located.

PROP_LOG_RECURSIVE - Static variable in class org.rhq.core.pluginapi.util.SnapshotReport

A config property whose value is the boolean flag to indicate if the snapshot should include files found in subdirectories of the log directory.

PROP_LOG_REGEX - Static variable in class org.rhq.core.pluginapi.util.SnapshotReport

A config property whose value is a regular expression that matches all log files that are to be snapshotted.

PROP_REPORT_OUTPUT_DIRECTORY - Static variable in class org.rhq.core.pluginapi.util.SnapshotReport

Optional property that can be specified to define where to store the output snapshot report.

PROP_SNAPSHOT_ADDITIONAL_FILES - Static variable in class org.rhq.core.pluginapi.util.SnapshotReport

A boolean config property that dictates if a snapshot of the additional files should be in the report.

PROP_SNAPSHOT_CONFIG_FILES - Static variable in class org.rhq.core.pluginapi.util.SnapshotReport

A boolean config property that dictates if a snapshot of config files should be in the report.

PROP_SNAPSHOT_DATA_FILES - Static variable in class org.rhq.core.pluginapi.util.SnapshotReport

A boolean config property that dictates if a snapshot of data files should be in the report.

PROP_SNAPSHOT_LOG_FILES - Static variable in class org.rhq.core.pluginapi.util.SnapshotReport

A boolean config property that dictates if a snapshot of log files should be in the report.

publishEvent(Event) - Method in interface org.rhq.core.pluginapi.event.EventContext

Publishes the specified Event.

purge(File, boolean) - Static method in class org.rhq.core.pluginapi.util.FileUtils

The purpose of this method is to purge a directory of all of its contents, but it can also be used to simply delete a given file.

purgeBundle(BundlePurgeRequest) - Method in interface org.rhq.core.pluginapi.bundle.BundleFacet

putVersion(String, String) - Method in class org.rhq.core.pluginapi.content.version.PackageVersions

Updates the store with a new version for the package identified by the specified key.

R

RegexSubstitution - Class in org.rhq.core.pluginapi.util

RegexSubstitution(Pattern, String) - Constructor for class org.rhq.core.pluginapi.util.RegexSubstitution

registerEventPoller(EventPoller, int) - Method in interface org.rhq.core.pluginapi.event.EventContext

Tells the plugin container to start polling for Events using the specified EventPoller.

registerEventPoller(EventPoller, int, String) - Method in interface org.rhq.core.pluginapi.event.EventContext

Tells the plugin container to start polling the specified source for Events using the specified EventPoller.

removePackages(Set<ResourcePackageDetails>) - Method in interface org.rhq.core.pluginapi.content.ContentFacet

Requests that the given installed packages be deleted from the resource.

REPORT_CONFIG_DIRECTORY - Static variable in class org.rhq.core.pluginapi.util.SnapshotReport

The relative directory under the report where the config files can be found.

REPORT_DATA_DIRECTORY - Static variable in class org.rhq.core.pluginapi.util.SnapshotReport

The relative directory under the report where the data files can be found.

REPORT_LOG_DIRECTORY - Static variable in class org.rhq.core.pluginapi.util.SnapshotReport

The relative directory under the report where the log files can be found.

resolveEntity(String, String) - Method in class org.rhq.core.pluginapi.util.SelectiveSkippingEntityResolver

ResourceComponent<T extends ResourceComponent<?>> - Interface in org.rhq.core.pluginapi.inventory

The plugin component that wraps a Resource.

ResourceConfigurationFacet - Interface in org.rhq.core.pluginapi.configuration

ResourceConfigurationUpdateException - Exception in org.rhq.core.pluginapi.configuration

This exception can be thrown by instances of ResourceConfigurationFacet to indicate an update failed.

ResourceConfigurationUpdateException(String) - Constructor for exception org.rhq.core.pluginapi.configuration.ResourceConfigurationUpdateException

ResourceContext<T extends ResourceComponent<?>> - Class in org.rhq.core.pluginapi.inventory

The context object that ResourceComponent objects will have access - it will have all the information that the resource components needs during their lifetime.

ResourceContext(Resource, T, ResourceDiscoveryComponent<T>, SystemInfo, File, File, String, EventContext, OperationContext, ContentContext, Executor, PluginContainerDeployment) - Constructor for class org.rhq.core.pluginapi.inventory.ResourceContext

Creates a new ResourceContext object.

ResourceDiscoveryComponent<T extends ResourceComponent<?>> - Interface in org.rhq.core.pluginapi.inventory

The plugin component that defines how resources are discovered.

ResourceDiscoveryContext<T extends ResourceComponent<?>> - Class in org.rhq.core.pluginapi.inventory

The context object that ResourceDiscoveryComponent objects will have access to when needing to perform its work.

ResourceDiscoveryContext(ResourceType, T, ResourceContext<?>, SystemInfo, List<ProcessScanResult>, String, PluginContainerDeployment) - Constructor for class org.rhq.core.pluginapi.inventory.ResourceDiscoveryContext

Creates a new ResourceDiscoveryContext object.

ResourceDiscoveryContext(ResourceType, T, ResourceContext<?>, SystemInfo, List<ProcessScanResult>, List<Configuration>, String, PluginContainerDeployment) - Constructor for class org.rhq.core.pluginapi.inventory.ResourceDiscoveryContext

Creates a new ResourceDiscoveryContext object.

ResourceUpgradeContext<T extends ResourceComponent<?>> - Class in org.rhq.core.pluginapi.upgrade

Represents a resource during the resource upgrade phase of discovery.

ResourceUpgradeContext(Resource, ResourceContext<?>, T, ResourceDiscoveryComponent<T>, SystemInfo, File, File, String, EventContext, OperationContext, ContentContext, Executor, PluginContainerDeployment) - Constructor for class org.rhq.core.pluginapi.upgrade.ResourceUpgradeContext

ResourceUpgradeFacet<T extends ResourceComponent<?>> - Interface in org.rhq.core.pluginapi.upgrade

This interface is to be implemented by discovery classes if they want to support upgrading the existing resources to a new format needed by an updated resource component.

RESPONSE_TIME_LOG_FILE_CONFIG_PROP - Static variable in class org.rhq.core.pluginapi.util.ResponseTimeConfiguration

RESPONSE_TIME_URL_EXCLUDES_CONFIG_PROP - Static variable in class org.rhq.core.pluginapi.util.ResponseTimeConfiguration

RESPONSE_TIME_URL_TRANSFORMS_CONFIG_PROP - Static variable in class org.rhq.core.pluginapi.util.ResponseTimeConfiguration

ResponseTimeConfiguration - Class in org.rhq.core.pluginapi.util

ResponseTimeConfiguration(Configuration) - Constructor for class org.rhq.core.pluginapi.util.ResponseTimeConfiguration

ResponseTimeLogParser - Class in org.rhq.core.pluginapi.util

This is a very simple log parser that uses a StringTokenizer instead of a regular expression to parse a HTTP response-time log file.

ResponseTimeLogParser(File) - Constructor for class org.rhq.core.pluginapi.util.ResponseTimeLogParser

ResponseTimeLogParser(File, double) - Constructor for class org.rhq.core.pluginapi.util.ResponseTimeLogParser

ResponseTimeLogParser.LogEntry - Class in org.rhq.core.pluginapi.util

ResponseTimeLogParser.LogEntry(String, long, long, Integer, String) - Constructor for class org.rhq.core.pluginapi.util.ResponseTimeLogParser.LogEntry

retrievePackageBits(ResourcePackageDetails) - Method in interface org.rhq.core.pluginapi.content.ContentFacet

Asks that a stream of data containing the installed package contents be returned.

run() - Method in class org.rhq.core.pluginapi.availability.AvailabilityCollectorRunnable

Performs the actual availability checking.

S

saveToDisk() - Method in class org.rhq.core.pluginapi.content.version.PackageVersions

Saves the current state of the application (package) versions to disk.

SelectiveSkippingEntityResolver - Class in org.rhq.core.pluginapi.util

An XML entity resolver that skips resolution of any entities with system IDs that match a specified regular expression.

SelectiveSkippingEntityResolver(String) - Constructor for class org.rhq.core.pluginapi.util.SelectiveSkippingEntityResolver

setAbsoluteDestinationDirectory(File) - Method in class org.rhq.core.pluginapi.bundle.BundleDeployRequest

setAbsoluteDestinationDirectory(File) - Method in class org.rhq.core.pluginapi.bundle.BundlePurgeRequest

setBundleFilesLocation(File) - Method in class org.rhq.core.pluginapi.bundle.BundleDeployRequest

setBundleManagerProvider(BundleManagerProvider) - Method in class org.rhq.core.pluginapi.bundle.BundleDeployRequest

setBundleManagerProvider(BundleManagerProvider) - Method in class org.rhq.core.pluginapi.bundle.BundlePurgeRequest

setCleanDeployment(boolean) - Method in class org.rhq.core.pluginapi.bundle.BundleDeployRequest

setComplexResults(Configuration) - Method in class org.rhq.core.pluginapi.operation.OperationServicesResult

setConfiguration(Configuration) - Method in class org.rhq.core.pluginapi.configuration.ConfigurationUpdateReport

setDateFormat(DateFormat) - Method in class org.rhq.core.pluginapi.event.log.MultiLineLogEntryProcessor

setDateIfNotSet(Date) - Static method in class org.rhq.core.pluginapi.event.log.MultiLineLogEntryProcessor

setErrorMessage(String) - Method in class org.rhq.core.pluginapi.bundle.BundleDeployResult

setErrorMessage(Throwable) - Method in class org.rhq.core.pluginapi.bundle.BundleDeployResult

setErrorMessage(String) - Method in class org.rhq.core.pluginapi.bundle.BundlePurgeResult

setErrorMessage(Throwable) - Method in class org.rhq.core.pluginapi.bundle.BundlePurgeResult

setErrorMessage(String) - Method in class org.rhq.core.pluginapi.configuration.ConfigurationUpdateReport

Calling this method with a non-null error message implies that the request's status is ConfigurationUpdateStatus.FAILURE and will set it as such.

setErrorMessage(String) - Method in class org.rhq.core.pluginapi.inventory.CreateResourceReport

setErrorMessage(String) - Method in class org.rhq.core.pluginapi.operation.OperationResult

Sets whether or not this operation was successful.

setErrorMessageFromThrowable(Throwable) - Method in class org.rhq.core.pluginapi.configuration.ConfigurationUpdateReport

Convienence method that sets the error message to the given throwable's stack trace dump.

setErrorStackTrace(String) - Method in class org.rhq.core.pluginapi.operation.OperationServicesResult

setException(Throwable) - Method in class org.rhq.core.pluginapi.inventory.CreateResourceReport

setExcludes(List<Pattern>) - Method in class org.rhq.core.pluginapi.util.ResponseTimeLogParser

setIncludesPattern(Pattern) - Method in class org.rhq.core.pluginapi.event.log.MultiLineLogEntryProcessor

setLiveResourceDeployment(BundleResourceDeployment) - Method in class org.rhq.core.pluginapi.bundle.BundlePurgeRequest

setLogFile(File) - Method in class org.rhq.core.pluginapi.util.ResponseTimeLogParser

setMinimumSeverity(EventSeverity) - Method in class org.rhq.core.pluginapi.event.log.MultiLineLogEntryProcessor

setPackageVersionFiles(Map<PackageVersion, File>) - Method in class org.rhq.core.pluginapi.bundle.BundleDeployRequest

setPluginConfiguration(Configuration) - Method in class org.rhq.core.pluginapi.inventory.DiscoveredResourceDetails

Defines the discovered resource's plugin configuration.

setResourceDeployment(BundleResourceDeployment) - Method in class org.rhq.core.pluginapi.bundle.BundleDeployRequest

setResourceDescription(String) - Method in class org.rhq.core.pluginapi.inventory.DiscoveredResourceDetails

Sets a simple description of the resource, which may or may not be an internationalized string

setResourceKey(String) - Method in class org.rhq.core.pluginapi.inventory.CreateResourceReport

setResourceKey(String) - Method in class org.rhq.core.pluginapi.inventory.DiscoveredResourceDetails

Sets the discovered resource's unique key.

setResourceName(String) - Method in class org.rhq.core.pluginapi.inventory.CreateResourceReport

setResourceName(String) - Method in class org.rhq.core.pluginapi.inventory.DiscoveredResourceDetails

Sets the name of the discovered resource, which is used mainly for UI display purposes.

setResourceVersion(String) - Method in class org.rhq.core.pluginapi.inventory.DiscoveredResourceDetails

Sets the discovered resource's version string (which may have any form or syntax that is appropriate for the resource and may be null which correlates to an empty version string).

setResultCode(OperationServicesResultCode) - Method in class org.rhq.core.pluginapi.operation.OperationServicesResult

setRevert(boolean) - Method in class org.rhq.core.pluginapi.bundle.BundleDeployRequest

setSimpleResult(String) - Method in class org.rhq.core.pluginapi.operation.OperationResult

Use this method if an operation returned a simple string result.

setStatus(ConfigurationUpdateStatus) - Method in class org.rhq.core.pluginapi.configuration.ConfigurationUpdateReport

setStatus(CreateResourceStatus) - Method in class org.rhq.core.pluginapi.inventory.CreateResourceReport

setTransforms(List<RegexSubstitution>) - Method in class org.rhq.core.pluginapi.util.ResponseTimeLogParser

setUserSpecifiedResourceName(String) - Method in class org.rhq.core.pluginapi.inventory.CreateResourceReport

setVersion(String, String) - Method in class org.rhq.core.pluginapi.content.version.PackageVersionData

Updates the store with a new version for the package identified by the specified key.

shutdown() - Method in interface org.rhq.core.pluginapi.plugin.PluginLifecycleListener

When the plugin container shuts down and it unloads the plugin, this method will be called.

SIMPLE_OPERATION_RESULT_NAME - Static variable in class org.rhq.core.pluginapi.operation.OperationResult

SnapshotReport - Class in org.rhq.core.pluginapi.util

A common snapshot report that allows you to prepare a zip'ed file containing a snapshot of content belonging to a resource.

SnapshotReport(String, String, Configuration) - Constructor for class org.rhq.core.pluginapi.util.SnapshotReport

SnapshotReport.RegexFilenameFilter - Class in org.rhq.core.pluginapi.util

Filename filter that matches the filename if it matches a given regular expression.

SnapshotReport.RegexFilenameFilter(String, String) - Constructor for class org.rhq.core.pluginapi.util.SnapshotReport.RegexFilenameFilter

SnapshotReportRequest - Class in org.rhq.core.pluginapi.support

Encapsulates information about a snapshot report request.

SnapshotReportRequest(String, String) - Constructor for class org.rhq.core.pluginapi.support.SnapshotReportRequest

SnapshotReportResults - Class in org.rhq.core.pluginapi.support

Contains the results of a snapshot report, including a stream to the contents of the snapshot.

SnapshotReportResults(InputStream) - Constructor for class org.rhq.core.pluginapi.support.SnapshotReportResults

Creates the results object.

start() - Method in class org.rhq.core.pluginapi.availability.AvailabilityCollectorRunnable

For those resource components using this availability collector utility, their ResourceComponent#start(org.rhq.core.pluginapi.inventory.ResourceContext) method must call this to start the availability checking that this object performs.

start(ResourceContext<T>) - Method in interface org.rhq.core.pluginapi.inventory.ResourceComponent

Initializes the resource component, possibly connecting to the managed resource itself.

startLogFileEventPollers() - Method in class org.rhq.core.pluginapi.event.log.LogFileEventResourceComponentHelper

stat() - Method in class org.rhq.core.pluginapi.event.log.LogFileInfo

stop() - Method in class org.rhq.core.pluginapi.availability.AvailabilityCollectorRunnable

For those resource components using this availability collector utility, their ResourceComponent#stop() method must call this to stop the availability checking that this object performs.

stop() - Method in interface org.rhq.core.pluginapi.inventory.ResourceComponent

Stops the resource component, which usually indicates the plugin container itself is shutting down.

stopLogFileEventPollers() - Method in class org.rhq.core.pluginapi.event.log.LogFileEventResourceComponentHelper

SupportFacet - Interface in org.rhq.core.pluginapi.support

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

T

toMap() - Method in class org.rhq.core.pluginapi.event.log.LogFileInfo

toString() - Method in class org.rhq.core.pluginapi.bundle.BundleDeployRequest

toString() - Method in class org.rhq.core.pluginapi.bundle.BundleDeployResult

toString() - Method in class org.rhq.core.pluginapi.bundle.BundlePurgeRequest

toString() - Method in class org.rhq.core.pluginapi.bundle.BundlePurgeResult

toString() - Method in class org.rhq.core.pluginapi.configuration.ValidationError

toString() - Method in class org.rhq.core.pluginapi.event.log.LogFileInfo

toString() - Method in class org.rhq.core.pluginapi.inventory.CreateResourceReport

toString() - Method in class org.rhq.core.pluginapi.inventory.DiscoveredResourceDetails

toString() - Method in class org.rhq.core.pluginapi.inventory.ProcessScanResult

toString() - Method in class org.rhq.core.pluginapi.operation.OperationResult

transforms - Variable in class org.rhq.core.pluginapi.util.ResponseTimeLogParser

U

unload() - Method in class org.rhq.core.pluginapi.content.version.PackageVersions

For internal use only - Removes the static data object to simulate the first load in the system.

unregisterEventPoller(String) - Method in interface org.rhq.core.pluginapi.event.EventContext

Tells the plugin container to stop polling for Events of the specified type (i.e.

unregisterEventPoller(String, String) - Method in interface org.rhq.core.pluginapi.event.EventContext

Tells the plugin container to stop polling the specified source for Events of the specified type (i.e.

updateResourceConfiguration(ConfigurationUpdateReport) - Method in interface org.rhq.core.pluginapi.configuration.ConfigurationFacet

Configures the specified resource with the values found in the Configuration object within the given report.

upgrade(ResourceUpgradeContext<T>) - Method in interface org.rhq.core.pluginapi.upgrade.ResourceUpgradeFacet

Specifies what data should change on the provided resource to upgrade it to the current version.

V

validateRawConfiguration(RawConfiguration) - Method in interface org.rhq.core.pluginapi.configuration.ResourceConfigurationFacet

validateStructuredConfiguration(Configuration) - Method in interface org.rhq.core.pluginapi.configuration.ResourceConfigurationFacet

ValidationError - Class in org.rhq.core.pluginapi.configuration

Encapsulates a configuration error that was caused by an invalid configuration value.

ValidationError(String, String, ExceptionPackage) - Constructor for class org.rhq.core.pluginapi.configuration.ValidationError

ValidationError(String, String, String) - Constructor for class org.rhq.core.pluginapi.configuration.ValidationError

valueOf(String) - Static method in enum org.rhq.core.pluginapi.inventory.PluginContainerDeployment

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.rhq.core.pluginapi.operation.OperationServicesResultCode

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.rhq.core.pluginapi.inventory.PluginContainerDeployment

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.rhq.core.pluginapi.operation.OperationServicesResultCode

Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E F G H I L M O P R S T U V