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 Details

    • DEFAULT_BINARY_VALUE_TYPE

      protected static final String DEFAULT_BINARY_VALUE_TYPE
      See Also:

    • engine

      protected org.camunda.bpm.engine.ProcessEngine engine

    • resourceId

      protected String resourceId

    • objectMapper

      protected com.fasterxml.jackson.databind.ObjectMapper objectMapper

  • Constructor Details

    • AbstractVariablesResource

      public AbstractVariablesResource(org.camunda.bpm.engine.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 org.camunda.bpm.engine.variable.value.TypedValue getTypedValueForVariable(String variableName, boolean deserializeValue)

    • getVariableBinary

      public javax.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, org.camunda.bpm.engine.runtime.DeserializationTypeValidator validator, List<String> invalidTypes)

    • validateTypeInternal

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

    • getProcessEngineConfiguration

      protected org.camunda.bpm.engine.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 org.camunda.bpm.engine.variable.VariableMap getVariableEntities(boolean deserializeValues)

    • updateVariableEntities

      protected abstract void updateVariableEntities(org.camunda.bpm.engine.variable.VariableMap variables, List<String> deletions)

    • getVariableEntity

      protected abstract org.camunda.bpm.engine.variable.value.TypedValue getVariableEntity(String variableKey, boolean deserializeValue)

    • setVariableEntity

      protected abstract void setVariableEntity(String variableKey, org.camunda.bpm.engine.variable.value.TypedValue variableValue)

    • removeVariableEntity

      protected abstract void removeVariableEntity(String variableKey)

    • getResourceTypeName

      protected abstract String getResourceTypeName()