public class RepositoryServiceImpl extends ServiceImpl implements RepositoryService
commandExecutor, processEngineConfiguration| 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 |
activateProcessDefinitionByKey(String processDefinitionKey,
boolean activateProcessInstances,
Date activationDate,
String tenantId)
Similar to
RepositoryService.activateProcessDefinitionByKey(String, boolean, Date), but only applicable for the given tenant identifier. |
void |
activateProcessDefinitionByKey(String processDefinitionKey,
String tenantId)
Similar to
RepositoryService.activateProcessDefinitionByKey(String), but only applicable for the given tenant identifier. |
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.
|
void |
addModelEditorSource(String modelId,
byte[] bytes)
Saves the model editor source for a model
|
void |
addModelEditorSourceExtra(String modelId,
byte[] bytes)
Saves the model editor source extra for a model
|
void |
changeDeploymentTenantId(String deploymentId,
String newTenantId)
EXPERIMENTAL FEATURE!
Changes the tenant identifier of a deployment to match the given tenant identifier.
|
DeploymentBuilder |
createDeployment()
Starts creating a new deployment
|
DeploymentQuery |
createDeploymentQuery()
Query deployment.
|
ModelQuery |
createModelQuery()
Query models.
|
NativeDeploymentQuery |
createNativeDeploymentQuery()
Returns a new
NativeQuery for deployment. |
NativeModelQuery |
createNativeModelQuery()
Returns a new
NativeQuery for process definitions. |
NativeProcessDefinitionQuery |
createNativeProcessDefinitionQuery()
Returns a new
NativeQuery for 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 |
deleteDeploymentCascade(String deploymentId)
Deletes the given deployment and cascade deletion to process instances,
history process instances and jobs.
|
void |
deleteModel(String modelId) |
Deployment |
deploy(DeploymentBuilderImpl deploymentBuilder) |
org.activiti.bpmn.model.BpmnModel |
getBpmnModel(String processDefinitionId)
Returns the
BpmnModel corresponding with the process definition with
the provided process definition id. |
ReadOnlyProcessDefinition |
getDeployedProcessDefinition(String processDefinitionId) |
List<String> |
getDeploymentResourceNames(String deploymentId)
Retrieves a list of deployment resources for the given deployment,
ordered alphabetically.
|
List<IdentityLink> |
getIdentityLinksForProcessDefinition(String processDefinitionId)
Retrieves the
IdentityLinks associated with the given process definition. |
Model |
getModel(String modelId)
Returns the
Model |
byte[] |
getModelEditorSource(String modelId)
Returns the model editor source as a byte array
|
byte[] |
getModelEditorSourceExtra(String modelId)
Returns the model editor source extra as a byte array
|
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.
|
boolean |
isProcessDefinitionSuspended(String processDefinitionId)
Checks if the process definition is suspended.
|
Model |
newModel()
Creates a new model.
|
void |
saveModel(Model model)
Saves the model.
|
void |
setDeploymentCategory(String deploymentId,
String category)
Sets the category of the deployment.
|
void |
setProcessDefinitionCategory(String processDefinitionId,
String category)
Sets the category of the process definition.
|
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 |
suspendProcessDefinitionByKey(String processDefinitionKey,
boolean suspendProcessInstances,
Date suspensionDate,
String tenantId)
Similar to
RepositoryService.suspendProcessDefinitionByKey(String, boolean, Date), but only applicable for the given tenant identifier. |
void |
suspendProcessDefinitionByKey(String processDefinitionKey,
String tenantId)
Similar to
RepositoryService.suspendProcessDefinitionByKey(String), but only applicable for the given tenant identifier. |
List<ValidationError> |
validateProcess(org.activiti.bpmn.model.BpmnModel bpmnModel)
Validates the given process definition against the rules for executing a process definition
on the Activiti engine.
|
getCommandExecutor, setCommandExecutorpublic DeploymentBuilder createDeployment()
RepositoryServicecreateDeployment in interface RepositoryServicepublic Deployment deploy(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 setDeploymentCategory(String deploymentId, String category)
RepositoryServiceDeploymentQuery.deploymentCategory(String).setDeploymentCategory in interface RepositoryServicepublic ProcessDefinitionQuery createProcessDefinitionQuery()
RepositoryServicecreateProcessDefinitionQuery in interface RepositoryServicepublic NativeProcessDefinitionQuery createNativeProcessDefinitionQuery()
RepositoryServiceNativeQuery for process definitions.createNativeProcessDefinitionQuery in interface RepositoryServicepublic List<String> getDeploymentResourceNames(String deploymentId)
RepositoryServicegetDeploymentResourceNames 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 void changeDeploymentTenantId(String deploymentId, String newTenantId)
RepositoryServicechangeDeploymentTenantId in interface RepositoryServicedeploymentId - The id of the deployment of which the tenant identifier will be changed.newTenantId - The new tenant identifier.public DeploymentQuery createDeploymentQuery()
RepositoryServicecreateDeploymentQuery in interface RepositoryServicepublic NativeDeploymentQuery createNativeDeploymentQuery()
RepositoryServiceNativeQuery for deployment.createNativeDeploymentQuery in interface RepositoryServicepublic ProcessDefinition getProcessDefinition(String processDefinitionId)
RepositoryServiceProcessDefinition including all BPMN information like additional
Properties (e.g. documentation).getProcessDefinition in interface RepositoryServicepublic org.activiti.bpmn.model.BpmnModel getBpmnModel(String processDefinitionId)
RepositoryServiceBpmnModel corresponding with the process definition with
the provided process definition id. The BpmnModel is a pojo versions
of the BPMN 2.0 xml and can be used to introspect the process definition
using regular Java.getBpmnModel in interface RepositoryServicepublic ReadOnlyProcessDefinition getDeployedProcessDefinition(String processDefinitionId)
public boolean isProcessDefinitionSuspended(String processDefinitionId)
RepositoryServiceisProcessDefinitionSuspended in interface RepositoryServicepublic void suspendProcessDefinitionById(String processDefinitionId)
RepositoryServicesuspendProcessDefinitionById in interface RepositoryServicepublic void suspendProcessDefinitionById(String processDefinitionId, boolean suspendProcessInstances, Date suspensionDate)
RepositoryServicesuspendProcessDefinitionById 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!public void suspendProcessDefinitionByKey(String processDefinitionKey)
RepositoryServicesuspendProcessDefinitionByKey in interface RepositoryServicepublic void suspendProcessDefinitionByKey(String processDefinitionKey, boolean suspendProcessInstances, Date suspensionDate)
RepositoryServicesuspendProcessDefinitionByKey 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!public void suspendProcessDefinitionByKey(String processDefinitionKey, String tenantId)
RepositoryServiceRepositoryService.suspendProcessDefinitionByKey(String), but only applicable for the given tenant identifier.suspendProcessDefinitionByKey in interface RepositoryServicepublic void suspendProcessDefinitionByKey(String processDefinitionKey, boolean suspendProcessInstances, Date suspensionDate, String tenantId)
RepositoryServiceRepositoryService.suspendProcessDefinitionByKey(String, boolean, Date), but only applicable for the given tenant identifier.suspendProcessDefinitionByKey in interface RepositoryServicepublic void activateProcessDefinitionById(String processDefinitionId)
RepositoryServiceactivateProcessDefinitionById in interface RepositoryServicepublic void activateProcessDefinitionById(String processDefinitionId, boolean activateProcessInstances, Date activationDate)
RepositoryServiceactivateProcessDefinitionById in interface RepositoryServiceactivationDate - The date on which the process definition will be activated. If null, the
process definition is activated immediately.
Note: The job executor needs to be active to use this!public void activateProcessDefinitionByKey(String processDefinitionKey)
RepositoryServiceactivateProcessDefinitionByKey in interface RepositoryServicepublic void activateProcessDefinitionByKey(String processDefinitionKey, boolean activateProcessInstances, Date activationDate)
RepositoryServiceactivateProcessDefinitionByKey in interface RepositoryServiceactivationDate - The date on which the process definition will be activated. If null, the
process definition is activated immediately.
Note: The job executor needs to be active to use this!public void activateProcessDefinitionByKey(String processDefinitionKey, String tenantId)
RepositoryServiceRepositoryService.activateProcessDefinitionByKey(String), but only applicable for the given tenant identifier.activateProcessDefinitionByKey in interface RepositoryServicepublic void activateProcessDefinitionByKey(String processDefinitionKey, boolean activateProcessInstances, Date activationDate, String tenantId)
RepositoryServiceRepositoryService.activateProcessDefinitionByKey(String, boolean, Date), but only applicable for the given tenant identifier.activateProcessDefinitionByKey in interface RepositoryServicepublic void setProcessDefinitionCategory(String processDefinitionId, String category)
RepositoryServiceProcessDefinitionQuery.processDefinitionCategory(String).setProcessDefinitionCategory 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 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 Model newModel()
RepositoryServiceRepositoryService.saveModel(Model).newModel in interface RepositoryServicepublic void saveModel(Model model)
RepositoryServicesaveModel in interface RepositoryServicemodel - model to save, cannot be null.public void deleteModel(String modelId)
deleteModel in interface RepositoryServicemodelId - id of model to delete, cannot be null. When an id is passed
for an unexisting model, this operation is ignored.public void addModelEditorSource(String modelId, byte[] bytes)
RepositoryServiceaddModelEditorSource in interface RepositoryServicemodelId - id of model to delete, cannot be null. When an id is passed
for an unexisting model, this operation is ignored.public void addModelEditorSourceExtra(String modelId, byte[] bytes)
RepositoryServiceaddModelEditorSourceExtra in interface RepositoryServicemodelId - id of model to delete, cannot be null. When an id is passed
for an unexisting model, this operation is ignored.public ModelQuery createModelQuery()
RepositoryServicecreateModelQuery in interface RepositoryServicepublic NativeModelQuery createNativeModelQuery()
RepositoryServiceNativeQuery for process definitions.createNativeModelQuery in interface RepositoryServicepublic Model getModel(String modelId)
RepositoryServiceModelgetModel in interface RepositoryServicemodelId - id of modelpublic byte[] getModelEditorSource(String modelId)
RepositoryServicegetModelEditorSource in interface RepositoryServicemodelId - id of modelpublic byte[] getModelEditorSourceExtra(String modelId)
RepositoryServicegetModelEditorSourceExtra in interface RepositoryServicemodelId - id of modelpublic 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 List<ValidationError> validateProcess(org.activiti.bpmn.model.BpmnModel bpmnModel)
RepositoryServiceBpmnModel from a String, following code may be used:
XMLInputFactory xif = XMLInputFactory.newInstance();
InputStreamReader in = new InputStreamReader(new ByteArrayInputStream(myProcess.getBytes()), "UTF-8"); // Change to other streams for eg from classpath
XMLStreamReader xtr = xif.createXMLStreamReader(in);
bpmnModel = new BpmnXMLConverter().convertToBpmnModel(xtr);validateProcess in interface RepositoryServiceCopyright © 2016 Alfresco. All rights reserved.