org.hawkular.agent.monitor.cmd

Class AbstractResourcePathCommand<REQ extends org.hawkular.cmdgw.api.ResourcePathRequest,RESP extends org.hawkular.cmdgw.api.ResourcePathResponse>

java.lang.Object

org.hawkular.agent.monitor.cmd.AbstractResourcePathCommand<REQ,RESP>

All Implemented Interfaces:

Command<REQ,RESP>

Direct Known Subclasses:

AbstractRemoveModelNodeCommand, AddDatasourceCommand, AddJdbcDriverCommand, DeployApplicationCommand, DisableApplicationCommand, EnableApplicationCommand, ExecuteOperationCommand, ExportJdrCommand, RestartApplicationCommand, StatisticsControlCommand, UndeployApplicationCommand, UpdateDatasourceCommand

public abstract class AbstractResourcePathCommand<REQ extends org.hawkular.cmdgw.api.ResourcePathRequest,RESP extends org.hawkular.cmdgw.api.ResourcePathResponse>
extends Object
implements Command<REQ,RESP>

A base for Commands initiated by subclasses of ResourcePathRequest.

Author:

Peter Palaga

Field Summary

Fields

Modifier and Type	Field and Description
protected String	entityType A natural language name of entity the present command is creating, removing or updating.
protected String	operationName A natural language name of the operation the present command is performing, such as Updade, Add or Remove.

Constructor Summary

Constructors

Constructor and Description
AbstractResourcePathCommand(String operationName, String entityType)

Method Summary

Modifier and Type	Method and Description
protected void	assertLocalServer(MonitoredEndpoint<? extends MonitorServiceConfiguration.AbstractEndpointConfiguration> endpoint)
protected void	assertNotRename(org.jboss.dmr.ModelNode adr, String newName)
protected abstract RESP	createResponse()
org.hawkular.bus.common.BasicMessageWithExtraData<RESP>	execute(org.hawkular.bus.common.BasicMessageWithExtraData<REQ> envelope, CommandContext context) Performs the command for the server.
protected abstract org.hawkular.bus.common.BinaryData	execute(org.jboss.as.controller.client.ModelControllerClient controllerClient, EndpointService<DMRNodeLocation,DMRSession> endpointService, String modelNodePath, org.hawkular.bus.common.BasicMessageWithExtraData<REQ> envelope, RESP response, CommandContext context, DMRSession dmrContext) Do whatever with the already validated parameters.
protected String	getOperationName(org.hawkular.bus.common.BasicMessageWithExtraData<REQ> envelope)
protected void	setServerRefreshIndicator(OperationBuilder.OperationResult<?> opResults, RESP response) Given the results of an operation, this will set the ServerRefreshIndicator found in those results in the given response.
protected void	success(org.hawkular.bus.common.BasicMessageWithExtraData<REQ> envelope, RESP response)
protected void	validate(org.hawkular.bus.common.BasicMessageWithExtraData<REQ> envelope) Checks if the request has resourcePath field set.
protected abstract void	validate(org.hawkular.bus.common.BasicMessageWithExtraData<REQ> envelope, MonitoredEndpoint<? extends MonitorServiceConfiguration.AbstractEndpointConfiguration> endpoint) Validation for subclasses.
protected abstract void	validate(String modelNodePath, org.hawkular.bus.common.BasicMessageWithExtraData<REQ> envelope) modelNodePath validation for subclasses.

Methods inherited from class java.lang.Object

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

Field Detail

entityType

protected final String entityType

A natural language name of entity the present command is creating, removing or updating. entityType is supposed to be used in log and exception messages primarily. This field should have values like "Datasource", "JDBC Driver" or similar.

operationName

protected final String operationName

A natural language name of the operation the present command is performing, such as Updade, Add or Remove. operationName is supposed to be used in log and exception messages primarily.

Constructor Detail

AbstractResourcePathCommand

public AbstractResourcePathCommand(String operationName,
                                   String entityType)

Method Detail

getOperationName

protected String getOperationName(org.hawkular.bus.common.BasicMessageWithExtraData<REQ> envelope)

execute

public org.hawkular.bus.common.BasicMessageWithExtraData<RESP> execute(org.hawkular.bus.common.BasicMessageWithExtraData<REQ> envelope,
                                                                       CommandContext context)
                                                                throws Exception

Description copied from interface: Command

Performs the command for the server. A non-null return value will be sent back to the server.

Specified by:

execute in interface Command<REQ extends org.hawkular.cmdgw.api.ResourcePathRequest,RESP extends org.hawkular.cmdgw.api.ResourcePathResponse>

Parameters:

envelope - the request that describes what needs to be executed eventually with attached BinaryData

context - contains data that can help commands do their job

Returns:

the results of the command that need to be sent back to the server; if null, nothing will be sent back.

Throws:

Exception - if failed to execute the command

execute

protected abstract org.hawkular.bus.common.BinaryData execute(org.jboss.as.controller.client.ModelControllerClient controllerClient,
                                                              EndpointService<DMRNodeLocation,DMRSession> endpointService,
                                                              String modelNodePath,
                                                              org.hawkular.bus.common.BasicMessageWithExtraData<REQ> envelope,
                                                              RESP response,
                                                              CommandContext context,
                                                              DMRSession dmrContext)
                                                       throws Exception

Do whatever with the already validated parameters.

Parameters:

controllerClient - a plain ModelControllerClient

endpointService - an EndpointService belonging to the resource

modelNodePath - a DMR path acquired from ResourcePathRequest.getResourcePath()

envelope - the request

response - the response

context - the CommandContext

dmrContext - a DMRSession

Returns:

a BinaryData with binary content if this command returns any

Throws:

Exception - if anything goes wrong

validate

protected abstract void validate(String modelNodePath,
                                 org.hawkular.bus.common.BasicMessageWithExtraData<REQ> envelope)

modelNodePath validation for subclasses.

Parameters:

modelNodePath - a DMR path to check

envelope - the request the modelNodePath comes from

validate

protected void validate(org.hawkular.bus.common.BasicMessageWithExtraData<REQ> envelope)

Checks if the request has resourcePath field set. Subclasses may want to add more request validations in their overrides.

Parameters:

envelope - the request to validate

validate

protected abstract void validate(org.hawkular.bus.common.BasicMessageWithExtraData<REQ> envelope,
                                 MonitoredEndpoint<? extends MonitorServiceConfiguration.AbstractEndpointConfiguration> endpoint)

Validation for subclasses.

Parameters:

envelope - a DMR path to check

dmrEndpoint - the request the modelNodePath comes from

createResponse

protected abstract RESP createResponse()

Returns:

a new instance of the appropriate ResourcePathResponse subclass

success

protected void success(org.hawkular.bus.common.BasicMessageWithExtraData<REQ> envelope,
                       RESP response)

setServerRefreshIndicator

protected void setServerRefreshIndicator(OperationBuilder.OperationResult<?> opResults,
                                         RESP response)

Given the results of an operation, this will set the ServerRefreshIndicator found in those results in the given response.

Parameters:

opResults - contains the DMR results

response - the response message

assertLocalServer

protected void assertLocalServer(MonitoredEndpoint<? extends MonitorServiceConfiguration.AbstractEndpointConfiguration> endpoint)

assertNotRename

protected void assertNotRename(org.jboss.dmr.ModelNode adr,
                               String newName)