org.rhq.modules.plugins.jbossas7

Class BaseServerComponent<T extends ResourceComponent<?>>

java.lang.Object

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

HostControllerComponent, StandaloneASComponent

public abstract class BaseServerComponent<T extends ResourceComponent<?>>
extends BaseComponent<T>
implements MeasurementFacet, BundleHandoverFacet

Base component for functionality that is common to Standalone Servers and Host Controllers.

Author:

Heiko W. Rupp, Ian Springer

Field Summary

Fields

Modifier and Type	Field and Description
protected static long	MAX_TIMEOUT_FAILURE_WAIT

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

MANAGED_SERVER, testConnection

Constructor Summary

Constructors

Constructor and Description
BaseServerComponent()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	collectConfigTrait(org.rhq.core.domain.measurement.MeasurementReport report, org.rhq.core.domain.measurement.MeasurementScheduleRequest request)
protected void	collectEnvironmentTrait(org.rhq.core.domain.measurement.MeasurementReport report, org.rhq.core.domain.measurement.MeasurementScheduleRequest request)
protected String	collectPatches()
protected String	findASDomainHostName()
static String	findASDomainHostName(ASConnection connection) Reads local-host-name attribute
ASConnection	getASConnection() Returns the connection that can be used to send management requests to the managed AS& instance.
protected String	getASHostName() gets AS domain host name (defult is master for HC) null for standalone;
org.rhq.core.domain.measurement.AvailabilityType	getAvailability() Return availability of this resource
protected abstract String	getBaseDirAttributeName()
protected abstract String	getConfigDirAttributeName()
protected abstract Address	getEnvironmentAddress()
protected abstract Address	getHostAddress()
protected abstract AS7Mode	getMode()
String	getReleaseVersion() The release version as returned by the "release-version" attribute of the root node in the management model.
ServerPluginConfiguration	getServerPluginConfiguration()
StartScriptConfiguration	getStartScriptConfiguration()
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
protected BundleHandoverResponse	handleExecuteScript(BundleHandoverRequest handoverRequest)
protected OperationResult	installManagementUser(org.rhq.core.domain.configuration.Configuration parameters, org.rhq.core.domain.configuration.Configuration pluginConfig)
boolean	isManuallyAddedServer()
protected void	onAvailGoesUp() this method get's called when availability was DOWN and now is UP.
protected OperationResult	postProcessResult(String name, Result res) Do some post processing of the Result - especially the 'shutdown' operation needs a special treatment.
void	requestDeferredChildResourcesDiscovery() Requests a deferred child resource discovery for sub-resources of this server.
protected OperationResult	restartServer(org.rhq.core.domain.configuration.Configuration parameters) Restart the server by first executing a 'shutdown' operation via the management API and then calling the startServer() method to start it again.
protected OperationResult	runCliCommand(org.rhq.core.domain.configuration.Configuration parameters) runs jboss-cli executable and returns its output
void	setConnection(ASConnection connection)
void	start(ResourceContext<T> resourceContext) Start the resource connection
protected OperationResult	startServer() Start the server by calling the start script defined in the plugin configuration.
void	stop()
protected boolean	waitUntilDown()

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

collectMulticastAddressTrait, createResource, deleteResource, deployContent, getAddress, getLog, getMetricValue, getPath, getResourceDescription, getServerAddress, getServerComponent, getSocketBindingGroup, getStringValue, includeOOBMessages, invokeOperation, 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

Methods inherited from interface org.rhq.core.pluginapi.bundle.BundleHandoverFacet

handleContent

Field Detail

MAX_TIMEOUT_FAILURE_WAIT

protected static final long MAX_TIMEOUT_FAILURE_WAIT

See Also:

Constant Field Values

Constructor Detail

BaseServerComponent

public BaseServerComponent()

Method Detail

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 BaseComponent<T extends ResourceComponent<?>>

Throws:

Exception

See Also:

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

stop

public void stop()

Specified by:

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

Overrides:

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

getAvailability

public org.rhq.core.domain.measurement.AvailabilityType getAvailability()

Description copied from class: BaseComponent

Return availability of this resource

Specified by:

getAvailability in interface AvailabilityFacet

Overrides:

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

See Also:

AvailabilityFacet.getAvailability()

onAvailGoesUp

protected void onAvailGoesUp()

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

getServerPluginConfiguration

public ServerPluginConfiguration getServerPluginConfiguration()

getStartScriptConfiguration

public StartScriptConfiguration getStartScriptConfiguration()

getASConnection

public ASConnection getASConnection()

Description copied from interface: AS7Component

Returns the connection that can be used to send management requests to the managed AS& instance.

Specified by:

getASConnection in interface AS7Component<T extends ResourceComponent<?>>

Overrides:

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

Returns:

the connection that can be used to send management requests to the managed AS& instance

setConnection

public void setConnection(ASConnection connection)

Overrides:

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

getMode

@NotNull
protected abstract AS7Mode getMode()

restartServer

protected OperationResult restartServer(org.rhq.core.domain.configuration.Configuration parameters)
                                 throws Exception

Restart the server by first executing a 'shutdown' operation via the management API and then calling the startServer() method to start it again.

Parameters:

parameters - Parameters to pass to the (recursive) invocation of #invokeOperation

Returns:

State of execution

Throws:

Exception - If anything goes wrong

waitUntilDown

protected boolean waitUntilDown()
                         throws InterruptedException

Throws:

InterruptedException

startServer

protected OperationResult startServer()
                               throws InterruptedException

Start the server by calling the start script defined in the plugin configuration.

Returns:

the result of the operation

Throws:

InterruptedException

runCliCommand

protected OperationResult runCliCommand(org.rhq.core.domain.configuration.Configuration parameters)
                                 throws InterruptedException

runs jboss-cli executable and returns its output

Parameters:

parameters - input configuration (either commands or file sipmle-property is expected)

Returns:

the result of the operation

Throws:

InterruptedException

isManuallyAddedServer

public boolean isManuallyAddedServer()

postProcessResult

protected OperationResult postProcessResult(String name,
                                Result res)

Do some post processing of the Result - especially the 'shutdown' operation needs a special treatment.

Parameters:

name - Name of the operation

res - Result of the operation vs. AS7

Returns:

OperationResult filled in from values of res

installManagementUser

protected OperationResult installManagementUser(org.rhq.core.domain.configuration.Configuration parameters,
                                    org.rhq.core.domain.configuration.Configuration pluginConfig)

requestDeferredChildResourcesDiscovery

public void requestDeferredChildResourcesDiscovery()

Requests a deferred child resource discovery for sub-resources of this server.

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 BaseComponent<T extends ResourceComponent<?>>

Throws:

Exception

See Also:

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

getReleaseVersion

public String getReleaseVersion()

The release version as returned by the "release-version" attribute of the root node in the management model.

handleExecuteScript

protected BundleHandoverResponse handleExecuteScript(BundleHandoverRequest handoverRequest)
                                              throws IOException

Throws:

IOException

getEnvironmentAddress

@NotNull
protected abstract Address getEnvironmentAddress()

getHostAddress

@NotNull
protected abstract Address getHostAddress()

getBaseDirAttributeName

@NotNull
protected abstract String getBaseDirAttributeName()

getConfigDirAttributeName

@NotNull
protected abstract String getConfigDirAttributeName()

getTempDirAttributeName

protected String getTempDirAttributeName()

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

Returns:

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

collectConfigTrait

protected void collectConfigTrait(org.rhq.core.domain.measurement.MeasurementReport report,
                      org.rhq.core.domain.measurement.MeasurementScheduleRequest request)

collectEnvironmentTrait

protected void collectEnvironmentTrait(org.rhq.core.domain.measurement.MeasurementReport report,
                           org.rhq.core.domain.measurement.MeasurementScheduleRequest request)

getASHostName

protected String getASHostName()

gets AS domain host name (defult is master for HC) null for standalone;

Returns:

AS domain host name

findASDomainHostName

protected String findASDomainHostName()

See Also:

findASDomainHostName(ASConnection)

findASDomainHostName

public static String findASDomainHostName(ASConnection connection)

Reads local-host-name attribute

Returns:

name current host within EAP domain or null if we failed to read it

collectPatches

protected String collectPatches()