org.jboss.soa.esb.util.jbpm
Class CommandVehicle

java.lang.Object
  org.jboss.soa.esb.util.AbstractCommandVehicle
      org.jboss.soa.esb.util.jbpm.CommandVehicle

All Implemented Interfaces:

java.io.Serializable

public class CommandVehicle
extends AbstractCommandVehicle

Base class to use when a jBPM command should go through the wire to a jBPM aware ESB action class.

When more commands are added to the 'Command' enumeration, corresponding action class (org.jboss.soa.esb.actions.JbpmCommandInterpreter) should be modified accordingly in order to execute new commands

Author:

schifest@heuristica.com.ar

See Also:

Serialized Form

Nested Class Summary

static class

CommandVehicle.Operation

Field Summary

static java.lang.String	CURRENT_NODE_NAME
static java.lang.String	ERROR_MESSAGE
static java.lang.String	EXCEPTION
static java.lang.String	PROCESS_DEFINITION
static java.lang.String	PROCESS_DEFINITION_NAME
static java.lang.String	PROCESS_DEFINITION_VERSION
static java.lang.String	PROCESS_INSTANCE_ID
static java.lang.String	RETCODE_ERROR
static java.lang.String	RETCODE_EXCEPTION
static java.lang.String	RETCODE_INVALID_OPCODE
static java.lang.String	RETCODE_OK
static java.lang.String	RETURN_CODE
static java.lang.String	TOKEN_ID
static java.lang.String	TRANSITION_NAME
static java.lang.String	USER_OBJECT
static java.lang.String	VARIABLE_NAMES_LIST
static java.lang.String	VARIABLE_VALUES

Fields inherited from class org.jboss.soa.esb.util.AbstractCommandVehicle

_operator, _values

Constructor Summary

CommandVehicle(java.lang.Enum command)

CommandVehicle(Message message)

Method Summary

java.lang.String	getCommandOpcodeKey() The key for the command operation code in the command values map
java.lang.String	getCommandValuesTag() Provide a name for the named object to look for in the ESB Message body.
java.lang.String	getCurrentNodeName()
java.lang.String	getErrorMessage()
java.lang.Exception	getException()
long	getInstanceId()
org.jbpm.graph.def.ProcessDefinition	getProcessDefinition()
java.lang.String	getProcessDefinitionName()
int	getProcessVersion()
java.lang.Object	getReturnCode()
long	getTokenId()
java.lang.String	getTransitionName()
java.lang.Object	getUserObject()
java.util.Set<java.lang.String>	getVariableNames()
java.util.Map<java.lang.String,java.lang.Object>	getVariableValues()
CommandVehicle.Operation	operatorFromString(java.lang.String value) Valid operator for this command vehicle, from String value
void	setCurrentNodeName(java.lang.String obj)
void	setErrorMessage(java.lang.String obj)
void	setException(java.lang.Exception obj)
void	setInstanceId(long obj)
void	setProcessDefinition(org.jbpm.graph.def.ProcessDefinition obj)
void	setProcessDefinition(java.lang.String xmlString)
void	setProcessDefinitionName(java.lang.String obj)
void	setProcessVersion(int obj)
void	setReturnCode(java.lang.Object obj)
void	setTokenId(long obj)
void	setTransitionName(java.lang.String obj)
void	setUserObject(java.lang.Object obj)
void	setVariableNames(java.util.Set<java.lang.String> obj)
void	setVariableValues(java.util.Map<java.lang.String,java.lang.Object> obj)

Methods inherited from class org.jboss.soa.esb.util.AbstractCommandVehicle

getOperator, setOperator, setValue, toCommandMessage

Methods inherited from class java.lang.Object

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

Field Detail

PROCESS_DEFINITION

public static final java.lang.String PROCESS_DEFINITION

See Also:

Constant Field Values

PROCESS_DEFINITION_NAME

public static final java.lang.String PROCESS_DEFINITION_NAME

See Also:

Constant Field Values

PROCESS_DEFINITION_VERSION

public static final java.lang.String PROCESS_DEFINITION_VERSION

See Also:

Constant Field Values

PROCESS_INSTANCE_ID

public static final java.lang.String PROCESS_INSTANCE_ID

See Also:

Constant Field Values

TOKEN_ID

public static final java.lang.String TOKEN_ID

See Also:

Constant Field Values

TRANSITION_NAME

public static final java.lang.String TRANSITION_NAME

See Also:

Constant Field Values

CURRENT_NODE_NAME

public static final java.lang.String CURRENT_NODE_NAME

See Also:

Constant Field Values

VARIABLE_NAMES_LIST

public static final java.lang.String VARIABLE_NAMES_LIST

See Also:

Constant Field Values

VARIABLE_VALUES

public static final java.lang.String VARIABLE_VALUES

See Also:

Constant Field Values

USER_OBJECT

public static final java.lang.String USER_OBJECT

See Also:

Constant Field Values

EXCEPTION

public static final java.lang.String EXCEPTION

See Also:

Constant Field Values

ERROR_MESSAGE

public static final java.lang.String ERROR_MESSAGE

See Also:

Constant Field Values

RETURN_CODE

public static final java.lang.String RETURN_CODE

See Also:

Constant Field Values

RETCODE_OK

public static final java.lang.String RETCODE_OK

See Also:

Constant Field Values

RETCODE_INVALID_OPCODE

public static final java.lang.String RETCODE_INVALID_OPCODE

See Also:

Constant Field Values

RETCODE_EXCEPTION

public static final java.lang.String RETCODE_EXCEPTION

See Also:

Constant Field Values

RETCODE_ERROR

public static final java.lang.String RETCODE_ERROR

See Also:

Constant Field Values

Constructor Detail

CommandVehicle

public CommandVehicle(java.lang.Enum command)

CommandVehicle

public CommandVehicle(Message message)

Method Detail

getCommandValuesTag

public java.lang.String getCommandValuesTag()

Description copied from class: AbstractCommandVehicle

Provide a name for the named object to look for in the ESB Message body.

Specified by:

getCommandValuesTag in class AbstractCommandVehicle

Returns:

String : intended to be used as the key in Message.getBody().get(arg)

getCommandOpcodeKey

public java.lang.String getCommandOpcodeKey()

Description copied from class: AbstractCommandVehicle

The key for the command operation code in the command values map

Specified by:

getCommandOpcodeKey in class AbstractCommandVehicle

Returns:

String : intended to be used as the key in _values.get(arg)

operatorFromString

public CommandVehicle.Operation operatorFromString(java.lang.String value)

Description copied from class: AbstractCommandVehicle

Valid operator for this command vehicle, from String value

Specified by:

operatorFromString in class AbstractCommandVehicle

Parameters:

value - - the String value of the operator

Returns:

the Enum value that represents arg0

getReturnCode

public java.lang.Object getReturnCode()

getProcessDefinition

public org.jbpm.graph.def.ProcessDefinition getProcessDefinition()

getProcessDefinitionName

public java.lang.String getProcessDefinitionName()

getProcessVersion

public int getProcessVersion()

getInstanceId

public long getInstanceId()

getTokenId

public long getTokenId()

getTransitionName

public java.lang.String getTransitionName()

getCurrentNodeName

public java.lang.String getCurrentNodeName()

getVariableNames

public java.util.Set<java.lang.String> getVariableNames()

getVariableValues

public java.util.Map<java.lang.String,java.lang.Object> getVariableValues()

getUserObject

public java.lang.Object getUserObject()

getException

public java.lang.Exception getException()

getErrorMessage

public java.lang.String getErrorMessage()

setReturnCode

public void setReturnCode(java.lang.Object obj)

setProcessDefinition

public void setProcessDefinition(org.jbpm.graph.def.ProcessDefinition obj)

setProcessDefinition

public void setProcessDefinition(java.lang.String xmlString)
                          throws org.jbpm.jpdl.JpdlException

Throws:

org.jbpm.jpdl.JpdlException

setProcessDefinitionName

public void setProcessDefinitionName(java.lang.String obj)

setProcessVersion

public void setProcessVersion(int obj)

setInstanceId

public void setInstanceId(long obj)

setTokenId

public void setTokenId(long obj)

setTransitionName

public void setTransitionName(java.lang.String obj)

setCurrentNodeName

public void setCurrentNodeName(java.lang.String obj)

setVariableNames

public void setVariableNames(java.util.Set<java.lang.String> obj)

setVariableValues

public void setVariableValues(java.util.Map<java.lang.String,java.lang.Object> obj)

setUserObject

public void setUserObject(java.lang.Object obj)

setException

public void setException(java.lang.Exception obj)

setErrorMessage

public void setErrorMessage(java.lang.String obj)