org.flowable.camel

Class CamelBehavior

java.lang.Object

org.flowable.engine.impl.bpmn.behavior.FlowNodeActivityBehavior

org.flowable.engine.impl.bpmn.behavior.AbstractBpmnActivityBehavior

org.flowable.camel.CamelBehavior

All Implemented Interfaces:

Serializable, ActivityBehavior, TriggerableActivityBehavior

Direct Known Subclasses:

CdiCamelBehavior, SpringCamelBehavior

public abstract class CamelBehavior
extends AbstractBpmnActivityBehavior
implements ActivityBehavior

This abstract class takes the place of the now-deprecated CamelBehaviour class (which can still be used for legacy compatibility) and significantly improves on its flexibility. Additional implementations can be created that change the way in which Flowable interacts with Camel per your specific needs.

Three out-of-the-box implementations of CamelBehavior are provided: (1) CamelBehaviorDefaultImpl: Works just like CamelBehaviour does; copies variables into and out of Camel as or from properties. (2) CamelBehaviorBodyAsMapImpl: Works by copying variables into and out of Camel using a Map object in the body. (3) CamelBehaviorCamelBodyImpl: Works by copying a single variable value into Camel as a String body and copying the Camel body into that same variable. The process variable in must be named "camelBody".

This class has two subclasses one for Spring and one for CDI, and each having the 3 behavioral implementations discussed above. Alternative implementations for Spring or CDI contexts should now extend one one or the other.

The chosen implementation can be set using extension elements:

 
 <serviceTask id="serviceTask1" flowable:type="camel">
   <extensionElements>
     <flowable:field name="camelBehaviorClass" stringValue="org.flowable.camel.impl.CamelBehaviorCamelBodyImpl" />
   </extensionElements>
 </serviceTask>
 
 

Note also that the manner in which variables are copied to the process engine from Camel has changed. It will always copy Camel properties to the process variables set; they can safely be ignored, of course, if not required. It will conditionally copy the Camel body to the "camelBody" variable if it is of type java.lang.String, OR it will copy the Camel body to individual variables within the process engine if it is of type Map.

Version:

5.12

Author:

Ryan Johnston (@rjfsu), Tijs Rademakers, Saeid Mirzaei, Zach Visagie

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CamelBehavior.TargetType

Field Summary

Fields

Modifier and Type	Field and Description
protected Expression	camelContext
protected org.apache.camel.CamelContext	camelContextObj
protected List<MapExceptionEntry>	mapExceptions
protected CamelBehavior.TargetType	toTargetType

Fields inherited from class org.flowable.engine.impl.bpmn.behavior.AbstractBpmnActivityBehavior

multiInstanceActivityBehavior

Fields inherited from class org.flowable.engine.impl.bpmn.behavior.FlowNodeActivityBehavior

bpmnActivityBehavior

Constructor Summary

Constructors

Constructor and Description
CamelBehavior()

Method Summary

Modifier and Type	Method and Description
protected void	copyVariables(Map<String,Object> variables, org.apache.camel.Exchange exchange, FlowableEndpoint endpoint)
protected void	copyVariablesToBody(Map<String,Object> variables, org.apache.camel.Exchange exchange)
protected void	copyVariablesToBodyAsMap(Map<String,Object> variables, org.apache.camel.Exchange exchange)
protected void	copyVariablesToProperties(Map<String,Object> variables, org.apache.camel.Exchange exchange)
protected FlowableEndpoint	createEndpoint(DelegateExecution execution, boolean isV5Execution)
protected org.apache.camel.Exchange	createExchange(DelegateExecution activityExecution, FlowableEndpoint endpoint)
void	execute(DelegateExecution execution) Default behaviour: just leave the activity with no extra functionality.
protected FlowableEndpoint	getEndpoint(String key)
protected String	getProcessDefinitionKey(DelegateExecution execution, boolean isV5Execution)
protected String	getStringFromField(Expression expression, DelegateExecution execution)
protected boolean	handleCamelException(org.apache.camel.Exchange exchange, DelegateExecution execution, boolean isV5Execution)
protected boolean	isASync(DelegateExecution execution)
protected abstract void	setAppropriateCamelContext(DelegateExecution execution)
void	setCamelContext(Expression camelContext)
protected abstract void	setPropertTargetVariable(FlowableEndpoint endpoint)
protected void	updateTargetVariables(FlowableEndpoint endpoint)

Methods inherited from class org.flowable.engine.impl.bpmn.behavior.AbstractBpmnActivityBehavior

executeCompensateBoundaryEvents, findBoundaryEventsForFlowNode, getMultiInstanceActivityBehavior, getProcessDefinition, hasLoopCharacteristics, hasMultiInstanceCharacteristics, leave, setMultiInstanceActivityBehavior

Methods inherited from class org.flowable.engine.impl.bpmn.behavior.FlowNodeActivityBehavior

leaveIgnoreConditions, parseActivityType, trigger

Methods inherited from class java.lang.Object

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

Field Detail

camelContext

protected Expression camelContext

camelContextObj

protected org.apache.camel.CamelContext camelContextObj

mapExceptions

protected List<MapExceptionEntry> mapExceptions

toTargetType

protected CamelBehavior.TargetType toTargetType

Constructor Detail

CamelBehavior

public CamelBehavior()

Method Detail

setPropertTargetVariable

protected abstract void setPropertTargetVariable(FlowableEndpoint endpoint)

updateTargetVariables

protected void updateTargetVariables(FlowableEndpoint endpoint)

copyVariables

protected void copyVariables(Map<String,Object> variables,
                             org.apache.camel.Exchange exchange,
                             FlowableEndpoint endpoint)

execute

public void execute(DelegateExecution execution)

Description copied from class: FlowNodeActivityBehavior

Default behaviour: just leave the activity with no extra functionality.

Specified by:

execute in interface ActivityBehavior

Overrides:

execute in class FlowNodeActivityBehavior

createEndpoint

protected FlowableEndpoint createEndpoint(DelegateExecution execution,
                                          boolean isV5Execution)

getEndpoint

protected FlowableEndpoint getEndpoint(String key)

createExchange

protected org.apache.camel.Exchange createExchange(DelegateExecution activityExecution,
                                                   FlowableEndpoint endpoint)

handleCamelException

protected boolean handleCamelException(org.apache.camel.Exchange exchange,
                                       DelegateExecution execution,
                                       boolean isV5Execution)

copyVariablesToProperties

protected void copyVariablesToProperties(Map<String,Object> variables,
                                         org.apache.camel.Exchange exchange)

copyVariablesToBodyAsMap

protected void copyVariablesToBodyAsMap(Map<String,Object> variables,
                                        org.apache.camel.Exchange exchange)

copyVariablesToBody

protected void copyVariablesToBody(Map<String,Object> variables,
                                   org.apache.camel.Exchange exchange)

getProcessDefinitionKey

protected String getProcessDefinitionKey(DelegateExecution execution,
                                         boolean isV5Execution)

isASync

protected boolean isASync(DelegateExecution execution)

setAppropriateCamelContext

protected abstract void setAppropriateCamelContext(DelegateExecution execution)

getStringFromField

protected String getStringFromField(Expression expression,
                                    DelegateExecution execution)

setCamelContext

public void setCamelContext(Expression camelContext)