public class RepositoryServiceImpl extends ServiceImpl implements RepositoryService
| Modifier and Type | Field and Description |
|---|---|
protected Charset |
deploymentCharset |
commandExecutor| Constructor and Description |
|---|
RepositoryServiceImpl() |
| Modifier and Type | Method and Description |
|---|---|
void |
activateProcessDefinitionById(String processDefinitionId)
Activates the process definition with the given id.
|
void |
activateProcessDefinitionById(String processDefinitionId,
boolean activateProcessInstances,
Date activationDate)
Activates the process definition with the given id.
|
void |
activateProcessDefinitionByKey(String processDefinitionKey)
Activates the process definition with the given key (=id in the bpmn20.xml file).
|
void |
activateProcessDefinitionByKey(String processDefinitionKey,
boolean activateProcessInstances,
Date activationDate)
Activates the process definition with the given key (=id in the bpmn20.xml file).
|
void |
addCandidateStarterGroup(String processDefinitionId,
String groupId)
Authorizes a candidate group for a process definition.
|
void |
addCandidateStarterUser(String processDefinitionId,
String userId)
Authorizes a candidate user for a process definition.
|
CaseDefinitionQuery |
createCaseDefinitionQuery()
Query case definitions.
|
DecisionDefinitionQuery |
createDecisionDefinitionQuery()
Query decision definitions.
|
DecisionRequirementsDefinitionQuery |
createDecisionRequirementsDefinitionQuery()
Query decision requirements definition.
|
DeploymentBuilder |
createDeployment()
Starts creating a new deployment
|
ProcessApplicationDeploymentBuilder |
createDeployment(ProcessApplicationReference processApplication)
Starts creating a new
ProcessApplicationDeployment. |
DeploymentQuery |
createDeploymentQuery()
Query process definitions.
|
ProcessDefinitionQuery |
createProcessDefinitionQuery()
Query process definitions.
|
void |
deleteCandidateStarterGroup(String processDefinitionId,
String groupId)
Removes the authorization of a candidate group for a process definition.
|
void |
deleteCandidateStarterUser(String processDefinitionId,
String userId)
Removes the authorization of a candidate user for a process definition.
|
void |
deleteDeployment(String deploymentId)
Deletes the given deployment.
|
void |
deleteDeployment(String deploymentId,
boolean cascade)
Deletes the given deployment and cascade deletion to process instances,
history process instances and jobs.
|
void |
deleteDeployment(String deploymentId,
boolean cascade,
boolean skipCustomListeners)
Deletes the given deployment and cascade deletion to process instances,
history process instances and jobs.
|
void |
deleteDeployment(String deploymentId,
boolean cascade,
boolean skipCustomListeners,
boolean skipIoMappings)
Deletes the given deployment and cascade deletion to process instances,
history process instances and jobs.
|
void |
deleteDeploymentCascade(String deploymentId)
Deletes the given deployment and cascade deletion to process instances,
history process instances and jobs.
|
void |
deleteProcessDefinition(String processDefinitionId)
Deletes the process definition which belongs to the given process definition id.
|
void |
deleteProcessDefinition(String processDefinitionId,
boolean cascade)
Deletes the process definition which belongs to the given process definition id.
|
void |
deleteProcessDefinition(String processDefinitionId,
boolean cascade,
boolean skipCustomListeners)
Deletes the process definition which belongs to the given process definition id.
|
void |
deleteProcessDefinition(String processDefinitionId,
boolean cascade,
boolean skipCustomListeners,
boolean skipIoMappings)
Deletes the process definition which belongs to the given process definition id.
|
DeleteProcessDefinitionsSelectBuilder |
deleteProcessDefinitions()
Fluent builder to delete process definitions.
|
DeploymentWithDefinitions |
deployWithResult(DeploymentBuilderImpl deploymentBuilder) |
BpmnModelInstance |
getBpmnModelInstance(String processDefinitionId)
Returns the
BpmnModelInstance for the given processDefinitionId. |
CaseDefinition |
getCaseDefinition(String caseDefinitionId)
Returns the
CaseDefinition. |
InputStream |
getCaseDiagram(String caseDefinitionId)
Gives access to a deployed case diagram, e.g., a PNG image, through a
stream of bytes.
|
InputStream |
getCaseModel(String caseDefinitionId)
Gives access to a deployed case model, e.g., a CMMN 1.0 XML file,
through a stream of bytes.
|
CmmnModelInstance |
getCmmnModelInstance(String caseDefinitionId)
Returns the
CmmnModelInstance for the given caseDefinitionId. |
DecisionDefinition |
getDecisionDefinition(String decisionDefinitionId)
Returns the
DecisionDefinition. |
InputStream |
getDecisionDiagram(String decisionDefinitionId)
Gives access to a deployed decision diagram, e.g., a PNG image, through a
stream of bytes.
|
InputStream |
getDecisionModel(String decisionDefinitionId)
Gives access to a deployed decision model, e.g., a DMN 1.1 XML file,
through a stream of bytes.
|
DecisionRequirementsDefinition |
getDecisionRequirementsDefinition(String decisionRequirementsDefinitionId)
Returns the
DecisionRequirementsDefinition. |
InputStream |
getDecisionRequirementsDiagram(String decisionRequirementsDefinitionId)
Gives access to a deployed decision requirements diagram, e.g., a PNG image, through a
stream of bytes.
|
InputStream |
getDecisionRequirementsModel(String decisionRequirementsDefinitionId)
Gives access to a deployed decision requirements model, e.g., a DMN 1.1 XML file,
through a stream of bytes.
|
ReadOnlyProcessDefinition |
getDeployedProcessDefinition(String processDefinitionId) |
Charset |
getDeploymentCharset() |
List<String> |
getDeploymentResourceNames(String deploymentId)
Retrieves a list of deployment resource names for the given deployment,
ordered alphabetically.
|
List<Resource> |
getDeploymentResources(String deploymentId)
Retrieves a list of deployment resources for the given deployment,
ordered alphabetically by name.
|
DmnModelInstance |
getDmnModelInstance(String decisionDefinitionId)
Returns the
DmnModelInstance for the given decisionDefinitionId. |
List<IdentityLink> |
getIdentityLinksForProcessDefinition(String processDefinitionId)
Retrieves the
IdentityLinks associated with the given process definition. |
ProcessDefinition |
getProcessDefinition(String processDefinitionId)
Returns the
ProcessDefinition including all BPMN information like additional
Properties (e.g. |
InputStream |
getProcessDiagram(String processDefinitionId)
Gives access to a deployed process diagram, e.g., a PNG image, through a
stream of bytes.
|
DiagramLayout |
getProcessDiagramLayout(String processDefinitionId)
Provides positions and dimensions of elements in a process diagram as
provided by
RepositoryService.getProcessDiagram(String). |
InputStream |
getProcessModel(String processDefinitionId)
Gives access to a deployed process model, e.g., a BPMN 2.0 XML file,
through a stream of bytes.
|
InputStream |
getResourceAsStream(String deploymentId,
String resourceName)
Gives access to a deployment resource through a stream of bytes.
|
InputStream |
getResourceAsStreamById(String deploymentId,
String resourceId)
Gives access to a deployment resource through a stream of bytes.
|
void |
setDeploymentCharset(Charset deploymentCharset) |
void |
suspendProcessDefinitionById(String processDefinitionId)
Suspends the process definition with the given id.
|
void |
suspendProcessDefinitionById(String processDefinitionId,
boolean suspendProcessInstances,
Date suspensionDate)
Suspends the process definition with the given id.
|
void |
suspendProcessDefinitionByKey(String processDefinitionKey)
Suspends the all process definitions with the given key (= id in the bpmn20.xml file).
|
void |
suspendProcessDefinitionByKey(String processDefinitionKey,
boolean suspendProcessInstances,
Date suspensionDate)
Suspends the all process definitions with the given key (= id in the bpmn20.xml file).
|
void |
updateCaseDefinitionHistoryTimeToLive(String caseDefinitionId,
Integer historyTimeToLive)
Updates time to live of case definition.
|
void |
updateDecisionDefinitionHistoryTimeToLive(String decisionDefinitionId,
Integer historyTimeToLive)
Updates time to live of decision definition.
|
void |
updateProcessDefinitionHistoryTimeToLive(String processDefinitionId,
Integer historyTimeToLive)
Updates time to live of process definition.
|
UpdateProcessDefinitionSuspensionStateSelectBuilder |
updateProcessDefinitionSuspensionState()
Activate or suspend process definitions using a fluent builder.
|
getCommandExecutor, setCommandExecutorprotected Charset deploymentCharset
public Charset getDeploymentCharset()
public void setDeploymentCharset(Charset deploymentCharset)
public DeploymentBuilder createDeployment()
RepositoryServicecreateDeployment in interface RepositoryServicepublic ProcessApplicationDeploymentBuilder createDeployment(ProcessApplicationReference processApplication)
RepositoryServiceProcessApplicationDeployment.createDeployment in interface RepositoryServiceProcessApplicationDeploymentBuilderpublic DeploymentWithDefinitions deployWithResult(DeploymentBuilderImpl deploymentBuilder)
public void deleteDeployment(String deploymentId)
RepositoryServicedeleteDeployment in interface RepositoryServicedeploymentId - id of the deployment, cannot be null.public void deleteDeploymentCascade(String deploymentId)
RepositoryServicedeleteDeploymentCascade in interface RepositoryServicedeploymentId - id of the deployment, cannot be null.public void deleteDeployment(String deploymentId, boolean cascade)
RepositoryServicedeleteDeployment in interface RepositoryServicedeploymentId - id of the deployment, cannot be null.public void deleteDeployment(String deploymentId, boolean cascade, boolean skipCustomListeners)
RepositoryServicedeleteDeployment in interface RepositoryServicedeploymentId - id of the deployment, cannot be null.cascade - if set to true, all process instances (including) history are deletedskipCustomListeners - if true, only the built-in ExecutionListeners
are notified with the ExecutionListener.EVENTNAME_END event.public void deleteDeployment(String deploymentId, boolean cascade, boolean skipCustomListeners, boolean skipIoMappings)
RepositoryServicedeleteDeployment in interface RepositoryServicedeploymentId - id of the deployment, cannot be null.cascade - if set to true, all process instances (including) history are deletedskipCustomListeners - if true, only the built-in ExecutionListeners
are notified with the ExecutionListener.EVENTNAME_END event.skipIoMappings - specifies whether input/output mappings for tasks should be invokedpublic void deleteProcessDefinition(String processDefinitionId)
RepositoryServiceRepositoryService.deleteProcessDefinition(java.lang.String, boolean, boolean)
Both boolean parameters of this method are per default false. The deletion is
in this case not cascading.deleteProcessDefinition in interface RepositoryServiceprocessDefinitionId - the id, which corresponds to the process definitionRepositoryService.deleteProcessDefinition(java.lang.String, boolean, boolean)public void deleteProcessDefinition(String processDefinitionId, boolean cascade)
RepositoryServiceRepositoryService.deleteProcessDefinition(java.lang.String, boolean, boolean)
The skipCustomListeners parameter is per default false. The custom listeners are called
if the cascading flag is set to true and the process instances are deleted.deleteProcessDefinition in interface RepositoryServiceprocessDefinitionId - the id, which corresponds to the process definitioncascade - if set to true, all process instances (including) history are deletedRepositoryService.deleteProcessDefinition(java.lang.String, boolean, boolean)public void deleteProcessDefinition(String processDefinitionId, boolean cascade, boolean skipCustomListeners)
RepositoryServicedeleteProcessDefinition in interface RepositoryServiceprocessDefinitionId - the id, which corresponds to the process definitioncascade - if set to true, all process instances (including) history are deletedskipCustomListeners - if true, only the built-in ExecutionListeners
are notified with the ExecutionListener.EVENTNAME_END event.
Is only used if cascade set to true.public void deleteProcessDefinition(String processDefinitionId, boolean cascade, boolean skipCustomListeners, boolean skipIoMappings)
RepositoryServicedeleteProcessDefinition in interface RepositoryServiceprocessDefinitionId - the id, which corresponds to the process definitioncascade - if set to true, all process instances (including) history are deletedskipCustomListeners - if true, only the built-in ExecutionListeners
are notified with the ExecutionListener.EVENTNAME_END event.
Is only used if cascade set to true.skipIoMappings - Specifies whether input/output mappings for tasks should be invokedpublic DeleteProcessDefinitionsSelectBuilder deleteProcessDefinitions()
RepositoryServicedeleteProcessDefinitions in interface RepositoryServicepublic ProcessDefinitionQuery createProcessDefinitionQuery()
RepositoryServicecreateProcessDefinitionQuery in interface RepositoryServicepublic CaseDefinitionQuery createCaseDefinitionQuery()
RepositoryServicecreateCaseDefinitionQuery in interface RepositoryServicepublic DecisionDefinitionQuery createDecisionDefinitionQuery()
RepositoryServicecreateDecisionDefinitionQuery in interface RepositoryServicepublic DecisionRequirementsDefinitionQuery createDecisionRequirementsDefinitionQuery()
RepositoryServicecreateDecisionRequirementsDefinitionQuery in interface RepositoryServicepublic List<String> getDeploymentResourceNames(String deploymentId)
RepositoryServicegetDeploymentResourceNames in interface RepositoryServicedeploymentId - id of the deployment, cannot be null.public List<Resource> getDeploymentResources(String deploymentId)
RepositoryServicegetDeploymentResources in interface RepositoryServicedeploymentId - id of the deployment, cannot be null.public InputStream getResourceAsStream(String deploymentId, String resourceName)
RepositoryServicegetResourceAsStream in interface RepositoryServicedeploymentId - id of the deployment, cannot be null.resourceName - name of the resource, cannot be null.public InputStream getResourceAsStreamById(String deploymentId, String resourceId)
RepositoryServicegetResourceAsStreamById in interface RepositoryServicedeploymentId - id of the deployment, cannot be null.resourceId - id of the resource, cannot be null.public DeploymentQuery createDeploymentQuery()
RepositoryServicecreateDeploymentQuery in interface RepositoryServicepublic ProcessDefinition getProcessDefinition(String processDefinitionId)
RepositoryServiceProcessDefinition including all BPMN information like additional
Properties (e.g. documentation).getProcessDefinition in interface RepositoryServicepublic ReadOnlyProcessDefinition getDeployedProcessDefinition(String processDefinitionId)
public void suspendProcessDefinitionById(String processDefinitionId)
RepositoryServiceNote: for more complex suspend commands use RepositoryService.updateProcessDefinitionSuspensionState().
suspendProcessDefinitionById in interface RepositoryServicepublic void suspendProcessDefinitionById(String processDefinitionId, boolean suspendProcessInstances, Date suspensionDate)
RepositoryServiceNote: for more complex suspend commands use RepositoryService.updateProcessDefinitionSuspensionState().
suspendProcessDefinitionById in interface RepositoryServicesuspendProcessInstances - If true, all the process instances of the provided process definition
will be suspended too.suspensionDate - The date on which the process definition will be suspended. If null, the
process definition is suspended immediately.
Note: The job executor needs to be active to use this!RuntimeService.suspendProcessInstanceById(String)public void suspendProcessDefinitionByKey(String processDefinitionKey)
RepositoryServiceNote: for more complex suspend commands use RepositoryService.updateProcessDefinitionSuspensionState().
suspendProcessDefinitionByKey in interface RepositoryServicepublic void suspendProcessDefinitionByKey(String processDefinitionKey, boolean suspendProcessInstances, Date suspensionDate)
RepositoryServiceNote: for more complex suspend commands use RepositoryService.updateProcessDefinitionSuspensionState().
suspendProcessDefinitionByKey in interface RepositoryServicesuspendProcessInstances - If true, all the process instances of the provided process definition
will be suspended too.suspensionDate - The date on which the process definition will be suspended. If null, the
process definition is suspended immediately.
Note: The job executor needs to be active to use this!RuntimeService.suspendProcessInstanceById(String)public void activateProcessDefinitionById(String processDefinitionId)
RepositoryServiceNote: for more complex activate commands use RepositoryService.updateProcessDefinitionSuspensionState().
activateProcessDefinitionById in interface RepositoryServicepublic void activateProcessDefinitionById(String processDefinitionId, boolean activateProcessInstances, Date activationDate)
RepositoryServiceNote: for more complex activate commands use RepositoryService.updateProcessDefinitionSuspensionState().
activateProcessDefinitionById in interface RepositoryServiceactivationDate - The date on which the process definition will be activated. If null, the
process definition is suspended immediately.
Note: The job executor needs to be active to use this!RuntimeService.activateProcessInstanceById(String)public void activateProcessDefinitionByKey(String processDefinitionKey)
RepositoryServiceNote: for more complex activate commands use RepositoryService.updateProcessDefinitionSuspensionState().
activateProcessDefinitionByKey in interface RepositoryServicepublic void activateProcessDefinitionByKey(String processDefinitionKey, boolean activateProcessInstances, Date activationDate)
RepositoryServiceNote: for more complex activate commands use RepositoryService.updateProcessDefinitionSuspensionState().
activateProcessDefinitionByKey in interface RepositoryServiceactivationDate - The date on which the process definition will be activated. If null, the
process definition is suspended immediately.
Note: The job executor needs to be active to use this!RuntimeService.activateProcessInstanceById(String)public UpdateProcessDefinitionSuspensionStateSelectBuilder updateProcessDefinitionSuspensionState()
RepositoryServiceUpdateProcessDefinitionSuspensionStateBuilder.activate() or
UpdateProcessDefinitionSuspensionStateBuilder.suspend().updateProcessDefinitionSuspensionState in interface RepositoryServicepublic void updateProcessDefinitionHistoryTimeToLive(String processDefinitionId, Integer historyTimeToLive)
RepositoryServiceupdateProcessDefinitionHistoryTimeToLive in interface RepositoryServicepublic void updateDecisionDefinitionHistoryTimeToLive(String decisionDefinitionId, Integer historyTimeToLive)
RepositoryServiceupdateDecisionDefinitionHistoryTimeToLive in interface RepositoryServicepublic void updateCaseDefinitionHistoryTimeToLive(String caseDefinitionId, Integer historyTimeToLive)
RepositoryServiceupdateCaseDefinitionHistoryTimeToLive in interface RepositoryServicepublic InputStream getProcessModel(String processDefinitionId)
RepositoryServicegetProcessModel in interface RepositoryServiceprocessDefinitionId - id of a ProcessDefinition, cannot be null.public InputStream getProcessDiagram(String processDefinitionId)
RepositoryServicegetProcessDiagram in interface RepositoryServiceprocessDefinitionId - id of a ProcessDefinition, cannot be null.ProcessDefinition is null.public InputStream getCaseDiagram(String caseDefinitionId)
RepositoryServicegetCaseDiagram in interface RepositoryServicecaseDefinitionId - id of a CaseDefinition, cannot be null.CaseDefinition is null.public DiagramLayout getProcessDiagramLayout(String processDefinitionId)
RepositoryServiceRepositoryService.getProcessDiagram(String).
This method requires a process model and a diagram image to be deployed.getProcessDiagramLayout in interface RepositoryServiceprocessDefinitionId - id of a ProcessDefinition, cannot be null.public BpmnModelInstance getBpmnModelInstance(String processDefinitionId)
RepositoryServiceBpmnModelInstance for the given processDefinitionId.getBpmnModelInstance in interface RepositoryServiceprocessDefinitionId - the id of the Process Definition for which the BpmnModelInstance
should be retrieved.BpmnModelInstancepublic CmmnModelInstance getCmmnModelInstance(String caseDefinitionId)
RepositoryServiceCmmnModelInstance for the given caseDefinitionId.getCmmnModelInstance in interface RepositoryServicecaseDefinitionId - the id of the Case Definition for which the CmmnModelInstance
should be retrieved.CmmnModelInstancepublic DmnModelInstance getDmnModelInstance(String decisionDefinitionId)
RepositoryServiceDmnModelInstance for the given decisionDefinitionId.getDmnModelInstance in interface RepositoryServicedecisionDefinitionId - the id of the Decision Definition for which the DmnModelInstance
should be retrieved.DmnModelInstancepublic void addCandidateStarterUser(String processDefinitionId, String userId)
RepositoryServiceaddCandidateStarterUser in interface RepositoryServiceprocessDefinitionId - id of the process definition, cannot be null.userId - id of the user involve, cannot be null.public void addCandidateStarterGroup(String processDefinitionId, String groupId)
RepositoryServiceaddCandidateStarterGroup in interface RepositoryServiceprocessDefinitionId - id of the process definition, cannot be null.groupId - id of the group involve, cannot be null.public void deleteCandidateStarterGroup(String processDefinitionId, String groupId)
RepositoryServicedeleteCandidateStarterGroup in interface RepositoryServiceprocessDefinitionId - id of the process definition, cannot be null.groupId - id of the group involve, cannot be null.public void deleteCandidateStarterUser(String processDefinitionId, String userId)
RepositoryServicedeleteCandidateStarterUser in interface RepositoryServiceprocessDefinitionId - id of the process definition, cannot be null.userId - id of the user involve, cannot be null.public List<IdentityLink> getIdentityLinksForProcessDefinition(String processDefinitionId)
RepositoryServiceIdentityLinks associated with the given process definition.
Such an IdentityLink informs how a certain identity (eg. group or user)
is authorized for a certain process definitiongetIdentityLinksForProcessDefinition in interface RepositoryServicepublic CaseDefinition getCaseDefinition(String caseDefinitionId)
RepositoryServiceCaseDefinition.getCaseDefinition in interface RepositoryServicepublic InputStream getCaseModel(String caseDefinitionId)
RepositoryServicegetCaseModel in interface RepositoryServicecaseDefinitionId - id of a CaseDefinition, cannot be null.public DecisionDefinition getDecisionDefinition(String decisionDefinitionId)
RepositoryServiceDecisionDefinition.getDecisionDefinition in interface RepositoryServicepublic DecisionRequirementsDefinition getDecisionRequirementsDefinition(String decisionRequirementsDefinitionId)
RepositoryServiceDecisionRequirementsDefinition.getDecisionRequirementsDefinition in interface RepositoryServicepublic InputStream getDecisionModel(String decisionDefinitionId)
RepositoryServicegetDecisionModel in interface RepositoryServicedecisionDefinitionId - id of a DecisionDefinition, cannot be null.public InputStream getDecisionRequirementsModel(String decisionRequirementsDefinitionId)
RepositoryServicegetDecisionRequirementsModel in interface RepositoryServicedecisionRequirementsDefinitionId - id of a DecisionRequirementsDefinition, cannot be null.public InputStream getDecisionDiagram(String decisionDefinitionId)
RepositoryServicegetDecisionDiagram in interface RepositoryServicedecisionDefinitionId - id of a DecisionDefinition, cannot be null.DecisionDefinition is null.public InputStream getDecisionRequirementsDiagram(String decisionRequirementsDefinitionId)
RepositoryServicegetDecisionRequirementsDiagram in interface RepositoryServicedecisionRequirementsDefinitionId - id of a DecisionRequirementsDefinition, cannot be null.DecisionRequirementsDefinition is null.Copyright © 2021. All rights reserved.