Package 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 Details

  • Constructor Details

    • CmmnRestResponseFactory

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

  • Method Details

    • 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 instanceId, int responseVariableType)

    • 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)

    • createVariableInstanceResponseList

      public List<VariableInstanceResponse> createVariableInstanceResponseList(List<org.flowable.variable.api.persistence.entity.VariableInstance> variableInstances)

    • createVariableInstanceResponse

      public VariableInstanceResponse createVariableInstanceResponse(org.flowable.variable.api.persistence.entity.VariableInstance variableInstance)

    • createVariableInstanceResponse

      public VariableInstanceResponse createVariableInstanceResponse(org.flowable.variable.api.persistence.entity.VariableInstance variableInstance, RestUrlBuilder urlBuilder)

    • createEventSubscriptionResponseList

      public List<EventSubscriptionResponse> createEventSubscriptionResponseList(List<org.flowable.eventsubscription.api.EventSubscription> eventSubscriptions)

    • createEventSubscriptionResponse

      public EventSubscriptionResponse createEventSubscriptionResponse(org.flowable.eventsubscription.api.EventSubscription eventSubscription)

    • createEventSubscriptionResponse

      public EventSubscriptionResponse createEventSubscriptionResponse(org.flowable.eventsubscription.api.EventSubscription eventSubscription, RestUrlBuilder urlBuilder)

    • 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)

    • createTimerJobResponseList

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

    • createSuspendedJobResponseList

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

    • createDeadLetterJobResponseList

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

    • createJobResponseList

      public List<JobResponse> createJobResponseList(List<org.flowable.job.api.Job> jobs, String[] urlJobSegments)

    • createJobResponse

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

    • createTimerJobResponse

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

    • createSuspendedJobResponse

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

    • createDeadLetterJobResponse

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

    • createJobResponse

      public JobResponse createJobResponse(org.flowable.job.api.Job job, RestUrlBuilder urlBuilder, String[] urlJobSegments)

    • 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()