Package org.camunda.bpm.engine.rest.sub.impl

Class AbstractVariablesResource

java.lang.Object

org.camunda.bpm.engine.rest.sub.impl.AbstractVariablesResource

All Implemented Interfaces:

VariableResource

Direct Known Subclasses:

CaseExecutionVariablesResource, ExecutionVariablesResource, LocalCaseExecutionVariablesResource, LocalExecutionVariablesResource, LocalTaskVariablesResource, TaskVariablesResource

public abstract class AbstractVariablesResource
extends Object
implements VariableResource

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	DEFAULT_BINARY_VALUE_TYPE
protected ProcessEngine	engine
protected com.fasterxml.jackson.databind.ObjectMapper	objectMapper
protected String	resourceId

Fields inherited from interface org.camunda.bpm.engine.rest.sub.VariableResource

DESERIALIZE_VALUE_QUERY_PARAM, DESERIALIZE_VALUES_QUERY_PARAM

Constructor Summary

Constructors

Constructor	Description
AbstractVariablesResource(ProcessEngine engine, String resourceId, com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Method Summary

Modifier and Type	Method	Description
void	deleteVariable(String variableName)
protected Object	deserializeJsonObject(String className, byte[] data)
protected ProcessEngineConfiguration	getProcessEngineConfiguration()
protected abstract String	getResourceTypeName()
protected TypedValue	getTypedValueForVariable(String variableName, boolean deserializeValue)
VariableValueDto	getVariable(String variableName, boolean deserializeValue)
jakarta.ws.rs.core.Response	getVariableBinary(String variableName)
protected abstract VariableMap	getVariableEntities(boolean deserializeValues)
protected abstract TypedValue	getVariableEntity(String variableKey, boolean deserializeValue)
Map<String,VariableValueDto>	getVariables(boolean deserializeValues)
void	modifyVariables(PatchVariablesDto patch)
void	putVariable(String variableName, VariableValueDto variable)
protected abstract void	removeVariableEntity(String variableKey)
void	setBinaryVariable(String variableKey, MultipartFormData payload)
protected abstract void	setVariableEntity(String variableKey, TypedValue variableValue)
protected abstract void	updateVariableEntities(VariableMap variables, List<String> deletions)
protected void	validateType(com.fasterxml.jackson.databind.JavaType type)	Validate the type with the help of the validator in the engine. Note: when adjusting this method, please also consider adjusting the JacksonJsonDataFormatMapper#validateType in the Engine Spin Plugin
protected void	validateType(com.fasterxml.jackson.databind.JavaType type, DeserializationTypeValidator validator, List<String> invalidTypes)
protected void	validateTypeInternal(com.fasterxml.jackson.databind.JavaType type, DeserializationTypeValidator validator, List<String> invalidTypes)

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_BINARY_VALUE_TYPE

protected static final String DEFAULT_BINARY_VALUE_TYPE

See Also:

• Constant Field Values

engine

protected ProcessEngine engine

resourceId

protected String resourceId

objectMapper

protected com.fasterxml.jackson.databind.ObjectMapper objectMapper

Constructor Details

AbstractVariablesResource

public AbstractVariablesResource(ProcessEngine engine,
 String resourceId,
 com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Method Details

getVariables

public Map<String,VariableValueDto> getVariables(boolean deserializeValues)

Specified by:

getVariables in interface VariableResource

getVariable

public VariableValueDto getVariable(String variableName,
 boolean deserializeValue)

Specified by:

getVariable in interface VariableResource

getTypedValueForVariable

protected TypedValue getTypedValueForVariable(String variableName,
 boolean deserializeValue)

getVariableBinary

public jakarta.ws.rs.core.Response getVariableBinary(String variableName)

Specified by:

getVariableBinary in interface VariableResource

putVariable

public void putVariable(String variableName,
 VariableValueDto variable)

Specified by:

putVariable in interface VariableResource

setBinaryVariable

public void setBinaryVariable(String variableKey,
 MultipartFormData payload)

Specified by:

setBinaryVariable in interface VariableResource

deserializeJsonObject

protected Object deserializeJsonObject(String className,
 byte[] data)

validateType

protected void validateType(com.fasterxml.jackson.databind.JavaType type)

Validate the type with the help of the validator in the engine.
Note: when adjusting this method, please also consider adjusting the JacksonJsonDataFormatMapper#validateType in the Engine Spin Plugin

validateType

protected void validateType(com.fasterxml.jackson.databind.JavaType type,
 DeserializationTypeValidator validator,
 List<String> invalidTypes)

validateTypeInternal

protected void validateTypeInternal(com.fasterxml.jackson.databind.JavaType type,
 DeserializationTypeValidator validator,
 List<String> invalidTypes)

getProcessEngineConfiguration

protected ProcessEngineConfiguration getProcessEngineConfiguration()

deleteVariable

public void deleteVariable(String variableName)

Specified by:

deleteVariable in interface VariableResource

modifyVariables

public void modifyVariables(PatchVariablesDto patch)

Specified by:

modifyVariables in interface VariableResource

getVariableEntities

protected abstract VariableMap getVariableEntities(boolean deserializeValues)

updateVariableEntities

protected abstract void updateVariableEntities(VariableMap variables,
 List<String> deletions)

getVariableEntity

protected abstract TypedValue getVariableEntity(String variableKey,
 boolean deserializeValue)

setVariableEntity

protected abstract void setVariableEntity(String variableKey,
 TypedValue variableValue)

removeVariableEntity

protected abstract void removeVariableEntity(String variableKey)

getResourceTypeName

protected abstract String getResourceTypeName()