com.jboss.jbossnetwork.product.jbpm.handlers
Class ControlActionHandler

java.lang.Object
  com.jboss.jbossnetwork.product.jbpm.handlers.BaseHandler
      com.jboss.jbossnetwork.product.jbpm.handlers.ControlActionHandler

All Implemented Interfaces:

Serializable, org.jbpm.graph.def.ActionHandler

public class ControlActionHandler
extends BaseHandler

JBPM handler which executes an action on the JBoss AS instance being manipulated.

Author:

Jason Dobies

See Also:

Serialized Form

Field Summary

Fields inherited from class com.jboss.jbossnetwork.product.jbpm.handlers.BaseHandler

logger, MESSAGE_NO_CHANGES, TRANSITION_ERROR, TRANSITION_SUCCESS

Constructor Summary

ControlActionHandler()

Method Summary

protected void	checkProperties() Ensures the property values that were set in BaseHandler.substituteVariables(org.jbpm.graph.exe.ExecutionContext) are valid.
String	getActionName()
String	getDescription() Returns a user readable description of what the step in the workflow entails.
void	run(org.jbpm.graph.exe.ExecutionContext executionContext) Tells the handle implementation to actually perform the step indicated.
void	setActionName(String actionName)

Methods inherited from class com.jboss.jbossnetwork.product.jbpm.handlers.BaseHandler

complete, error, execute, notRun, setPropertyDefaults, skip, substituteVariable, substituteVariables

Methods inherited from class java.lang.Object

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

Constructor Detail

ControlActionHandler

public ControlActionHandler()

Method Detail

run

public void run(org.jbpm.graph.exe.ExecutionContext executionContext)

Description copied from class: BaseHandler

Tells the handle implementation to actually perform the step indicated.

Specified by:

run in class BaseHandler

Parameters:

executionContext - cannot be null

getDescription

public String getDescription()

Description copied from class: BaseHandler

Returns a user readable description of what the step in the workflow entails.

Specified by:

getDescription in class BaseHandler

Returns:

should not be null

checkProperties

protected void checkProperties()
                        throws ActionHandlerException

Description copied from class: BaseHandler

Ensures the property values that were set in BaseHandler.substituteVariables(org.jbpm.graph.exe.ExecutionContext) are valid. This may optionally be overridden by action handler implementations if necessary.

Overrides:

checkProperties in class BaseHandler

Throws:

ActionHandlerException - if any of the properties are invalid

getActionName

public String getActionName()

setActionName

public void setActionName(String actionName)