org.rhq.modules.plugins.jbossas7

Class HostControllerComponent<T extends ResourceComponent<?>>

java.lang.Object

org.rhq.modules.plugins.jbossas7.BaseComponent<T>

org.rhq.modules.plugins.jbossas7.BaseServerComponent<T>

org.rhq.modules.plugins.jbossas7.HostControllerComponent<T>

All Implemented Interfaces:

AvailabilityFacet, BundleHandoverFacet, ConfigurationFacet, CreateChildResourceFacet, DeleteResourceFacet, ResourceComponent<T>, MeasurementFacet, OperationFacet, AS7Component<T>

public class HostControllerComponent<T extends ResourceComponent<?>>
extends BaseServerComponent<T>
implements MeasurementFacet, OperationFacet

Component class for AS7 host and domain controllers.

Author:

Heiko W. Rupp

Field Summary

Fields inherited from class org.rhq.modules.plugins.jbossas7.BaseServerComponent

MAX_TIMEOUT_FAILURE_WAIT

Fields inherited from class org.rhq.modules.plugins.jbossas7.BaseComponent

MANAGED_SERVER, testConnection

Constructor Summary

Constructors

Constructor and Description
HostControllerComponent()

Method Summary

Methods

Modifier and Type	Method and Description
CreateResourceReport	createResource(CreateResourceReport report)
protected String	getBaseDirAttributeName()
protected String	getConfigDirAttributeName()
protected Address	getEnvironmentAddress()
protected Address	getHostAddress()
protected AS7Mode	getMode()
protected String	getTempDirAttributeName() Default implentation.
void	getValues(org.rhq.core.domain.measurement.MeasurementReport report, Set<org.rhq.core.domain.measurement.MeasurementScheduleRequest> requests) Gather measurement data
BundleHandoverResponse	handleContent(BundleHandoverRequest handoverRequest) Handles content handed over during a bundle deployment. This component supports the following actions: action = deployment: deploys the content to a server group Required parameters: serverGroup: The name of the server group this deployment should be deployed to Optional parameters: runtimeName: Runtime name of the uploaded file (e.g.
OperationResult	invokeOperation(String name, org.rhq.core.domain.configuration.Configuration parameters)
boolean	isDomainController()
protected void	onAvailGoesUp() this method get's called when availability was DOWN and now is UP.
void	setDomainController(boolean domainController)
void	start(ResourceContext<T> resourceContext) Start the resource connection

Methods inherited from class org.rhq.modules.plugins.jbossas7.BaseServerComponent

collectConfigTrait, collectEnvironmentTrait, collectPatches, findASDomainHostName, findASDomainHostName, getASConnection, getASHostName, getAvailability, getReleaseVersion, getServerPluginConfiguration, getStartScriptConfiguration, handleExecuteScript, installManagementUser, isManuallyAddedServer, postProcessResult, requestDeferredChildResourcesDiscovery, restartServer, runCliCommand, setConnection, startServer, stop, waitUntilDown

Methods inherited from class org.rhq.modules.plugins.jbossas7.BaseComponent

collectMulticastAddressTrait, deleteResource, deployContent, getAddress, getLog, getMetricValue, getPath, getResourceDescription, getServerAddress, getServerComponent, getSocketBindingGroup, getStringValue, includeOOBMessages, loadResourceConfiguration, readAttribute, readAttribute, readAttribute, readAttribute, readAttribute, readAttribute, runDeploymentMagicOnServer, setPath, updateResourceConfiguration

Methods inherited from class java.lang.Object

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

Constructor Detail

HostControllerComponent

public HostControllerComponent()

Method Detail

getMode

protected AS7Mode getMode()

Specified by:

getMode in class BaseServerComponent<T extends ResourceComponent<?>>

start

public void start(ResourceContext<T> resourceContext)
           throws Exception

Description copied from class: BaseComponent

Start the resource connection

Specified by:

start in interface ResourceComponent<T extends ResourceComponent<?>>

Overrides:

start in class BaseServerComponent<T extends ResourceComponent<?>>

Throws:

Exception

See Also:

ResourceComponent.start(org.rhq.core.pluginapi.inventory.ResourceContext)

onAvailGoesUp

protected void onAvailGoesUp()

Description copied from class: BaseServerComponent

this method get's called when availability was DOWN and now is UP. When overriding, don't forget to call super impl.

Overrides:

onAvailGoesUp in class BaseServerComponent<T extends ResourceComponent<?>>

getValues

public void getValues(org.rhq.core.domain.measurement.MeasurementReport report,
             Set<org.rhq.core.domain.measurement.MeasurementScheduleRequest> requests)
               throws Exception

Description copied from class: BaseComponent

Gather measurement data

Specified by:

getValues in interface MeasurementFacet

Overrides:

getValues in class BaseServerComponent<T extends ResourceComponent<?>>

Throws:

Exception

See Also:

MeasurementFacet.getValues(org.rhq.core.domain.measurement.MeasurementReport, java.util.Set)

invokeOperation

public OperationResult invokeOperation(String name,
                              org.rhq.core.domain.configuration.Configuration parameters)
                                throws Exception

Specified by:

invokeOperation in interface OperationFacet

Overrides:

invokeOperation in class BaseComponent<T extends ResourceComponent<?>>

Throws:

Exception

createResource

public CreateResourceReport createResource(CreateResourceReport report)

Specified by:

createResource in interface CreateChildResourceFacet

Overrides:

createResource in class BaseComponent<T extends ResourceComponent<?>>

handleContent

public BundleHandoverResponse handleContent(BundleHandoverRequest handoverRequest)

Handles content handed over during a bundle deployment.

This component supports the following actions:

action = deployment: deploys the content to a server group

Required parameters:

• serverGroup: The name of the server group this deployment should be deployed to

Optional parameters:

• runtimeName: Runtime name of the uploaded file (e.g. 'my.war'); if not present, the file name is used

action = execute-script: executes a server CLI script

Optional parameters:

• waitTime (in seconds): how long to wait for completion; defaults to an hour
• killOnTimeout (true/false): should the CLI process be killed if timeout is reached; defaults to false

Specified by:

handleContent in interface BundleHandoverFacet

Parameters:

handoverRequest - handover parameters and context

Returns:

a report object indicating success or failure

isDomainController

public boolean isDomainController()

setDomainController

public void setDomainController(boolean domainController)

getEnvironmentAddress

@NotNull
protected Address getEnvironmentAddress()

Specified by:

getEnvironmentAddress in class BaseServerComponent<T extends ResourceComponent<?>>

getHostAddress

@NotNull
protected Address getHostAddress()

Specified by:

getHostAddress in class BaseServerComponent<T extends ResourceComponent<?>>

getBaseDirAttributeName

@NotNull
protected String getBaseDirAttributeName()

Specified by:

getBaseDirAttributeName in class BaseServerComponent<T extends ResourceComponent<?>>

getConfigDirAttributeName

@NotNull
protected String getConfigDirAttributeName()

Specified by:

getConfigDirAttributeName in class BaseServerComponent<T extends ResourceComponent<?>>

getTempDirAttributeName

protected String getTempDirAttributeName()

Description copied from class: BaseServerComponent

Default implentation. Override in concrete subclasses and return the the temporary directory attribute name, found on the node at BaseServerComponent.getEnvironmentAddress().

Overrides:

getTempDirAttributeName in class BaseServerComponent<T extends ResourceComponent<?>>

Returns:

the temp dir attribute name or null if no such attribute exists