org.rhq.plugins.script

Class ScriptDiscoveryComponent

java.lang.Object

org.rhq.plugins.script.ScriptDiscoveryComponent

All Implemented Interfaces:

ManualAddFacet<ResourceComponent<?>>, ResourceDiscoveryComponent<ResourceComponent<?>>

public class ScriptDiscoveryComponent
extends Object
implements ResourceDiscoveryComponent<ResourceComponent<?>>, ManualAddFacet<ResourceComponent<?>>

Discovery component that allows you to manually add your own CLI-managed resource, where the CLI is some executable binary or script. The CLI executable/script itself is not the managed resource, it is merely the management front end to the actual managed resource.

Author:

John Mazzitelli

Constructor Summary

Constructors

Constructor and Description
ScriptDiscoveryComponent()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	determineDescription(ResourceDiscoveryContext<ResourceComponent<?>> context, org.rhq.core.domain.configuration.Configuration pluginConfig) Attempts to determine the description of the resource managed by the CLI.
protected String	determineVersion(ResourceDiscoveryContext<ResourceComponent<?>> context, org.rhq.core.domain.configuration.Configuration pluginConfig) Attempts to determine the version of the resource managed by the CLI.
DiscoveredResourceDetails	discoverResource(org.rhq.core.domain.configuration.Configuration pluginConfig, ResourceDiscoveryContext<ResourceComponent<?>> discoveryContext)
Set<DiscoveredResourceDetails>	discoverResources(ResourceDiscoveryContext<ResourceComponent<?>> context)
protected DiscoveredResourceDetails	processAutoDiscoveredResource(ResourceDiscoveryContext<ResourceComponent<?>> context, ProcessScanResult autoDiscoveryResult) Subclasses should override this method if their plugin descriptors defined process scans.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptDiscoveryComponent

public ScriptDiscoveryComponent()

Method Detail

discoverResources

public Set<DiscoveredResourceDetails> discoverResources(ResourceDiscoveryContext<ResourceComponent<?>> context)

Specified by:

discoverResources in interface ResourceDiscoveryComponent<ResourceComponent<?>>

discoverResource

public DiscoveredResourceDetails discoverResource(org.rhq.core.domain.configuration.Configuration pluginConfig,
                                         ResourceDiscoveryContext<ResourceComponent<?>> discoveryContext)
                                           throws InvalidPluginConfigurationException

Specified by:

discoverResource in interface ManualAddFacet<ResourceComponent<?>>

Throws:

InvalidPluginConfigurationException

processAutoDiscoveredResource

protected DiscoveredResourceDetails processAutoDiscoveredResource(ResourceDiscoveryContext<ResourceComponent<?>> context,
                                                      ProcessScanResult autoDiscoveryResult)

Subclasses should override this method if their plugin descriptors defined process scans. This method is called for each process that was discovered that matched a process scan. Implementors must return a details object that represents the discovered resource. If this returns null, this process will be ignored and no resource will be discovered.

Parameters:

context - the discovery context

autoDiscoveryResult - information on the discovered process

Returns:

the details object that represents the discovered resource

determineDescription

protected String determineDescription(ResourceDiscoveryContext<ResourceComponent<?>> context,
                          org.rhq.core.domain.configuration.Configuration pluginConfig)

Attempts to determine the description of the resource managed by the CLI.

Parameters:

context -

pluginConfig -

Returns:

the description or null if it could not be determined

determineVersion

protected String determineVersion(ResourceDiscoveryContext<ResourceComponent<?>> context,
                      org.rhq.core.domain.configuration.Configuration pluginConfig)

Attempts to determine the version of the resource managed by the CLI.

Parameters:

context -

pluginConfig -

Returns:

the version or null if it could not be determined