org.flowable.cmmn.rest.service.api

Class CmmnRestResponseFactory

java.lang.Object

org.flowable.cmmn.rest.service.api.CmmnRestResponseFactory

public class CmmnRestResponseFactory
extends Object

Default implementation of a CmmnRestResponseFactory.

Added a new "createProcessInstanceResponse" method (with a different signature) to conditionally return the process variables that exist within the process instance when the first wait state is encountered (or when the process instance completes). Also added the population of a "completed" flag - within both the original "createProcessInstanceResponse" method and the new one with the different signature - to let the caller know whether the process instance has completed or not.

Author:

Frederik Heremans, Ryan Johnston (@rjfsu)

Field Summary

Fields

Modifier and Type	Field and Description
static String	BYTE_ARRAY_VARIABLE_TYPE
protected com.fasterxml.jackson.databind.ObjectMapper	objectMapper
static String	SERIALIZABLE_VARIABLE_TYPE
static int	VARIABLE_CASE
static int	VARIABLE_EXECUTION
static int	VARIABLE_HISTORY_CASE
static int	VARIABLE_HISTORY_DETAIL
static int	VARIABLE_HISTORY_TASK
static int	VARIABLE_HISTORY_VARINSTANCE
static int	VARIABLE_TASK
protected List<RestVariableConverter>	variableConverters

Constructor Summary

Constructors

Constructor and Description
CmmnRestResponseFactory(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Method Summary

Modifier and Type	Method and Description
RestVariable	createBinaryRestVariable(String name, RestVariable.RestVariableScope scope, String type, String taskId, String caseInstanceId)
CaseDefinitionResponse	createCaseDefinitionResponse(org.flowable.cmmn.api.repository.CaseDefinition caseDefinition)
CaseDefinitionResponse	createCaseDefinitionResponse(org.flowable.cmmn.api.repository.CaseDefinition caseDefinition, RestUrlBuilder urlBuilder)
List<CaseDefinitionResponse>	createCaseDefinitionResponseList(List<org.flowable.cmmn.api.repository.CaseDefinition> caseDefinitions)
CaseInstanceResponse	createCaseInstanceResponse(org.flowable.cmmn.api.runtime.CaseInstance caseInstance)
CaseInstanceResponse	createCaseInstanceResponse(org.flowable.cmmn.api.runtime.CaseInstance caseInstance, boolean returnVariables, Map<String,Object> runtimeVariableMap)
CaseInstanceResponse	createCaseInstanceResponse(org.flowable.cmmn.api.runtime.CaseInstance caseInstance, RestUrlBuilder urlBuilder)
List<CaseInstanceResponse>	createCaseInstanceResponseList(List<org.flowable.cmmn.api.runtime.CaseInstance> caseInstances)
DecisionResponse	createDecisionResponse(org.flowable.dmn.api.DmnDecision decision, String processDefinitionId)
DecisionResponse	createDecisionResponse(org.flowable.dmn.api.DmnDecision decision, String caseDefinitionId, RestUrlBuilder urlBuilder)
List<DecisionResponse>	createDecisionResponseList(List<org.flowable.dmn.api.DmnDecision> decisions, String processDefinitionId)
DeploymentResourceResponse	createDeploymentResourceResponse(String deploymentId, String resourceId, String contentType)
DeploymentResourceResponse	createDeploymentResourceResponse(String deploymentId, String resourceId, String contentType, RestUrlBuilder urlBuilder)
List<DeploymentResourceResponse>	createDeploymentResourceResponseList(String deploymentId, List<String> resourceList, ContentTypeResolver contentTypeResolver)
CmmnDeploymentResponse	createDeploymentResponse(org.flowable.cmmn.api.repository.CmmnDeployment deployment)
CmmnDeploymentResponse	createDeploymentResponse(org.flowable.cmmn.api.repository.CmmnDeployment deployment, RestUrlBuilder urlBuilder)
List<CmmnDeploymentResponse>	createDeploymentResponseList(List<org.flowable.cmmn.api.repository.CmmnDeployment> deployments)
FormDefinitionResponse	createFormDefinitionResponse(org.flowable.form.api.FormDefinition formDefinition, String caseDefinitionId, RestUrlBuilder urlBuilder)
List<FormDefinitionResponse>	createFormDefinitionResponseList(List<org.flowable.form.api.FormDefinition> formDefinitions, String processDefinitionId)
FormDefinitionResponse	createFormDefintionResponse(org.flowable.form.api.FormDefinition formDefinition, String processDefinitionId)
HistoricCaseInstanceResponse	createHistoricCaseInstanceResponse(org.flowable.cmmn.api.history.HistoricCaseInstance caseInstance)
HistoricCaseInstanceResponse	createHistoricCaseInstanceResponse(org.flowable.cmmn.api.history.HistoricCaseInstance caseInstance, RestUrlBuilder urlBuilder)
List<HistoricCaseInstanceResponse>	createHistoricCaseInstanceResponseList(List<org.flowable.cmmn.api.history.HistoricCaseInstance> caseInstances)
HistoricIdentityLinkResponse	createHistoricIdentityLinkResponse(org.flowable.identitylink.api.history.HistoricIdentityLink identityLink)
HistoricIdentityLinkResponse	createHistoricIdentityLinkResponse(org.flowable.identitylink.api.history.HistoricIdentityLink identityLink, RestUrlBuilder urlBuilder)
List<HistoricIdentityLinkResponse>	createHistoricIdentityLinkResponseList(List<org.flowable.identitylink.api.history.HistoricIdentityLink> identityLinks)
HistoricMilestoneInstanceResponse	createHistoricMilestoneInstanceResponse(org.flowable.cmmn.api.history.HistoricMilestoneInstance historicMilestoneInstance)
HistoricMilestoneInstanceResponse	createHistoricMilestoneInstanceResponse(org.flowable.cmmn.api.history.HistoricMilestoneInstance historicMilestoneInstance, RestUrlBuilder urlBuilder)
List<HistoricMilestoneInstanceResponse>	createHistoricMilestoneInstanceResponseList(List<org.flowable.cmmn.api.history.HistoricMilestoneInstance> historicMilestoneInstances)
HistoricPlanItemInstanceResponse	createHistoricPlanItemInstanceResponse(org.flowable.cmmn.api.history.HistoricPlanItemInstance historicPlanItemInstance)
HistoricPlanItemInstanceResponse	createHistoricPlanItemInstanceResponse(org.flowable.cmmn.api.history.HistoricPlanItemInstance historicPlanItemInstance, RestUrlBuilder urlBuilder)
List<HistoricPlanItemInstanceResponse>	createHistoricPlanItemInstanceResponseList(List<org.flowable.cmmn.api.history.HistoricPlanItemInstance> historicPlanItemInstances)
HistoricTaskInstanceResponse	createHistoricTaskInstanceResponse(org.flowable.task.api.history.HistoricTaskInstance taskInstance)
HistoricTaskInstanceResponse	createHistoricTaskInstanceResponse(org.flowable.task.api.history.HistoricTaskInstance taskInstance, RestUrlBuilder urlBuilder)
List<HistoricTaskInstanceResponse>	createHistoricTaskInstanceResponseList(List<org.flowable.task.api.history.HistoricTaskInstance> taskInstances)
HistoricVariableInstanceResponse	createHistoricVariableInstanceResponse(org.flowable.variable.api.history.HistoricVariableInstance variableInstance)
HistoricVariableInstanceResponse	createHistoricVariableInstanceResponse(org.flowable.variable.api.history.HistoricVariableInstance variableInstance, RestUrlBuilder urlBuilder)
List<HistoricVariableInstanceResponse>	createHistoricVariableInstanceResponseList(List<org.flowable.variable.api.history.HistoricVariableInstance> variableInstances)
HistoryJobResponse	createHistoryJobResponse(org.flowable.job.api.HistoryJob job)
HistoryJobResponse	createHistoryJobResponse(org.flowable.job.api.HistoryJob job, RestUrlBuilder urlBuilder)
List<HistoryJobResponse>	createHistoryJobResponseList(List<org.flowable.job.api.HistoryJob> jobs)
JobResponse	createJobResponse(org.flowable.job.api.Job job)
JobResponse	createJobResponse(org.flowable.job.api.Job job, RestUrlBuilder urlBuilder)
List<JobResponse>	createJobResponseList(List<org.flowable.job.api.Job> jobs)
PlanItemInstanceResponse	createPlanItemInstanceResponse(org.flowable.cmmn.api.runtime.PlanItemInstance planItemInstance)
List<PlanItemInstanceResponse>	createPlanItemInstanceResponseList(List<org.flowable.cmmn.api.runtime.PlanItemInstance> planItemInstances)
RestIdentityLink	createRestIdentityLink(org.flowable.identitylink.api.IdentityLink link)
RestIdentityLink	createRestIdentityLink(org.flowable.identitylink.api.IdentityLink link, RestUrlBuilder urlBuilder)
RestIdentityLink	createRestIdentityLink(String type, String userId, String groupId, String taskId, String caseDefinitionId, String caseInstanceId)
RestIdentityLink	createRestIdentityLink(String type, String userId, String groupId, String taskId, String caseDefinitionId, String caseInstanceId, RestUrlBuilder urlBuilder)
List<RestIdentityLink>	createRestIdentityLinks(List<org.flowable.identitylink.api.IdentityLink> links)
RestVariable	createRestVariable(String name, Object value, RestVariable.RestVariableScope scope, String id, int variableType, boolean includeBinaryValue)
RestVariable	createRestVariable(String name, Object value, RestVariable.RestVariableScope scope, String id, int variableType, boolean includeBinaryValue, RestUrlBuilder urlBuilder)
List<RestVariable>	createRestVariables(Map<String,Object> variables, String id, int variableType)
List<RestVariable>	createRestVariables(Map<String,Object> variables, String id, int variableType, RestVariable.RestVariableScope scope)
TaskResponse	createTaskResponse(org.flowable.task.api.Task task)
TaskResponse	createTaskResponse(org.flowable.task.api.Task task, RestUrlBuilder urlBuilder)
List<TaskResponse>	createTaskResponseList(List<org.flowable.task.api.Task> tasks)
protected RestUrlBuilder	createUrlBuilder()
protected String	formatUrl(String serverRootUrl, String[] fragments, Object... arguments)
String	getFormModelString(FormModelResponse formModelResponse)
List<RestVariableConverter>	getVariableConverters()
Object	getVariableValue(QueryVariable restVariable)
Object	getVariableValue(RestVariable restVariable)
protected void	initializeVariableConverters() Called once when the converters need to be initialized.

Methods inherited from class java.lang.Object

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

Field Detail

VARIABLE_TASK

public static final int VARIABLE_TASK

See Also:

Constant Field Values

VARIABLE_EXECUTION

public static final int VARIABLE_EXECUTION

See Also:

Constant Field Values

VARIABLE_CASE

public static final int VARIABLE_CASE

See Also:

Constant Field Values

VARIABLE_HISTORY_TASK

public static final int VARIABLE_HISTORY_TASK

See Also:

Constant Field Values

VARIABLE_HISTORY_CASE

public static final int VARIABLE_HISTORY_CASE

See Also:

Constant Field Values

VARIABLE_HISTORY_VARINSTANCE

public static final int VARIABLE_HISTORY_VARINSTANCE

See Also:

Constant Field Values

VARIABLE_HISTORY_DETAIL

public static final int VARIABLE_HISTORY_DETAIL

See Also:

Constant Field Values

BYTE_ARRAY_VARIABLE_TYPE

public static final String BYTE_ARRAY_VARIABLE_TYPE

See Also:

Constant Field Values

SERIALIZABLE_VARIABLE_TYPE

public static final String SERIALIZABLE_VARIABLE_TYPE

See Also:

Constant Field Values

objectMapper

protected com.fasterxml.jackson.databind.ObjectMapper objectMapper

variableConverters

protected List<RestVariableConverter> variableConverters

Constructor Detail

CmmnRestResponseFactory

public CmmnRestResponseFactory(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Method Detail

createTaskResponseList

public List<TaskResponse> createTaskResponseList(List<org.flowable.task.api.Task> tasks)

createTaskResponse

public TaskResponse createTaskResponse(org.flowable.task.api.Task task)

createTaskResponse

public TaskResponse createTaskResponse(org.flowable.task.api.Task task,
                                       RestUrlBuilder urlBuilder)

createDeploymentResponseList

public List<CmmnDeploymentResponse> createDeploymentResponseList(List<org.flowable.cmmn.api.repository.CmmnDeployment> deployments)

createDeploymentResponse

public CmmnDeploymentResponse createDeploymentResponse(org.flowable.cmmn.api.repository.CmmnDeployment deployment)

createDeploymentResponse

public CmmnDeploymentResponse createDeploymentResponse(org.flowable.cmmn.api.repository.CmmnDeployment deployment,
                                                       RestUrlBuilder urlBuilder)

createDeploymentResourceResponseList

public List<DeploymentResourceResponse> createDeploymentResourceResponseList(String deploymentId,
                                                                             List<String> resourceList,
                                                                             ContentTypeResolver contentTypeResolver)

createDeploymentResourceResponse

public DeploymentResourceResponse createDeploymentResourceResponse(String deploymentId,
                                                                   String resourceId,
                                                                   String contentType)

createDeploymentResourceResponse

public DeploymentResourceResponse createDeploymentResourceResponse(String deploymentId,
                                                                   String resourceId,
                                                                   String contentType,
                                                                   RestUrlBuilder urlBuilder)

createCaseDefinitionResponseList

public List<CaseDefinitionResponse> createCaseDefinitionResponseList(List<org.flowable.cmmn.api.repository.CaseDefinition> caseDefinitions)

createCaseDefinitionResponse

public CaseDefinitionResponse createCaseDefinitionResponse(org.flowable.cmmn.api.repository.CaseDefinition caseDefinition)

createCaseDefinitionResponse

public CaseDefinitionResponse createCaseDefinitionResponse(org.flowable.cmmn.api.repository.CaseDefinition caseDefinition,
                                                           RestUrlBuilder urlBuilder)

getFormModelString

public String getFormModelString(FormModelResponse formModelResponse)

createRestVariables

public List<RestVariable> createRestVariables(Map<String,Object> variables,
                                              String id,
                                              int variableType)

createRestVariables

public List<RestVariable> createRestVariables(Map<String,Object> variables,
                                              String id,
                                              int variableType,
                                              RestVariable.RestVariableScope scope)

createRestVariable

public RestVariable createRestVariable(String name,
                                       Object value,
                                       RestVariable.RestVariableScope scope,
                                       String id,
                                       int variableType,
                                       boolean includeBinaryValue)

createRestVariable

public RestVariable createRestVariable(String name,
                                       Object value,
                                       RestVariable.RestVariableScope scope,
                                       String id,
                                       int variableType,
                                       boolean includeBinaryValue,
                                       RestUrlBuilder urlBuilder)

createBinaryRestVariable

public RestVariable createBinaryRestVariable(String name,
                                             RestVariable.RestVariableScope scope,
                                             String type,
                                             String taskId,
                                             String caseInstanceId)

getVariableValue

public Object getVariableValue(RestVariable restVariable)

getVariableValue

public Object getVariableValue(QueryVariable restVariable)

createRestIdentityLinks

public List<RestIdentityLink> createRestIdentityLinks(List<org.flowable.identitylink.api.IdentityLink> links)

createRestIdentityLink

public RestIdentityLink createRestIdentityLink(org.flowable.identitylink.api.IdentityLink link)

createRestIdentityLink

public RestIdentityLink createRestIdentityLink(org.flowable.identitylink.api.IdentityLink link,
                                               RestUrlBuilder urlBuilder)

createRestIdentityLink

public RestIdentityLink createRestIdentityLink(String type,
                                               String userId,
                                               String groupId,
                                               String taskId,
                                               String caseDefinitionId,
                                               String caseInstanceId)

createRestIdentityLink

public RestIdentityLink createRestIdentityLink(String type,
                                               String userId,
                                               String groupId,
                                               String taskId,
                                               String caseDefinitionId,
                                               String caseInstanceId,
                                               RestUrlBuilder urlBuilder)

createCaseInstanceResponseList

public List<CaseInstanceResponse> createCaseInstanceResponseList(List<org.flowable.cmmn.api.runtime.CaseInstance> caseInstances)

createCaseInstanceResponse

public CaseInstanceResponse createCaseInstanceResponse(org.flowable.cmmn.api.runtime.CaseInstance caseInstance)

createCaseInstanceResponse

public CaseInstanceResponse createCaseInstanceResponse(org.flowable.cmmn.api.runtime.CaseInstance caseInstance,
                                                       RestUrlBuilder urlBuilder)

createCaseInstanceResponse

public CaseInstanceResponse createCaseInstanceResponse(org.flowable.cmmn.api.runtime.CaseInstance caseInstance,
                                                       boolean returnVariables,
                                                       Map<String,Object> runtimeVariableMap)

createPlanItemInstanceResponseList

public List<PlanItemInstanceResponse> createPlanItemInstanceResponseList(List<org.flowable.cmmn.api.runtime.PlanItemInstance> planItemInstances)

createPlanItemInstanceResponse

public PlanItemInstanceResponse createPlanItemInstanceResponse(org.flowable.cmmn.api.runtime.PlanItemInstance planItemInstance)

createHistoricCaseInstanceResponseList

public List<HistoricCaseInstanceResponse> createHistoricCaseInstanceResponseList(List<org.flowable.cmmn.api.history.HistoricCaseInstance> caseInstances)

createHistoricCaseInstanceResponse

public HistoricCaseInstanceResponse createHistoricCaseInstanceResponse(org.flowable.cmmn.api.history.HistoricCaseInstance caseInstance)

createHistoricCaseInstanceResponse

public HistoricCaseInstanceResponse createHistoricCaseInstanceResponse(org.flowable.cmmn.api.history.HistoricCaseInstance caseInstance,
                                                                       RestUrlBuilder urlBuilder)

createHistoricTaskInstanceResponseList

public List<HistoricTaskInstanceResponse> createHistoricTaskInstanceResponseList(List<org.flowable.task.api.history.HistoricTaskInstance> taskInstances)

createHistoricTaskInstanceResponse

public HistoricTaskInstanceResponse createHistoricTaskInstanceResponse(org.flowable.task.api.history.HistoricTaskInstance taskInstance)

createHistoricTaskInstanceResponse

public HistoricTaskInstanceResponse createHistoricTaskInstanceResponse(org.flowable.task.api.history.HistoricTaskInstance taskInstance,
                                                                       RestUrlBuilder urlBuilder)

createHistoricVariableInstanceResponseList

public List<HistoricVariableInstanceResponse> createHistoricVariableInstanceResponseList(List<org.flowable.variable.api.history.HistoricVariableInstance> variableInstances)

createHistoricVariableInstanceResponse

public HistoricVariableInstanceResponse createHistoricVariableInstanceResponse(org.flowable.variable.api.history.HistoricVariableInstance variableInstance)

createHistoricVariableInstanceResponse

public HistoricVariableInstanceResponse createHistoricVariableInstanceResponse(org.flowable.variable.api.history.HistoricVariableInstance variableInstance,
                                                                               RestUrlBuilder urlBuilder)

createHistoricIdentityLinkResponseList

public List<HistoricIdentityLinkResponse> createHistoricIdentityLinkResponseList(List<org.flowable.identitylink.api.history.HistoricIdentityLink> identityLinks)

createHistoricIdentityLinkResponse

public HistoricIdentityLinkResponse createHistoricIdentityLinkResponse(org.flowable.identitylink.api.history.HistoricIdentityLink identityLink)

createHistoricIdentityLinkResponse

public HistoricIdentityLinkResponse createHistoricIdentityLinkResponse(org.flowable.identitylink.api.history.HistoricIdentityLink identityLink,
                                                                       RestUrlBuilder urlBuilder)

createHistoricMilestoneInstanceResponseList

public List<HistoricMilestoneInstanceResponse> createHistoricMilestoneInstanceResponseList(List<org.flowable.cmmn.api.history.HistoricMilestoneInstance> historicMilestoneInstances)

createHistoricMilestoneInstanceResponse

public HistoricMilestoneInstanceResponse createHistoricMilestoneInstanceResponse(org.flowable.cmmn.api.history.HistoricMilestoneInstance historicMilestoneInstance)

createHistoricMilestoneInstanceResponse

public HistoricMilestoneInstanceResponse createHistoricMilestoneInstanceResponse(org.flowable.cmmn.api.history.HistoricMilestoneInstance historicMilestoneInstance,
                                                                                 RestUrlBuilder urlBuilder)

createHistoricPlanItemInstanceResponseList

public List<HistoricPlanItemInstanceResponse> createHistoricPlanItemInstanceResponseList(List<org.flowable.cmmn.api.history.HistoricPlanItemInstance> historicPlanItemInstances)

createHistoricPlanItemInstanceResponse

public HistoricPlanItemInstanceResponse createHistoricPlanItemInstanceResponse(org.flowable.cmmn.api.history.HistoricPlanItemInstance historicPlanItemInstance)

createHistoricPlanItemInstanceResponse

public HistoricPlanItemInstanceResponse createHistoricPlanItemInstanceResponse(org.flowable.cmmn.api.history.HistoricPlanItemInstance historicPlanItemInstance,
                                                                               RestUrlBuilder urlBuilder)

createDecisionResponseList

public List<DecisionResponse> createDecisionResponseList(List<org.flowable.dmn.api.DmnDecision> decisions,
                                                         String processDefinitionId)

createDecisionResponse

public DecisionResponse createDecisionResponse(org.flowable.dmn.api.DmnDecision decision,
                                               String processDefinitionId)

createDecisionResponse

public DecisionResponse createDecisionResponse(org.flowable.dmn.api.DmnDecision decision,
                                               String caseDefinitionId,
                                               RestUrlBuilder urlBuilder)

createFormDefinitionResponseList

public List<FormDefinitionResponse> createFormDefinitionResponseList(List<org.flowable.form.api.FormDefinition> formDefinitions,
                                                                     String processDefinitionId)

createFormDefintionResponse

public FormDefinitionResponse createFormDefintionResponse(org.flowable.form.api.FormDefinition formDefinition,
                                                          String processDefinitionId)

createFormDefinitionResponse

public FormDefinitionResponse createFormDefinitionResponse(org.flowable.form.api.FormDefinition formDefinition,
                                                           String caseDefinitionId,
                                                           RestUrlBuilder urlBuilder)

createJobResponseList

public List<JobResponse> createJobResponseList(List<org.flowable.job.api.Job> jobs)

createJobResponse

public JobResponse createJobResponse(org.flowable.job.api.Job job)

createJobResponse

public JobResponse createJobResponse(org.flowable.job.api.Job job,
                                     RestUrlBuilder urlBuilder)

createHistoryJobResponseList

public List<HistoryJobResponse> createHistoryJobResponseList(List<org.flowable.job.api.HistoryJob> jobs)

createHistoryJobResponse

public HistoryJobResponse createHistoryJobResponse(org.flowable.job.api.HistoryJob job)

createHistoryJobResponse

public HistoryJobResponse createHistoryJobResponse(org.flowable.job.api.HistoryJob job,
                                                   RestUrlBuilder urlBuilder)

getVariableConverters

public List<RestVariableConverter> getVariableConverters()

Returns:

list of RestVariableConverter which are used by this factory. Additional converters can be added and existing ones replaced ore removed.

initializeVariableConverters

protected void initializeVariableConverters()

Called once when the converters need to be initialized. Override of custom conversion needs to be done between java and rest.

formatUrl

protected String formatUrl(String serverRootUrl,
                           String[] fragments,
                           Object... arguments)

createUrlBuilder

protected RestUrlBuilder createUrlBuilder()