Package org.flowable.rest.service.api
Class RestResponseFactory
java.lang.Object
org.flowable.rest.service.api.RestResponseFactory
Default implementation of a
RestResponseFactory
.
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
FieldsModifier and TypeFieldDescriptionstatic final String
protected com.fasterxml.jackson.databind.ObjectMapper
static final String
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
protected List<RestVariableConverter>
-
Constructor Summary
ConstructorsConstructorDescriptionRestResponseFactory
(com.fasterxml.jackson.databind.ObjectMapper objectMapper) -
Method Summary
Modifier and TypeMethodDescriptioncreateActivityInstanceResponse
(ActivityInstance activityInstance) createActivityInstanceResponse
(ActivityInstance activityInstance, RestUrlBuilder urlBuilder) createActivityInstanceResponseList
(List<ActivityInstance> activityInstances) createAttachmentResponse
(Attachment attachment) createAttachmentResponse
(Attachment attachment, RestUrlBuilder urlBuilder) createBatchPartResponse
(List<BatchPart> batchParts) createBatchPartResponse
(BatchPart batchPart) createBatchPartResponse
(BatchPart batchPart, RestUrlBuilder urlBuilder) createBatchResponse
(List<Batch> batches) createBatchResponse
(Batch batch) createBatchResponse
(Batch batch, RestUrlBuilder urlBuilder) createBinaryRestVariable
(String name, RestVariable.RestVariableScope scope, String type, String taskId, String executionId, String processInstanceId) createDecisionResponse
(DmnDecision decision, String processDefinitionId) createDecisionResponse
(DmnDecision decision, String processDefinitionId, RestUrlBuilder urlBuilder) createDecisionResponseList
(List<DmnDecision> decisions, String processDefinitionId) createDeploymentResourceResponse
(String deploymentId, String resourceId, String contentType) createDeploymentResourceResponse
(String deploymentId, String resourceId, String contentType, RestUrlBuilder urlBuilder) createDeploymentResourceResponseList
(String deploymentId, List<String> resourceList, ContentTypeResolver contentTypeResolver) createDeploymentResponse
(Deployment deployment) createDeploymentResponse
(Deployment deployment, RestUrlBuilder urlBuilder) createDeploymentResponseList
(List<Deployment> deployments) createEventResponse
(Event event) createEventResponse
(Event event, RestUrlBuilder urlBuilder) createEventResponseList
(List<Event> events) createEventSubscriptionResponse
(EventSubscription eventSubscription) createEventSubscriptionResponse
(EventSubscription eventSubscription, RestUrlBuilder urlBuilder) createEventSubscriptionResponseList
(List<EventSubscription> eventSubscriptions) createExecutionResponse
(Execution execution) createExecutionResponse
(Execution execution, RestUrlBuilder urlBuilder) createExecutionResponseList
(List<Execution> executions) createFormDataResponse
(FormData formData) createFormDefinitionResponse
(FormDefinition formDefinition, String processDefinitionId, RestUrlBuilder urlBuilder) createFormDefinitionResponseList
(List<FormDefinition> formDefinitions, String processDefinitionId) createFormDefintionResponse
(FormDefinition formDefinition, String processDefinitionId) createGroupResponse
(Group group) createGroupResponse
(Group group, RestUrlBuilder urlBuilder) createGroupResponseList
(List<Group> groups) createHistoricActivityInstanceResponse
(HistoricActivityInstance activityInstance) createHistoricActivityInstanceResponse
(HistoricActivityInstance activityInstance, RestUrlBuilder urlBuilder) createHistoricActivityInstanceResponseList
(List<HistoricActivityInstance> activityInstances) createHistoricDetailResponse
(List<HistoricDetail> detailList) createHistoricDetailResponse
(HistoricDetail detail, RestUrlBuilder urlBuilder) createHistoricIdentityLinkResponse
(HistoricIdentityLink identityLink) createHistoricIdentityLinkResponse
(HistoricIdentityLink identityLink, RestUrlBuilder urlBuilder) createHistoricIdentityLinkResponseList
(List<HistoricIdentityLink> identityLinks) createHistoricProcessInstanceResponse
(HistoricProcessInstance processInstance) createHistoricProcessInstanceResponse
(HistoricProcessInstance processInstance, RestUrlBuilder urlBuilder) createHistoricProcessInstanceResponseList
(List<HistoricProcessInstance> processInstances) createHistoricTaskInstanceResponse
(HistoricTaskInstance taskInstance) createHistoricTaskInstanceResponse
(HistoricTaskInstance taskInstance, RestUrlBuilder urlBuilder) createHistoricTaskInstanceResponseList
(List<HistoricTaskInstance> taskInstances) createHistoricTaskLogEntryResponse
(HistoricTaskLogEntry logEntry, RestUrlBuilder urlBuilder) createHistoricVariableInstanceResponse
(HistoricVariableInstance variableInstance) createHistoricVariableInstanceResponse
(HistoricVariableInstance variableInstance, RestUrlBuilder urlBuilder) createHistoricVariableInstanceResponseList
(List<HistoricVariableInstance> variableInstances) createHistoryJobResponse
(HistoryJob job, RestUrlBuilder urlBuilder) createJobResponse
(Job job) createJobResponse
(Job job, RestUrlBuilder urlBuilder) protected JobResponse
createJobResponse
(Job job, RestUrlBuilder urlBuilder, String[] urlJobSegments) createJobResponseList
(List<Job> jobs) protected List<JobResponse>
createJobResponseList
(List<Job> jobs, String[] urlJobSegments) createMembershipResponse
(String userId, String groupId) createMembershipResponse
(String userId, String groupId, RestUrlBuilder urlBuilder) createModelResponse
(Model model) createModelResponse
(Model model, RestUrlBuilder urlBuilder) createModelResponseList
(List<Model> models) createProcessDefinitionResponse
(ProcessDefinition processDefinition) createProcessDefinitionResponse
(ProcessDefinition processDefinition, RestUrlBuilder urlBuilder) createProcessDefinitionResponseList
(List<ProcessDefinition> processDefinitions) createProcessInstanceResponse
(ProcessInstance processInstance) createProcessInstanceResponse
(ProcessInstance processInstance, boolean returnVariables, Map<String, Object> runtimeVariableMap, List<HistoricVariableInstance> historicVariableList) createProcessInstanceResponse
(ProcessInstance processInstance, RestUrlBuilder urlBuilder) createProcessInstanceResponseList
(List<ProcessInstance> processInstances) createRestComment
(Comment comment) createRestComment
(Comment comment, RestUrlBuilder urlBuilder) createRestCommentList
(List<Comment> comments) createRestIdentityLink
(String type, String userId, String groupId, String taskId, String processDefinitionId, String processInstanceId) createRestIdentityLink
(String type, String userId, String groupId, String taskId, String processDefinitionId, String processInstanceId, RestUrlBuilder urlBuilder) createRestIdentityLink
(IdentityLink link, RestUrlBuilder urlBuilder) createRestIdentityLinks
(List<IdentityLink> links) createRestVariable
(String name, Object value, RestVariable.RestVariableScope scope, String id, int variableType, boolean includeBinaryValue) createRestVariable
(String name, Object value, RestVariable.RestVariableScope scope, String id, int variableType, boolean includeBinaryValue, RestUrlBuilder urlBuilder) createRestVariables
(Map<String, Object> variables, String id, int variableType, RestVariable.RestVariableScope scope) createTableResponse
(String name, Long count) createTableResponse
(String name, Long count, RestUrlBuilder urlBuilder) createTableResponseList
(Map<String, Long> tableCounts) createTaskResponse
(Task task) createTaskResponse
(Task task, RestUrlBuilder urlBuilder) createTaskResponseList
(List<Task> tasks) createTimerJobResponseList
(List<Job> jobs) protected RestUrlBuilder
createUserInfoKeysResponse
(List<String> keys, String userId) createUserInfoResponse
(String key, String value, String userId) createUserInfoResponse
(String key, String value, String userId, RestUrlBuilder urlBuilder) createUserResponse
(User user, boolean includePassword) createUserResponse
(User user, boolean incudePassword, RestUrlBuilder urlBuilder) createUserResponseList
(List<User> users) createUserResponseList
(List<User> users, boolean includePassword) createVariableInstanceResponse
(VariableInstance variableInstance) createVariableInstanceResponse
(VariableInstance variableInstance, RestUrlBuilder urlBuilder) createVariableInstanceResponseList
(List<VariableInstance> variableInstances) protected String
getFormModelString
(FormModelResponse formModelResponse) getVariableValue
(QueryVariable restVariable) getVariableValue
(RestVariable restVariable) protected void
Called once when the converters need to be initialized.protected ProcessInstanceResponse
internalCreateProcessInstanceResponse
(ProcessInstance processInstance, RestUrlBuilder urlBuilder)
-
Field Details
-
VARIABLE_TASK
public static final int VARIABLE_TASK- See Also:
-
VARIABLE_EXECUTION
public static final int VARIABLE_EXECUTION- See Also:
-
VARIABLE_PROCESS
public static final int VARIABLE_PROCESS- See Also:
-
VARIABLE_VARINSTANCE
public static final int VARIABLE_VARINSTANCE- See Also:
-
VARIABLE_HISTORY_TASK
public static final int VARIABLE_HISTORY_TASK- See Also:
-
VARIABLE_HISTORY_PROCESS
public static final int VARIABLE_HISTORY_PROCESS- See Also:
-
VARIABLE_HISTORY_VARINSTANCE
public static final int VARIABLE_HISTORY_VARINSTANCE- See Also:
-
VARIABLE_HISTORY_DETAIL
public static final int VARIABLE_HISTORY_DETAIL- See Also:
-
BYTE_ARRAY_VARIABLE_TYPE
- See Also:
-
SERIALIZABLE_VARIABLE_TYPE
- See Also:
-
objectMapper
protected com.fasterxml.jackson.databind.ObjectMapper objectMapper -
variableConverters
-
-
Constructor Details
-
RestResponseFactory
public RestResponseFactory(com.fasterxml.jackson.databind.ObjectMapper objectMapper)
-
-
Method Details
-
createTaskResponseList
-
createTaskResponse
-
createTaskResponse
-
createDeploymentResponseList
-
createDeploymentResponse
-
createDeploymentResponse
public DeploymentResponse createDeploymentResponse(Deployment 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) -
createProcessDefinitionResponseList
public List<ProcessDefinitionResponse> createProcessDefinitionResponseList(List<ProcessDefinition> processDefinitions) -
createProcessDefinitionResponse
public ProcessDefinitionResponse createProcessDefinitionResponse(ProcessDefinition processDefinition) -
createProcessDefinitionResponse
public ProcessDefinitionResponse createProcessDefinitionResponse(ProcessDefinition processDefinition, RestUrlBuilder urlBuilder) -
getFormModelString
-
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 executionId, String processInstanceId) -
getVariableValue
-
getVariableValue
-
createRestIdentityLinks
-
createRestIdentityLink
-
createRestIdentityLink
-
createRestIdentityLink
-
createRestIdentityLink
public RestIdentityLink createRestIdentityLink(String type, String userId, String groupId, String taskId, String processDefinitionId, String processInstanceId, RestUrlBuilder urlBuilder) -
createRestCommentList
-
createRestComment
-
createRestComment
-
createEventResponseList
-
createEventResponse
-
createEventResponse
-
createAttachmentResponse
-
createAttachmentResponse
public AttachmentResponse createAttachmentResponse(Attachment attachment, RestUrlBuilder urlBuilder) -
createProcessInstanceResponseList
public List<ProcessInstanceResponse> createProcessInstanceResponseList(List<ProcessInstance> processInstances) -
createProcessInstanceResponse
-
createProcessInstanceResponse
public ProcessInstanceResponse createProcessInstanceResponse(ProcessInstance processInstance, RestUrlBuilder urlBuilder) -
createProcessInstanceResponse
public ProcessInstanceResponse createProcessInstanceResponse(ProcessInstance processInstance, boolean returnVariables, Map<String, Object> runtimeVariableMap, List<HistoricVariableInstance> historicVariableList) -
internalCreateProcessInstanceResponse
protected ProcessInstanceResponse internalCreateProcessInstanceResponse(ProcessInstance processInstance, RestUrlBuilder urlBuilder) -
createExecutionResponseList
-
createExecutionResponse
-
createExecutionResponse
-
createActivityInstanceResponseList
public List<ActivityInstanceResponse> createActivityInstanceResponseList(List<ActivityInstance> activityInstances) -
createActivityInstanceResponse
-
createActivityInstanceResponse
public ActivityInstanceResponse createActivityInstanceResponse(ActivityInstance activityInstance, RestUrlBuilder urlBuilder) -
createVariableInstanceResponseList
public List<VariableInstanceResponse> createVariableInstanceResponseList(List<VariableInstance> variableInstances) -
createVariableInstanceResponse
-
createVariableInstanceResponse
public VariableInstanceResponse createVariableInstanceResponse(VariableInstance variableInstance, RestUrlBuilder urlBuilder) -
createFormDataResponse
-
createHistoricProcessInstanceResponseList
public List<HistoricProcessInstanceResponse> createHistoricProcessInstanceResponseList(List<HistoricProcessInstance> processInstances) -
createHistoricProcessInstanceResponse
public HistoricProcessInstanceResponse createHistoricProcessInstanceResponse(HistoricProcessInstance processInstance) -
createHistoricProcessInstanceResponse
public HistoricProcessInstanceResponse createHistoricProcessInstanceResponse(HistoricProcessInstance processInstance, RestUrlBuilder urlBuilder) -
createHistoricTaskInstanceResponseList
public List<HistoricTaskInstanceResponse> createHistoricTaskInstanceResponseList(List<HistoricTaskInstance> taskInstances) -
createHistoricTaskInstanceResponse
public HistoricTaskInstanceResponse createHistoricTaskInstanceResponse(HistoricTaskInstance taskInstance) -
createHistoricTaskInstanceResponse
public HistoricTaskInstanceResponse createHistoricTaskInstanceResponse(HistoricTaskInstance taskInstance, RestUrlBuilder urlBuilder) -
createHistoricTaskLogEntryResponseList
public List<HistoricTaskLogEntryResponse> createHistoricTaskLogEntryResponseList(List<HistoricTaskLogEntry> logEntries) -
createHistoricTaskLogEntryResponse
public HistoricTaskLogEntryResponse createHistoricTaskLogEntryResponse(HistoricTaskLogEntry logEntry, RestUrlBuilder urlBuilder) -
createHistoricActivityInstanceResponseList
public List<HistoricActivityInstanceResponse> createHistoricActivityInstanceResponseList(List<HistoricActivityInstance> activityInstances) -
createHistoricActivityInstanceResponse
public HistoricActivityInstanceResponse createHistoricActivityInstanceResponse(HistoricActivityInstance activityInstance) -
createHistoricActivityInstanceResponse
public HistoricActivityInstanceResponse createHistoricActivityInstanceResponse(HistoricActivityInstance activityInstance, RestUrlBuilder urlBuilder) -
createHistoricVariableInstanceResponseList
public List<HistoricVariableInstanceResponse> createHistoricVariableInstanceResponseList(List<HistoricVariableInstance> variableInstances) -
createHistoricVariableInstanceResponse
public HistoricVariableInstanceResponse createHistoricVariableInstanceResponse(HistoricVariableInstance variableInstance) -
createHistoricVariableInstanceResponse
public HistoricVariableInstanceResponse createHistoricVariableInstanceResponse(HistoricVariableInstance variableInstance, RestUrlBuilder urlBuilder) -
createHistoricDetailResponse
-
createHistoricDetailResponse
-
createHistoricDetailResponse
public HistoricDetailResponse createHistoricDetailResponse(HistoricDetail detail, RestUrlBuilder urlBuilder) -
createHistoricIdentityLinkResponseList
public List<HistoricIdentityLinkResponse> createHistoricIdentityLinkResponseList(List<HistoricIdentityLink> identityLinks) -
createHistoricIdentityLinkResponse
public HistoricIdentityLinkResponse createHistoricIdentityLinkResponse(HistoricIdentityLink identityLink) -
createHistoricIdentityLinkResponse
public HistoricIdentityLinkResponse createHistoricIdentityLinkResponse(HistoricIdentityLink identityLink, RestUrlBuilder urlBuilder) -
createTableResponseList
-
createTableResponse
-
createTableResponse
-
createJobResponseList
-
createTimerJobResponseList
-
createSuspendedJobResponseList
-
createDeadLetterJobResponseList
-
createJobResponseList
-
createJobResponse
-
createTimerJobResponse
-
createSuspendedJobResponse
-
createDeadLetterJobResponse
-
createJobResponse
-
createJobResponse
protected JobResponse createJobResponse(Job job, RestUrlBuilder urlBuilder, String[] urlJobSegments) -
createHistoryJobResponseList
-
createHistoryJobResponse
-
createHistoryJobResponse
-
createBatchResponse
-
createBatchResponse
-
createBatchResponse
-
createBatchPartResponse
-
createBatchPartResponse
-
createBatchPartResponse
-
createEventSubscriptionResponseList
public List<EventSubscriptionResponse> createEventSubscriptionResponseList(List<EventSubscription> eventSubscriptions) -
createEventSubscriptionResponse
public EventSubscriptionResponse createEventSubscriptionResponse(EventSubscription eventSubscription) -
createEventSubscriptionResponse
public EventSubscriptionResponse createEventSubscriptionResponse(EventSubscription eventSubscription, RestUrlBuilder urlBuilder) -
createUserResponseList
-
createUserResponseList
-
createUserResponse
-
createUserResponse
public UserResponse createUserResponse(User user, boolean incudePassword, RestUrlBuilder urlBuilder) -
createUserInfoKeysResponse
-
createUserInfoResponse
-
createUserInfoResponse
public UserInfoResponse createUserInfoResponse(String key, String value, String userId, RestUrlBuilder urlBuilder) -
createGroupResponseList
-
createGroupResponse
-
createGroupResponse
-
createMembershipResponse
-
createMembershipResponse
public MembershipResponse createMembershipResponse(String userId, String groupId, RestUrlBuilder urlBuilder) -
createModelResponseList
-
createModelResponse
-
createModelResponse
-
createDecisionResponseList
public List<DecisionResponse> createDecisionResponseList(List<DmnDecision> decisions, String processDefinitionId) -
createDecisionResponse
-
createDecisionResponse
public DecisionResponse createDecisionResponse(DmnDecision decision, String processDefinitionId, RestUrlBuilder urlBuilder) -
createFormDefinitionResponseList
public List<FormDefinitionResponse> createFormDefinitionResponseList(List<FormDefinition> formDefinitions, String processDefinitionId) -
createFormDefintionResponse
public FormDefinitionResponse createFormDefintionResponse(FormDefinition formDefinition, String processDefinitionId) -
createFormDefinitionResponse
public FormDefinitionResponse createFormDefinitionResponse(FormDefinition formDefinition, String processDefinitionId, RestUrlBuilder urlBuilder) -
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
-
createUrlBuilder
-