Package org.camunda.bpm.engine.impl

Class RepositoryServiceImpl

java.lang.Object

org.camunda.bpm.engine.impl.ServiceImpl

org.camunda.bpm.engine.impl.RepositoryServiceImpl

All Implemented Interfaces:

RepositoryService

public class RepositoryServiceImpl
extends ServiceImpl
implements RepositoryService

Author:

Tom Baeyens, Falko Menge, Joram Barrez

Field Summary

Fields

Modifier and Type	Field	Description
protected java.nio.charset.Charset	deploymentCharset

Fields inherited from class org.camunda.bpm.engine.impl.ServiceImpl

commandExecutor

Constructor Summary

Constructors

Constructor	Description
RepositoryServiceImpl()

Method Summary

Modifier and Type	Method	Description
void	activateProcessDefinitionById(java.lang.String processDefinitionId)	Activates the process definition with the given id.
void	activateProcessDefinitionById(java.lang.String processDefinitionId, boolean activateProcessInstances, java.util.Date activationDate)	Activates the process definition with the given id.
void	activateProcessDefinitionByKey(java.lang.String processDefinitionKey)	Activates the process definition with the given key (=id in the bpmn20.xml file).
void	activateProcessDefinitionByKey(java.lang.String processDefinitionKey, boolean activateProcessInstances, java.util.Date activationDate)	Activates the process definition with the given key (=id in the bpmn20.xml file).
void	addCandidateStarterGroup(java.lang.String processDefinitionId, java.lang.String groupId)	Authorizes a candidate group for a process definition.
void	addCandidateStarterUser(java.lang.String processDefinitionId, java.lang.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(java.lang.String processDefinitionId, java.lang.String groupId)	Removes the authorization of a candidate group for a process definition.
void	deleteCandidateStarterUser(java.lang.String processDefinitionId, java.lang.String userId)	Removes the authorization of a candidate user for a process definition.
void	deleteDeployment(java.lang.String deploymentId)	Deletes the given deployment.
void	deleteDeployment(java.lang.String deploymentId, boolean cascade)	Deletes the given deployment and cascade deletion to process instances, history process instances and jobs.
void	deleteDeployment(java.lang.String deploymentId, boolean cascade, boolean skipCustomListeners)	Deletes the given deployment and cascade deletion to process instances, history process instances and jobs.
void	deleteDeployment(java.lang.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(java.lang.String deploymentId)	Deletes the given deployment and cascade deletion to process instances, history process instances and jobs.
void	deleteProcessDefinition(java.lang.String processDefinitionId)	Deletes the process definition which belongs to the given process definition id.
void	deleteProcessDefinition(java.lang.String processDefinitionId, boolean cascade)	Deletes the process definition which belongs to the given process definition id.
void	deleteProcessDefinition(java.lang.String processDefinitionId, boolean cascade, boolean skipCustomListeners)	Deletes the process definition which belongs to the given process definition id.
void	deleteProcessDefinition(java.lang.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(java.lang.String processDefinitionId)	Returns the BpmnModelInstance for the given processDefinitionId.
CaseDefinition	getCaseDefinition(java.lang.String caseDefinitionId)	Returns the CaseDefinition.
java.io.InputStream	getCaseDiagram(java.lang.String caseDefinitionId)	Gives access to a deployed case diagram, e.g., a PNG image, through a stream of bytes.
java.io.InputStream	getCaseModel(java.lang.String caseDefinitionId)	Gives access to a deployed case model, e.g., a CMMN 1.0 XML file, through a stream of bytes.
CmmnModelInstance	getCmmnModelInstance(java.lang.String caseDefinitionId)	Returns the CmmnModelInstance for the given caseDefinitionId.
DecisionDefinition	getDecisionDefinition(java.lang.String decisionDefinitionId)	Returns the DecisionDefinition.
java.io.InputStream	getDecisionDiagram(java.lang.String decisionDefinitionId)	Gives access to a deployed decision diagram, e.g., a PNG image, through a stream of bytes.
java.io.InputStream	getDecisionModel(java.lang.String decisionDefinitionId)	Gives access to a deployed decision model, e.g., a DMN 1.1 XML file, through a stream of bytes.
DecisionRequirementsDefinition	getDecisionRequirementsDefinition(java.lang.String decisionRequirementsDefinitionId)	Returns the DecisionRequirementsDefinition.
java.io.InputStream	getDecisionRequirementsDiagram(java.lang.String decisionRequirementsDefinitionId)	Gives access to a deployed decision requirements diagram, e.g., a PNG image, through a stream of bytes.
java.io.InputStream	getDecisionRequirementsModel(java.lang.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(java.lang.String processDefinitionId)
java.nio.charset.Charset	getDeploymentCharset()
java.util.List<java.lang.String>	getDeploymentResourceNames(java.lang.String deploymentId)	Retrieves a list of deployment resource names for the given deployment, ordered alphabetically.
java.util.List<Resource>	getDeploymentResources(java.lang.String deploymentId)	Retrieves a list of deployment resources for the given deployment, ordered alphabetically by name.
DmnModelInstance	getDmnModelInstance(java.lang.String decisionDefinitionId)	Returns the DmnModelInstance for the given decisionDefinitionId.
java.util.List<IdentityLink>	getIdentityLinksForProcessDefinition(java.lang.String processDefinitionId)	Retrieves the IdentityLinks associated with the given process definition.
ProcessDefinition	getProcessDefinition(java.lang.String processDefinitionId)	Returns the ProcessDefinition including all BPMN information like additional Properties (e.g.
java.io.InputStream	getProcessDiagram(java.lang.String processDefinitionId)	Gives access to a deployed process diagram, e.g., a PNG image, through a stream of bytes.
DiagramLayout	getProcessDiagramLayout(java.lang.String processDefinitionId)	Provides positions and dimensions of elements in a process diagram as provided by RepositoryService.getProcessDiagram(String).
java.io.InputStream	getProcessModel(java.lang.String processDefinitionId)	Gives access to a deployed process model, e.g., a BPMN 2.0 XML file, through a stream of bytes.
java.io.InputStream	getResourceAsStream(java.lang.String deploymentId, java.lang.String resourceName)	Gives access to a deployment resource through a stream of bytes.
java.io.InputStream	getResourceAsStreamById(java.lang.String deploymentId, java.lang.String resourceId)	Gives access to a deployment resource through a stream of bytes.
java.util.Collection<CalledProcessDefinition>	getStaticCalledProcessDefinitions(java.lang.String processDefinitionId)	For the given process, returns a list of CalledProcessDefinition.
void	setDeploymentCharset(java.nio.charset.Charset deploymentCharset)
void	suspendProcessDefinitionById(java.lang.String processDefinitionId)	Suspends the process definition with the given id.
void	suspendProcessDefinitionById(java.lang.String processDefinitionId, boolean suspendProcessInstances, java.util.Date suspensionDate)	Suspends the process definition with the given id.
void	suspendProcessDefinitionByKey(java.lang.String processDefinitionKey)	Suspends the all process definitions with the given key (= id in the bpmn20.xml file).
void	suspendProcessDefinitionByKey(java.lang.String processDefinitionKey, boolean suspendProcessInstances, java.util.Date suspensionDate)	Suspends the all process definitions with the given key (= id in the bpmn20.xml file).
void	updateCaseDefinitionHistoryTimeToLive(java.lang.String caseDefinitionId, java.lang.Integer historyTimeToLive)	Updates time to live of case definition.
void	updateDecisionDefinitionHistoryTimeToLive(java.lang.String decisionDefinitionId, java.lang.Integer historyTimeToLive)	Updates time to live of decision definition.
void	updateProcessDefinitionHistoryTimeToLive(java.lang.String processDefinitionId, java.lang.Integer historyTimeToLive)	Updates time to live of process definition.
UpdateProcessDefinitionSuspensionStateSelectBuilder	updateProcessDefinitionSuspensionState()	Activate or suspend process definitions using a fluent builder.

Methods inherited from class org.camunda.bpm.engine.impl.ServiceImpl

getCommandExecutor, setCommandExecutor

Methods inherited from class java.lang.Object

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

Field Detail

deploymentCharset

protected java.nio.charset.Charset deploymentCharset

Constructor Detail

RepositoryServiceImpl

public RepositoryServiceImpl()

Method Detail

getDeploymentCharset

public java.nio.charset.Charset getDeploymentCharset()

setDeploymentCharset

public void setDeploymentCharset(java.nio.charset.Charset deploymentCharset)

createDeployment

public DeploymentBuilder createDeployment()

Description copied from interface: RepositoryService

Starts creating a new deployment

Specified by:

createDeployment in interface RepositoryService

createDeployment

public ProcessApplicationDeploymentBuilder createDeployment(ProcessApplicationReference processApplication)

Description copied from interface: RepositoryService

Starts creating a new ProcessApplicationDeployment.

Specified by:

createDeployment in interface RepositoryService

See Also:

ProcessApplicationDeploymentBuilder

deployWithResult

public DeploymentWithDefinitions deployWithResult(DeploymentBuilderImpl deploymentBuilder)

deleteDeployment

public void deleteDeployment(java.lang.String deploymentId)

Description copied from interface: RepositoryService

Deletes the given deployment.

Specified by:

deleteDeployment in interface RepositoryService

Parameters:

deploymentId - id of the deployment, cannot be null.

deleteDeploymentCascade

public void deleteDeploymentCascade(java.lang.String deploymentId)

Description copied from interface: RepositoryService

Deletes the given deployment and cascade deletion to process instances, history process instances and jobs.

Specified by:

deleteDeploymentCascade in interface RepositoryService

Parameters:

deploymentId - id of the deployment, cannot be null.

deleteDeployment

public void deleteDeployment(java.lang.String deploymentId,
                             boolean cascade)

Description copied from interface: RepositoryService

Deletes the given deployment and cascade deletion to process instances, history process instances and jobs.

Specified by:

deleteDeployment in interface RepositoryService

Parameters:

deploymentId - id of the deployment, cannot be null.

deleteDeployment

public void deleteDeployment(java.lang.String deploymentId,
                             boolean cascade,
                             boolean skipCustomListeners)

Description copied from interface: RepositoryService

Deletes the given deployment and cascade deletion to process instances, history process instances and jobs.

Specified by:

deleteDeployment in interface RepositoryService

Parameters:

deploymentId - id of the deployment, cannot be null.

cascade - if set to true, all process instances (including) history are deleted

skipCustomListeners - if true, only the built-in ExecutionListeners are notified with the ExecutionListener.EVENTNAME_END event.

deleteDeployment

public void deleteDeployment(java.lang.String deploymentId,
                             boolean cascade,
                             boolean skipCustomListeners,
                             boolean skipIoMappings)

Description copied from interface: RepositoryService

Deletes the given deployment and cascade deletion to process instances, history process instances and jobs.

Specified by:

deleteDeployment in interface RepositoryService

Parameters:

deploymentId - id of the deployment, cannot be null.

cascade - if set to true, all process instances (including) history are deleted

skipCustomListeners - 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 invoked

deleteProcessDefinition

public void deleteProcessDefinition(java.lang.String processDefinitionId)

Description copied from interface: RepositoryService

Deletes the process definition which belongs to the given process definition id. Same behavior as RepositoryService.deleteProcessDefinition(java.lang.String, boolean, boolean) Both boolean parameters of this method are per default false. The deletion is in this case not cascading.

Specified by:

deleteProcessDefinition in interface RepositoryService

Parameters:

processDefinitionId - the id, which corresponds to the process definition

See Also:

RepositoryService.deleteProcessDefinition(java.lang.String, boolean, boolean)

deleteProcessDefinition

public void deleteProcessDefinition(java.lang.String processDefinitionId,
                                    boolean cascade)

Description copied from interface: RepositoryService

Deletes the process definition which belongs to the given process definition id. Cascades the deletion if the cascade is set to true. Same behavior as RepositoryService.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.

Specified by:

deleteProcessDefinition in interface RepositoryService

Parameters:

processDefinitionId - the id, which corresponds to the process definition

cascade - if set to true, all process instances (including) history are deleted

See Also:

RepositoryService.deleteProcessDefinition(java.lang.String, boolean, boolean)

deleteProcessDefinition

public void deleteProcessDefinition(java.lang.String processDefinitionId,
                                    boolean cascade,
                                    boolean skipCustomListeners)

Description copied from interface: RepositoryService

Deletes the process definition which belongs to the given process definition id. Cascades the deletion if the cascade is set to true the custom listener can be skipped if the third parameter is set to true.

Specified by:

deleteProcessDefinition in interface RepositoryService

Parameters:

processDefinitionId - the id, which corresponds to the process definition

cascade - if set to true, all process instances (including) history are deleted

skipCustomListeners - if true, only the built-in ExecutionListeners are notified with the ExecutionListener.EVENTNAME_END event. Is only used if cascade set to true.

deleteProcessDefinition

public void deleteProcessDefinition(java.lang.String processDefinitionId,
                                    boolean cascade,
                                    boolean skipCustomListeners,
                                    boolean skipIoMappings)

Description copied from interface: RepositoryService

Deletes the process definition which belongs to the given process definition id. Cascades the deletion if the cascade is set to true, the custom listener can be skipped if the third parameter is set to true, io mappings can be skipped if the forth parameter is set to true.

Specified by:

deleteProcessDefinition in interface RepositoryService

Parameters:

processDefinitionId - the id, which corresponds to the process definition

cascade - if set to true, all process instances (including) history are deleted

skipCustomListeners - 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 invoked

deleteProcessDefinitions

public DeleteProcessDefinitionsSelectBuilder deleteProcessDefinitions()

Description copied from interface: RepositoryService

Fluent builder to delete process definitions.

Specified by:

deleteProcessDefinitions in interface RepositoryService

Returns:

the builder to delete process definitions

createProcessDefinitionQuery

public ProcessDefinitionQuery createProcessDefinitionQuery()

Description copied from interface: RepositoryService

Query process definitions.

Specified by:

createProcessDefinitionQuery in interface RepositoryService

createCaseDefinitionQuery

public CaseDefinitionQuery createCaseDefinitionQuery()

Description copied from interface: RepositoryService

Query case definitions.

Specified by:

createCaseDefinitionQuery in interface RepositoryService

createDecisionDefinitionQuery

public DecisionDefinitionQuery createDecisionDefinitionQuery()

Description copied from interface: RepositoryService

Query decision definitions.

Specified by:

createDecisionDefinitionQuery in interface RepositoryService

createDecisionRequirementsDefinitionQuery

public DecisionRequirementsDefinitionQuery createDecisionRequirementsDefinitionQuery()

Description copied from interface: RepositoryService

Query decision requirements definition.

Specified by:

createDecisionRequirementsDefinitionQuery in interface RepositoryService

getDeploymentResourceNames

public java.util.List<java.lang.String> getDeploymentResourceNames(java.lang.String deploymentId)

Description copied from interface: RepositoryService

Retrieves a list of deployment resource names for the given deployment, ordered alphabetically.

Specified by:

getDeploymentResourceNames in interface RepositoryService

Parameters:

deploymentId - id of the deployment, cannot be null.

getDeploymentResources

public java.util.List<Resource> getDeploymentResources(java.lang.String deploymentId)

Description copied from interface: RepositoryService

Retrieves a list of deployment resources for the given deployment, ordered alphabetically by name.

Specified by:

getDeploymentResources in interface RepositoryService

Parameters:

deploymentId - id of the deployment, cannot be null.

getResourceAsStream

public java.io.InputStream getResourceAsStream(java.lang.String deploymentId,
                                               java.lang.String resourceName)

Description copied from interface: RepositoryService

Gives access to a deployment resource through a stream of bytes.

Specified by:

getResourceAsStream in interface RepositoryService

Parameters:

deploymentId - id of the deployment, cannot be null.

resourceName - name of the resource, cannot be null.

getResourceAsStreamById

public java.io.InputStream getResourceAsStreamById(java.lang.String deploymentId,
                                                   java.lang.String resourceId)

Description copied from interface: RepositoryService

Gives access to a deployment resource through a stream of bytes.

Specified by:

getResourceAsStreamById in interface RepositoryService

Parameters:

deploymentId - id of the deployment, cannot be null.

resourceId - id of the resource, cannot be null.

createDeploymentQuery

public DeploymentQuery createDeploymentQuery()

Description copied from interface: RepositoryService

Query process definitions.

Specified by:

createDeploymentQuery in interface RepositoryService

getProcessDefinition

public ProcessDefinition getProcessDefinition(java.lang.String processDefinitionId)

Description copied from interface: RepositoryService

Returns the ProcessDefinition including all BPMN information like additional Properties (e.g. documentation).

Specified by:

getProcessDefinition in interface RepositoryService

getDeployedProcessDefinition

public ReadOnlyProcessDefinition getDeployedProcessDefinition(java.lang.String processDefinitionId)

suspendProcessDefinitionById

public void suspendProcessDefinitionById(java.lang.String processDefinitionId)

Description copied from interface: RepositoryService

Suspends the process definition with the given id. If a process definition is in state suspended, it will not be possible to start new process instances based on the process definition. Note: all the process instances of the process definition will still be active (ie. not suspended)!

Note: for more complex suspend commands use RepositoryService.updateProcessDefinitionSuspensionState().

Specified by:

suspendProcessDefinitionById in interface RepositoryService

suspendProcessDefinitionById

public void suspendProcessDefinitionById(java.lang.String processDefinitionId,
                                         boolean suspendProcessInstances,
                                         java.util.Date suspensionDate)

Description copied from interface: RepositoryService

Suspends the process definition with the given id. If a process definition is in state suspended, it will not be possible to start new process instances based on the process definition.

Note: for more complex suspend commands use RepositoryService.updateProcessDefinitionSuspensionState().

Specified by:

suspendProcessDefinitionById in interface RepositoryService

suspendProcessInstances - 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!

See Also:

RuntimeService.suspendProcessInstanceById(String)

suspendProcessDefinitionByKey

public void suspendProcessDefinitionByKey(java.lang.String processDefinitionKey)

Description copied from interface: RepositoryService

Suspends the all process definitions with the given key (= id in the bpmn20.xml file). If a process definition is in state suspended, it will not be possible to start new process instances based on the process definition. Note: all the process instances of the process definition will still be active (ie. not suspended)!

Note: for more complex suspend commands use RepositoryService.updateProcessDefinitionSuspensionState().

Specified by:

suspendProcessDefinitionByKey in interface RepositoryService

suspendProcessDefinitionByKey

public void suspendProcessDefinitionByKey(java.lang.String processDefinitionKey,
                                          boolean suspendProcessInstances,
                                          java.util.Date suspensionDate)

Description copied from interface: RepositoryService

Suspends the all process definitions with the given key (= id in the bpmn20.xml file). If a process definition is in state suspended, it will not be possible to start new process instances based on the process definition.

Note: for more complex suspend commands use RepositoryService.updateProcessDefinitionSuspensionState().

Specified by:

suspendProcessDefinitionByKey in interface RepositoryService

suspendProcessInstances - 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!

See Also:

RuntimeService.suspendProcessInstanceById(String)

activateProcessDefinitionById

public void activateProcessDefinitionById(java.lang.String processDefinitionId)

Description copied from interface: RepositoryService

Activates the process definition with the given id.

Note: for more complex activate commands use RepositoryService.updateProcessDefinitionSuspensionState().

Specified by:

activateProcessDefinitionById in interface RepositoryService

activateProcessDefinitionById

public void activateProcessDefinitionById(java.lang.String processDefinitionId,
                                          boolean activateProcessInstances,
                                          java.util.Date activationDate)

Description copied from interface: RepositoryService

Activates the process definition with the given id.

Note: for more complex activate commands use RepositoryService.updateProcessDefinitionSuspensionState().

Specified by:

activateProcessDefinitionById in interface RepositoryService

activationDate - 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!

See Also:

RuntimeService.activateProcessInstanceById(String)

activateProcessDefinitionByKey

public void activateProcessDefinitionByKey(java.lang.String processDefinitionKey)

Description copied from interface: RepositoryService

Activates the process definition with the given key (=id in the bpmn20.xml file).

Note: for more complex activate commands use RepositoryService.updateProcessDefinitionSuspensionState().

Specified by:

activateProcessDefinitionByKey in interface RepositoryService

activateProcessDefinitionByKey

public void activateProcessDefinitionByKey(java.lang.String processDefinitionKey,
                                           boolean activateProcessInstances,
                                           java.util.Date activationDate)

Description copied from interface: RepositoryService

Activates the process definition with the given key (=id in the bpmn20.xml file).

Note: for more complex activate commands use RepositoryService.updateProcessDefinitionSuspensionState().

Specified by:

activateProcessDefinitionByKey in interface RepositoryService

activationDate - 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!

See Also:

RuntimeService.activateProcessInstanceById(String)

updateProcessDefinitionSuspensionState

public UpdateProcessDefinitionSuspensionStateSelectBuilder updateProcessDefinitionSuspensionState()

Description copied from interface: RepositoryService

Activate or suspend process definitions using a fluent builder. Specify the definitions by calling one of the by methods, like byProcessDefinitionId. To update the suspension state call UpdateProcessDefinitionSuspensionStateBuilder.activate() or UpdateProcessDefinitionSuspensionStateBuilder.suspend().

Specified by:

updateProcessDefinitionSuspensionState in interface RepositoryService

Returns:

the builder to update the suspension state

updateProcessDefinitionHistoryTimeToLive

public void updateProcessDefinitionHistoryTimeToLive(java.lang.String processDefinitionId,
                                                     java.lang.Integer historyTimeToLive)

Description copied from interface: RepositoryService

Updates time to live of process definition. The field is used within history cleanup process.

Specified by:

updateProcessDefinitionHistoryTimeToLive in interface RepositoryService

updateDecisionDefinitionHistoryTimeToLive

public void updateDecisionDefinitionHistoryTimeToLive(java.lang.String decisionDefinitionId,
                                                      java.lang.Integer historyTimeToLive)

Description copied from interface: RepositoryService

Updates time to live of decision definition. The field is used within history cleanup process.

Specified by:

updateDecisionDefinitionHistoryTimeToLive in interface RepositoryService

updateCaseDefinitionHistoryTimeToLive

public void updateCaseDefinitionHistoryTimeToLive(java.lang.String caseDefinitionId,
                                                  java.lang.Integer historyTimeToLive)

Description copied from interface: RepositoryService

Updates time to live of case definition. The field is used within history cleanup process.

Specified by:

updateCaseDefinitionHistoryTimeToLive in interface RepositoryService

getProcessModel

public java.io.InputStream getProcessModel(java.lang.String processDefinitionId)

Description copied from interface: RepositoryService

Gives access to a deployed process model, e.g., a BPMN 2.0 XML file, through a stream of bytes.

Specified by:

getProcessModel in interface RepositoryService

Parameters:

processDefinitionId - id of a ProcessDefinition, cannot be null.

getProcessDiagram

public java.io.InputStream getProcessDiagram(java.lang.String processDefinitionId)

Description copied from interface: RepositoryService

Gives access to a deployed process diagram, e.g., a PNG image, through a stream of bytes.

Specified by:

getProcessDiagram in interface RepositoryService

Parameters:

processDefinitionId - id of a ProcessDefinition, cannot be null.

Returns:

null when the diagram resource name of a ProcessDefinition is null.

getCaseDiagram

public java.io.InputStream getCaseDiagram(java.lang.String caseDefinitionId)

Description copied from interface: RepositoryService

Gives access to a deployed case diagram, e.g., a PNG image, through a stream of bytes.

Specified by:

getCaseDiagram in interface RepositoryService

Parameters:

caseDefinitionId - id of a CaseDefinition, cannot be null.

Returns:

null when the diagram resource name of a CaseDefinition is null.

getProcessDiagramLayout

public DiagramLayout getProcessDiagramLayout(java.lang.String processDefinitionId)

Description copied from interface: RepositoryService

Provides positions and dimensions of elements in a process diagram as provided by RepositoryService.getProcessDiagram(String). This method requires a process model and a diagram image to be deployed.

Specified by:

getProcessDiagramLayout in interface RepositoryService

Parameters:

processDefinitionId - id of a ProcessDefinition, cannot be null.

Returns:

Map with process element ids as keys and positions and dimensions as values.

getBpmnModelInstance

public BpmnModelInstance getBpmnModelInstance(java.lang.String processDefinitionId)

Description copied from interface: RepositoryService

Returns the BpmnModelInstance for the given processDefinitionId.

Specified by:

getBpmnModelInstance in interface RepositoryService

Parameters:

processDefinitionId - the id of the Process Definition for which the BpmnModelInstance should be retrieved.

Returns:

the BpmnModelInstance

getCmmnModelInstance

public CmmnModelInstance getCmmnModelInstance(java.lang.String caseDefinitionId)

Description copied from interface: RepositoryService

Returns the CmmnModelInstance for the given caseDefinitionId.

Specified by:

getCmmnModelInstance in interface RepositoryService

Parameters:

caseDefinitionId - the id of the Case Definition for which the CmmnModelInstance should be retrieved.

Returns:

the CmmnModelInstance

getDmnModelInstance

public DmnModelInstance getDmnModelInstance(java.lang.String decisionDefinitionId)

Description copied from interface: RepositoryService

Returns the DmnModelInstance for the given decisionDefinitionId.

Specified by:

getDmnModelInstance in interface RepositoryService

Parameters:

decisionDefinitionId - the id of the Decision Definition for which the DmnModelInstance should be retrieved.

Returns:

the DmnModelInstance

addCandidateStarterUser

public void addCandidateStarterUser(java.lang.String processDefinitionId,
                                    java.lang.String userId)

Description copied from interface: RepositoryService

Authorizes a candidate user for a process definition.

Specified by:

addCandidateStarterUser in interface RepositoryService

Parameters:

processDefinitionId - id of the process definition, cannot be null.

userId - id of the user involve, cannot be null.

addCandidateStarterGroup

public void addCandidateStarterGroup(java.lang.String processDefinitionId,
                                     java.lang.String groupId)

Description copied from interface: RepositoryService

Authorizes a candidate group for a process definition.

Specified by:

addCandidateStarterGroup in interface RepositoryService

Parameters:

processDefinitionId - id of the process definition, cannot be null.

groupId - id of the group involve, cannot be null.

deleteCandidateStarterGroup

public void deleteCandidateStarterGroup(java.lang.String processDefinitionId,
                                        java.lang.String groupId)

Description copied from interface: RepositoryService

Removes the authorization of a candidate group for a process definition.

Specified by:

deleteCandidateStarterGroup in interface RepositoryService

Parameters:

processDefinitionId - id of the process definition, cannot be null.

groupId - id of the group involve, cannot be null.

deleteCandidateStarterUser

public void deleteCandidateStarterUser(java.lang.String processDefinitionId,
                                       java.lang.String userId)

Description copied from interface: RepositoryService

Removes the authorization of a candidate user for a process definition.

Specified by:

deleteCandidateStarterUser in interface RepositoryService

Parameters:

processDefinitionId - id of the process definition, cannot be null.

userId - id of the user involve, cannot be null.

getIdentityLinksForProcessDefinition

public java.util.List<IdentityLink> getIdentityLinksForProcessDefinition(java.lang.String processDefinitionId)

Description copied from interface: RepositoryService

Retrieves the IdentityLinks associated with the given process definition. Such an IdentityLink informs how a certain identity (eg. group or user) is authorized for a certain process definition

Specified by:

getIdentityLinksForProcessDefinition in interface RepositoryService

getCaseDefinition

public CaseDefinition getCaseDefinition(java.lang.String caseDefinitionId)

Description copied from interface: RepositoryService

Returns the CaseDefinition.

Specified by:

getCaseDefinition in interface RepositoryService

getCaseModel

public java.io.InputStream getCaseModel(java.lang.String caseDefinitionId)

Description copied from interface: RepositoryService

Gives access to a deployed case model, e.g., a CMMN 1.0 XML file, through a stream of bytes.

Specified by:

getCaseModel in interface RepositoryService

Parameters:

caseDefinitionId - id of a CaseDefinition, cannot be null.

getDecisionDefinition

public DecisionDefinition getDecisionDefinition(java.lang.String decisionDefinitionId)

Description copied from interface: RepositoryService

Returns the DecisionDefinition.

Specified by:

getDecisionDefinition in interface RepositoryService

getDecisionRequirementsDefinition

public DecisionRequirementsDefinition getDecisionRequirementsDefinition(java.lang.String decisionRequirementsDefinitionId)

Description copied from interface: RepositoryService

Returns the DecisionRequirementsDefinition.

Specified by:

getDecisionRequirementsDefinition in interface RepositoryService

getDecisionModel

public java.io.InputStream getDecisionModel(java.lang.String decisionDefinitionId)

Description copied from interface: RepositoryService

Gives access to a deployed decision model, e.g., a DMN 1.1 XML file, through a stream of bytes.

Specified by:

getDecisionModel in interface RepositoryService

Parameters:

decisionDefinitionId - id of a DecisionDefinition, cannot be null.

getDecisionRequirementsModel

public java.io.InputStream getDecisionRequirementsModel(java.lang.String decisionRequirementsDefinitionId)

Description copied from interface: RepositoryService

Gives access to a deployed decision requirements model, e.g., a DMN 1.1 XML file, through a stream of bytes.

Specified by:

getDecisionRequirementsModel in interface RepositoryService

Parameters:

decisionRequirementsDefinitionId - id of a DecisionRequirementsDefinition, cannot be null.

getDecisionDiagram

public java.io.InputStream getDecisionDiagram(java.lang.String decisionDefinitionId)

Description copied from interface: RepositoryService

Gives access to a deployed decision diagram, e.g., a PNG image, through a stream of bytes.

Specified by:

getDecisionDiagram in interface RepositoryService

Parameters:

decisionDefinitionId - id of a DecisionDefinition, cannot be null.

Returns:

null when the diagram resource name of a DecisionDefinition is null.

getDecisionRequirementsDiagram

public java.io.InputStream getDecisionRequirementsDiagram(java.lang.String decisionRequirementsDefinitionId)

Description copied from interface: RepositoryService

Gives access to a deployed decision requirements diagram, e.g., a PNG image, through a stream of bytes.

Specified by:

getDecisionRequirementsDiagram in interface RepositoryService

Parameters:

decisionRequirementsDefinitionId - id of a DecisionRequirementsDefinition, cannot be null.

Returns:

null when the diagram resource name of a DecisionRequirementsDefinition is null.

getStaticCalledProcessDefinitions

public java.util.Collection<CalledProcessDefinition> getStaticCalledProcessDefinitions(java.lang.String processDefinitionId)

Description copied from interface: RepositoryService

For the given process, returns a list of CalledProcessDefinition. The list contains all processes that are referenced statically by call activities in the given process. This method does not resolve process definitions that are referenced with expressions. Each CalledProcessDefinition contains a list of call activity ids, which specifies the call activities that are calling that process. This method does not resolve references to case definitions.

Specified by:

getStaticCalledProcessDefinitions in interface RepositoryService

Parameters:

processDefinitionId - id of a ProcessDefinition

Returns:

a list of CalledProcessDefinition.