org.camunda.bpm.engine.rest.sub.VariableResource Maven / Gradle / Ivy
/*
* Copyright Camunda Services GmbH and/or licensed to Camunda Services GmbH
* under one or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information regarding copyright
* ownership. Camunda licenses this file to you under the Apache License,
* Version 2.0; you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.camunda.bpm.engine.rest.sub;
import java.util.Map;
import javax.ws.rs.Consumes;
import javax.ws.rs.DELETE;
import javax.ws.rs.DefaultValue;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.PUT;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import org.camunda.bpm.engine.rest.dto.PatchVariablesDto;
import org.camunda.bpm.engine.rest.dto.VariableValueDto;
import org.camunda.bpm.engine.rest.mapper.MultipartFormData;
public interface VariableResource {
public final static String DESERIALIZE_VALUE_QUERY_PARAM = "deserializeValue";
public final static String DESERIALIZE_VALUES_QUERY_PARAM = DESERIALIZE_VALUE_QUERY_PARAM + "s";
@GET
@Produces(MediaType.APPLICATION_JSON)
Map getVariables(
@QueryParam(DESERIALIZE_VALUES_QUERY_PARAM) @DefaultValue("true") boolean deserializeValues);
@GET
@Path("/{varId}")
@Produces(MediaType.APPLICATION_JSON)
VariableValueDto getVariable(
@PathParam("varId") String variableName,
@QueryParam(DESERIALIZE_VALUE_QUERY_PARAM) @DefaultValue("true") boolean deserializeValue);
@GET
@Path("/{varId}/data")
public Response getVariableBinary(@PathParam("varId") String variableName);
@PUT
@Path("/{varId}")
@Consumes(MediaType.APPLICATION_JSON)
void putVariable(@PathParam("varId") String variableName, VariableValueDto variable);
@POST // using POST since PUT is not as widely supported for file uploads
@Path("/{varId}/data")
@Consumes(MediaType.MULTIPART_FORM_DATA)
void setBinaryVariable(@PathParam("varId") String variableName, MultipartFormData multipartFormData);
@DELETE
@Path("/{varId}")
void deleteVariable(@PathParam("varId") String variableName);
@POST
@Consumes(MediaType.APPLICATION_JSON)
void modifyVariables(PatchVariablesDto patch);
}