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

Class AbstractResourceProvider<T extends Query<?,U>,U,DTO>

java.lang.Object

org.camunda.bpm.engine.rest.sub.AbstractResourceProvider<T,U,DTO>

Direct Known Subclasses:

HistoricDetailResourceImpl, HistoricVariableInstanceResourceImpl, VariableInstanceResourceImpl

public abstract class AbstractResourceProvider<T extends Query<?,U>,U,DTO>
extends Object

Base class to unify the getResource(boolean deserialized) and getResourceBinary() methods for several subclasses. (formerly getVariable() and getBinaryVariable())

Author:

Ronny Bräunlich

Field Summary

Fields

Modifier and Type	Field	Description
protected ProcessEngine	engine
protected String	id

Constructor Summary

Constructors

Constructor	Description
AbstractResourceProvider(String detailId, ProcessEngine engine)

Method Summary

Modifier and Type	Method	Description
protected abstract Query<T,U>	baseQueryForBinaryVariable()	Create the query we need for fetching the desired result.
protected abstract Query<T,U>	baseQueryForVariable(boolean deserializeObjectValue)	TODO change comment Create the query we need for fetching the desired result.
protected ProcessEngine	getEngine()
protected String	getId()
DTO	getResource(boolean deserializeObjectValue)
jakarta.ws.rs.core.Response	getResourceBinary()
protected abstract String	getResourceNameForErrorMessage()
protected abstract TypedValue	transformQueryResultIntoTypedValue(U queryResult)
protected abstract DTO	transformToDto(U queryResult)

Methods inherited from class java.lang.Object

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

Field Details

id

protected String id

engine

protected ProcessEngine engine

Constructor Details

AbstractResourceProvider

public AbstractResourceProvider(String detailId,
 ProcessEngine engine)

Method Details

getResource

@GET
@Produces("application/json")
public DTO getResource(@QueryParam("deserializeValue") @DefaultValue("true")
 boolean deserializeObjectValue)

getResourceBinary

@GET
@Path("/data")
public jakarta.ws.rs.core.Response getResourceBinary()

getId

protected String getId()

getEngine

protected ProcessEngine getEngine()

baseQueryForBinaryVariable

protected abstract Query<T,U> baseQueryForBinaryVariable()

Create the query we need for fetching the desired result. Setting properties in the query like disableCustomObjectDeserialization() or disableBinaryFetching() should be done in this method.

baseQueryForVariable

protected abstract Query<T,U> baseQueryForVariable(boolean deserializeObjectValue)

TODO change comment Create the query we need for fetching the desired result. Setting properties in the query like disableCustomObjectDeserialization() or disableBinaryFetching() should be done in this method.

Parameters:

deserializeObjectValue -

transformQueryResultIntoTypedValue

protected abstract TypedValue transformQueryResultIntoTypedValue(U queryResult)

transformToDto

protected abstract DTO transformToDto(U queryResult)

getResourceNameForErrorMessage

protected abstract String getResourceNameForErrorMessage()