org.camunda.bpm.engine.impl.core.variable.scope

Class AbstractVariableScope

java.lang.Object

org.camunda.bpm.engine.impl.core.variable.scope.AbstractVariableScope

All Implemented Interfaces:

Serializable, VariableScope, VariableEventDispatcher

Direct Known Subclasses:

ConnectorVariableScope, CoreExecution, TaskEntity

public abstract class AbstractVariableScope
extends Object
implements Serializable, VariableScope, VariableEventDispatcher

Author:

Daniel Meyer, Roman Smirnov, Sebastian Menski

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected ELContext	cachedElContext

Constructor Summary

Constructors

Constructor and Description
AbstractVariableScope()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkJavaSerialization(String variableName, org.camunda.bpm.engine.variable.value.TypedValue value) Checks, if Java serialization will be used and if it is allowed to be used.
protected Set<String>	collectVariableNames(Set<String> variableNames)
void	collectVariables(org.camunda.bpm.engine.variable.impl.VariableMapImpl resultVariables, Collection<String> variableNames, boolean isLocal, boolean deserializeValues)
void	dispatchEvent(VariableEvent variableEvent)
ELContext	getCachedElContext()
abstract AbstractVariableScope	getParentVariableScope()
protected AbstractVariableScope	getSourceActivityVariableScope()
protected Object	getValueFromVariableInstance(boolean deserializeObjectValue, CoreVariableInstance variableInstance)
Object	getVariable(String variableName)
Object	getVariable(String variableName, boolean deserializeObjectValue)
CoreVariableInstance	getVariableInstance(String variableName)
protected abstract VariableInstanceFactory<CoreVariableInstance>	getVariableInstanceFactory()
protected abstract List<VariableInstanceLifecycleListener<CoreVariableInstance>>	getVariableInstanceLifecycleListeners()
CoreVariableInstance	getVariableInstanceLocal(String name)
List<CoreVariableInstance>	getVariableInstancesLocal()
List<CoreVariableInstance>	getVariableInstancesLocal(Collection<String> variableNames)
Object	getVariableLocal(String variableName)
Object	getVariableLocal(String variableName, boolean deserializeObjectValue)
<T extends org.camunda.bpm.engine.variable.value.TypedValue> T	getVariableLocalTyped(String variableName)
<T extends org.camunda.bpm.engine.variable.value.TypedValue> T	getVariableLocalTyped(String variableName, boolean deserializeValue)
Set<String>	getVariableNames()
Set<String>	getVariableNamesLocal()
org.camunda.bpm.engine.variable.impl.VariableMapImpl	getVariables()
String	getVariableScopeKey()
org.camunda.bpm.engine.variable.impl.VariableMapImpl	getVariablesLocal()
org.camunda.bpm.engine.variable.impl.VariableMapImpl	getVariablesLocalTyped()
org.camunda.bpm.engine.variable.impl.VariableMapImpl	getVariablesLocalTyped(boolean deserializeObjectValues)
protected abstract VariableStore<CoreVariableInstance>	getVariableStore()
org.camunda.bpm.engine.variable.impl.VariableMapImpl	getVariablesTyped()
org.camunda.bpm.engine.variable.impl.VariableMapImpl	getVariablesTyped(boolean deserializeValues)
<T extends org.camunda.bpm.engine.variable.value.TypedValue> T	getVariableTyped(String variableName)
<T extends org.camunda.bpm.engine.variable.value.TypedValue> T	getVariableTyped(String variableName, boolean deserializeValue)
boolean	hasVariable(String variableName)
boolean	hasVariableLocal(String variableName)
boolean	hasVariables()
boolean	hasVariablesLocal()
void	initializeVariableStore(Map<String,Object> variables)
protected void	invokeVariableLifecycleListenersCreate(CoreVariableInstance variableInstance, AbstractVariableScope sourceScope)
protected void	invokeVariableLifecycleListenersCreate(CoreVariableInstance variableInstance, AbstractVariableScope sourceScope, List<VariableInstanceLifecycleListener<CoreVariableInstance>> lifecycleListeners)
protected void	invokeVariableLifecycleListenersDelete(CoreVariableInstance variableInstance, AbstractVariableScope sourceScope)
protected void	invokeVariableLifecycleListenersDelete(CoreVariableInstance variableInstance, AbstractVariableScope sourceScope, List<VariableInstanceLifecycleListener<CoreVariableInstance>> lifecycleListeners)
protected void	invokeVariableLifecycleListenersUpdate(CoreVariableInstance variableInstance, AbstractVariableScope sourceScope)
protected void	invokeVariableLifecycleListenersUpdate(CoreVariableInstance variableInstance, AbstractVariableScope sourceScope, List<VariableInstanceLifecycleListener<CoreVariableInstance>> lifecycleListeners)
void	removeVariable(String variableName) Removes the variable and creates a new HistoricVariableUpdateEntity.
protected void	removeVariable(String variableName, AbstractVariableScope sourceActivityExecution)
void	removeVariableLocal(String variableName) Removes the local variable and creates a new HistoricVariableUpdateEntity.
protected void	removeVariableLocal(String variableName, AbstractVariableScope sourceActivityExecution)
void	removeVariables() Removes the (local) variables and creates a new HistoricVariableUpdateEntity for each of them.
void	removeVariables(Collection<String> variableNames) Removes the variables and creates a new HistoricVariableUpdateEntity for each of them.
void	removeVariablesLocal() Removes the (local) variables and creates a new HistoricVariableUpdateEntity for each of them.
void	removeVariablesLocal(Collection<String> variableNames) Removes the local variables and creates a new HistoricVariableUpdateEntity for each of them.
void	setCachedElContext(ELContext cachedElContext)
void	setVariable(String variableName, Object value)
protected void	setVariable(String variableName, org.camunda.bpm.engine.variable.value.TypedValue value, AbstractVariableScope sourceActivityVariableScope)
void	setVariableLocal(String variableName, Object value)
void	setVariableLocal(String variableName, org.camunda.bpm.engine.variable.value.TypedValue value, AbstractVariableScope sourceActivityExecution)
void	setVariableLocalTransient(String variableName, Object value) Sets a variable in the local scope.
void	setVariableLocalTransient(String variableName, Object value, AbstractVariableScope sourceActivityVariableScope)
void	setVariables(Map<String,? extends Object> variables)
void	setVariablesLocal(Map<String,? extends Object> variables)

Methods inherited from class java.lang.Object

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

Field Detail

cachedElContext

protected ELContext cachedElContext

Constructor Detail

AbstractVariableScope

public AbstractVariableScope()

Method Detail

getVariableStore

protected abstract VariableStore<CoreVariableInstance> getVariableStore()

getVariableInstanceFactory

protected abstract VariableInstanceFactory<CoreVariableInstance> getVariableInstanceFactory()

getVariableInstanceLifecycleListeners

protected abstract List<VariableInstanceLifecycleListener<CoreVariableInstance>> getVariableInstanceLifecycleListeners()

getParentVariableScope

public abstract AbstractVariableScope getParentVariableScope()

initializeVariableStore

public void initializeVariableStore(Map<String,Object> variables)

getVariableScopeKey

public String getVariableScopeKey()

Specified by:

getVariableScopeKey in interface VariableScope

getVariables

public org.camunda.bpm.engine.variable.impl.VariableMapImpl getVariables()

Specified by:

getVariables in interface VariableScope

getVariablesTyped

public org.camunda.bpm.engine.variable.impl.VariableMapImpl getVariablesTyped()

Specified by:

getVariablesTyped in interface VariableScope

getVariablesTyped

public org.camunda.bpm.engine.variable.impl.VariableMapImpl getVariablesTyped(boolean deserializeValues)

Specified by:

getVariablesTyped in interface VariableScope

getVariablesLocal

public org.camunda.bpm.engine.variable.impl.VariableMapImpl getVariablesLocal()

Specified by:

getVariablesLocal in interface VariableScope

getVariablesLocalTyped

public org.camunda.bpm.engine.variable.impl.VariableMapImpl getVariablesLocalTyped()

Specified by:

getVariablesLocalTyped in interface VariableScope

getVariablesLocalTyped

public org.camunda.bpm.engine.variable.impl.VariableMapImpl getVariablesLocalTyped(boolean deserializeObjectValues)

Specified by:

getVariablesLocalTyped in interface VariableScope

collectVariables

public void collectVariables(org.camunda.bpm.engine.variable.impl.VariableMapImpl resultVariables,
                    Collection<String> variableNames,
                    boolean isLocal,
                    boolean deserializeValues)

getVariable

public Object getVariable(String variableName)

Specified by:

getVariable in interface VariableScope

getVariable

public Object getVariable(String variableName,
                 boolean deserializeObjectValue)

getVariableLocal

public Object getVariableLocal(String variableName)

Specified by:

getVariableLocal in interface VariableScope

getVariableLocal

public Object getVariableLocal(String variableName,
                      boolean deserializeObjectValue)

getValueFromVariableInstance

protected Object getValueFromVariableInstance(boolean deserializeObjectValue,
                                  CoreVariableInstance variableInstance)

getVariableTyped

public <T extends org.camunda.bpm.engine.variable.value.TypedValue> T getVariableTyped(String variableName)

Specified by:

getVariableTyped in interface VariableScope

getVariableTyped

public <T extends org.camunda.bpm.engine.variable.value.TypedValue> T getVariableTyped(String variableName,
                                                                              boolean deserializeValue)

Specified by:

getVariableTyped in interface VariableScope

getVariableLocalTyped

public <T extends org.camunda.bpm.engine.variable.value.TypedValue> T getVariableLocalTyped(String variableName)

Specified by:

getVariableLocalTyped in interface VariableScope

getVariableLocalTyped

public <T extends org.camunda.bpm.engine.variable.value.TypedValue> T getVariableLocalTyped(String variableName,
                                                                                   boolean deserializeValue)

Specified by:

getVariableLocalTyped in interface VariableScope

getVariableInstance

public CoreVariableInstance getVariableInstance(String variableName)

getVariableInstanceLocal

public CoreVariableInstance getVariableInstanceLocal(String name)

getVariableInstancesLocal

public List<CoreVariableInstance> getVariableInstancesLocal()

getVariableInstancesLocal

public List<CoreVariableInstance> getVariableInstancesLocal(Collection<String> variableNames)

hasVariables

public boolean hasVariables()

Specified by:

hasVariables in interface VariableScope

hasVariablesLocal

public boolean hasVariablesLocal()

Specified by:

hasVariablesLocal in interface VariableScope

hasVariable

public boolean hasVariable(String variableName)

Specified by:

hasVariable in interface VariableScope

hasVariableLocal

public boolean hasVariableLocal(String variableName)

Specified by:

hasVariableLocal in interface VariableScope

collectVariableNames

protected Set<String> collectVariableNames(Set<String> variableNames)

getVariableNames

public Set<String> getVariableNames()

Specified by:

getVariableNames in interface VariableScope

getVariableNamesLocal

public Set<String> getVariableNamesLocal()

Specified by:

getVariableNamesLocal in interface VariableScope

setVariables

public void setVariables(Map<String,? extends Object> variables)

Specified by:

setVariables in interface VariableScope

setVariablesLocal

public void setVariablesLocal(Map<String,? extends Object> variables)

Specified by:

setVariablesLocal in interface VariableScope

removeVariables

public void removeVariables()

Description copied from interface: VariableScope

Removes the (local) variables and creates a new HistoricVariableUpdateEntity for each of them.

Specified by:

removeVariables in interface VariableScope

removeVariablesLocal

public void removeVariablesLocal()

Description copied from interface: VariableScope

Removes the (local) variables and creates a new HistoricVariableUpdateEntity for each of them.

Specified by:

removeVariablesLocal in interface VariableScope

removeVariables

public void removeVariables(Collection<String> variableNames)

Description copied from interface: VariableScope

Removes the variables and creates a new HistoricVariableUpdateEntity for each of them.

Specified by:

removeVariables in interface VariableScope

removeVariablesLocal

public void removeVariablesLocal(Collection<String> variableNames)

Description copied from interface: VariableScope

Removes the local variables and creates a new HistoricVariableUpdateEntity for each of them.

Specified by:

removeVariablesLocal in interface VariableScope

setVariable

public void setVariable(String variableName,
               Object value)

Specified by:

setVariable in interface VariableScope

setVariable

protected void setVariable(String variableName,
               org.camunda.bpm.engine.variable.value.TypedValue value,
               AbstractVariableScope sourceActivityVariableScope)

setVariableLocal

public void setVariableLocal(String variableName,
                    org.camunda.bpm.engine.variable.value.TypedValue value,
                    AbstractVariableScope sourceActivityExecution)

checkJavaSerialization

protected void checkJavaSerialization(String variableName,
                          org.camunda.bpm.engine.variable.value.TypedValue value)

Checks, if Java serialization will be used and if it is allowed to be used.

Parameters:

variableName -

value -

invokeVariableLifecycleListenersCreate

protected void invokeVariableLifecycleListenersCreate(CoreVariableInstance variableInstance,
                                          AbstractVariableScope sourceScope)

invokeVariableLifecycleListenersCreate

protected void invokeVariableLifecycleListenersCreate(CoreVariableInstance variableInstance,
                                          AbstractVariableScope sourceScope,
                                          List<VariableInstanceLifecycleListener<CoreVariableInstance>> lifecycleListeners)

invokeVariableLifecycleListenersDelete

protected void invokeVariableLifecycleListenersDelete(CoreVariableInstance variableInstance,
                                          AbstractVariableScope sourceScope)

invokeVariableLifecycleListenersDelete

protected void invokeVariableLifecycleListenersDelete(CoreVariableInstance variableInstance,
                                          AbstractVariableScope sourceScope,
                                          List<VariableInstanceLifecycleListener<CoreVariableInstance>> lifecycleListeners)

invokeVariableLifecycleListenersUpdate

protected void invokeVariableLifecycleListenersUpdate(CoreVariableInstance variableInstance,
                                          AbstractVariableScope sourceScope)

invokeVariableLifecycleListenersUpdate

protected void invokeVariableLifecycleListenersUpdate(CoreVariableInstance variableInstance,
                                          AbstractVariableScope sourceScope,
                                          List<VariableInstanceLifecycleListener<CoreVariableInstance>> lifecycleListeners)

setVariableLocal

public void setVariableLocal(String variableName,
                    Object value)

Specified by:

setVariableLocal in interface VariableScope

setVariableLocalTransient

public void setVariableLocalTransient(String variableName,
                             Object value)

Sets a variable in the local scope. In contrast to setVariableLocal(String, Object), the variable is transient that means it will not be stored in the data base. For example, a transient variable can be used for a result variable that is only available for output mapping.

setVariableLocalTransient

public void setVariableLocalTransient(String variableName,
                             Object value,
                             AbstractVariableScope sourceActivityVariableScope)

removeVariable

public void removeVariable(String variableName)

Description copied from interface: VariableScope

Removes the variable and creates a new HistoricVariableUpdateEntity.

Specified by:

removeVariable in interface VariableScope

removeVariable

protected void removeVariable(String variableName,
                  AbstractVariableScope sourceActivityExecution)

removeVariableLocal

public void removeVariableLocal(String variableName)

Description copied from interface: VariableScope

Removes the local variable and creates a new HistoricVariableUpdateEntity.

Specified by:

removeVariableLocal in interface VariableScope

getSourceActivityVariableScope

protected AbstractVariableScope getSourceActivityVariableScope()

removeVariableLocal

protected void removeVariableLocal(String variableName,
                       AbstractVariableScope sourceActivityExecution)

getCachedElContext

public ELContext getCachedElContext()

setCachedElContext

public void setCachedElContext(ELContext cachedElContext)

dispatchEvent

public void dispatchEvent(VariableEvent variableEvent)

Specified by:

dispatchEvent in interface VariableEventDispatcher