Package org.activiti.engine

Interface RepositoryService

  • All Known Implementing Classes:
    RepositoryServiceImpl
    @Internal
public interface RepositoryService
    Service providing access to the repository of process definitions and deployments.

    • Method Detail

      • createDeployment

        DeploymentBuilder createDeployment()
        Starts creating a new deployment

      • deleteDeployment

        void deleteDeployment​(java.lang.String deploymentId)
        Deletes the given deployment.
        Parameters:
        deploymentId - id of the deployment, cannot be null.

      • deleteDeployment

        void deleteDeployment​(java.lang.String deploymentId,
                      boolean cascade)
        Deletes the given deployment and cascade deletion to process instances, history process instances and jobs.
        Parameters:
        deploymentId - id of the deployment, cannot be null.

      • getDeploymentResourceNames

        java.util.List<java.lang.String> getDeploymentResourceNames​(java.lang.String deploymentId)
        Retrieves a list of deployment resources for the given deployment, ordered alphabetically.
        Parameters:
        deploymentId - id of the deployment, cannot be null.

      • getResourceAsStream

        java.io.InputStream getResourceAsStream​(java.lang.String deploymentId,
                                        java.lang.String resourceName)
        Gives access to a deployment resource through a stream of bytes.
        Parameters:
        deploymentId - id of the deployment, cannot be null.
        resourceName - name of the resource, cannot be null.
        Throws:
        ActivitiObjectNotFoundException - when the resource doesn't exist in the given deployment or when no deployment exists for the given deploymentId.

      • changeDeploymentTenantId

        void changeDeploymentTenantId​(java.lang.String deploymentId,
                              java.lang.String newTenantId)
        EXPERIMENTAL FEATURE! Changes the tenant identifier of a deployment to match the given tenant identifier. This change will cascade to any related entity: - process definitions related to the deployment - process instances related to those process definitions - executions related to those process instances - tasks related to those process instances - jobs related to the process definitions and process instances This method can be used in the case that there was no tenant identifier set on the deployment or those entities before. This method can be used to remove a tenant identifier from the deployment and related entities (simply pass null). Important: no optimistic locking will be done while executing the tenant identifier change! This is an experimental feature, mainly because it WILL NOT work properly in a clustered environment without special care: suppose some process instance is in flight. The process definition is in the process definition cache. When a task or job is created when continuing the process instance, the process definition cache will be consulted to get the process definition and from it the tenant identifier. Since it's cached, it will not be the new tenant identifier. This method does clear the cache for this engineinstance , but it will not be cleared on other nodes in a cluster (unless using a shared process definition cache).
        Parameters:
        deploymentId - The id of the deployment of which the tenant identifier will be changed.
        newTenantId - The new tenant identifier.

      • createProcessDefinitionQuery

        ProcessDefinitionQuery createProcessDefinitionQuery()
        Query process definitions.

      • createDeploymentQuery

        DeploymentQuery createDeploymentQuery()
        Query deployment.

      • suspendProcessDefinitionById

        void suspendProcessDefinitionById​(java.lang.String processDefinitionId)
        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)!
        Throws:
        ActivitiObjectNotFoundException - if no such processDefinition can be found
        ActivitiException - if the process definition is already in state suspended.

      • suspendProcessDefinitionById

        void suspendProcessDefinitionById​(java.lang.String processDefinitionId,
                                  boolean suspendProcessInstances,
                                  java.util.Date suspensionDate)
        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.
        Parameters:
        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!
        Throws:
        ActivitiObjectNotFoundException - if no such processDefinition can be found.
        ActivitiException - if the process definition is already in state suspended.

      • suspendProcessDefinitionByKey

        void suspendProcessDefinitionByKey​(java.lang.String processDefinitionKey)
        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)!
        Throws:
        ActivitiObjectNotFoundException - if no such processDefinition can be found
        ActivitiException - if the process definition is already in state suspended.

      • suspendProcessDefinitionByKey

        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). If a process definition is in state suspended, it will not be possible to start new process instances based on the process definition.
        Parameters:
        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!
        Throws:
        ActivitiObjectNotFoundException - if no such processDefinition can be found
        ActivitiException - if the process definition is already in state suspended.

      • suspendProcessDefinitionByKey

        void suspendProcessDefinitionByKey​(java.lang.String processDefinitionKey,
                                   java.lang.String tenantId)
        Similar to suspendProcessDefinitionByKey(String), but only applicable for the given tenant identifier.

      • suspendProcessDefinitionByKey

        void suspendProcessDefinitionByKey​(java.lang.String processDefinitionKey,
                                   boolean suspendProcessInstances,
                                   java.util.Date suspensionDate,
                                   java.lang.String tenantId)
        Similar to suspendProcessDefinitionByKey(String, boolean, Date), but only applicable for the given tenant identifier.

      • activateProcessDefinitionById

        void activateProcessDefinitionById​(java.lang.String processDefinitionId)
        Activates the process definition with the given id.
        Throws:
        ActivitiObjectNotFoundException - if no such processDefinition can be found or if the process definition is already in state active.

      • activateProcessDefinitionById

        void activateProcessDefinitionById​(java.lang.String processDefinitionId,
                                   boolean activateProcessInstances,
                                   java.util.Date activationDate)
        Activates the process definition with the given id.
        Parameters:
        activationDate - 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!
        Throws:
        ActivitiObjectNotFoundException - if no such processDefinition can be found.
        ActivitiException - if the process definition is already in state active.

      • activateProcessDefinitionByKey

        void activateProcessDefinitionByKey​(java.lang.String processDefinitionKey)
        Activates the process definition with the given key (=id in the bpmn20.xml file).
        Throws:
        ActivitiObjectNotFoundException - if no such processDefinition can be found.
        ActivitiException - if the process definition is already in state active.

      • activateProcessDefinitionByKey

        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).
        Parameters:
        activationDate - 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!
        Throws:
        ActivitiObjectNotFoundException - if no such processDefinition can be found.
        ActivitiException - if the process definition is already in state active.

      • activateProcessDefinitionByKey

        void activateProcessDefinitionByKey​(java.lang.String processDefinitionKey,
                                    java.lang.String tenantId)
        Similar to activateProcessDefinitionByKey(String), but only applicable for the given tenant identifier.

      • activateProcessDefinitionByKey

        void activateProcessDefinitionByKey​(java.lang.String processDefinitionKey,
                                    boolean activateProcessInstances,
                                    java.util.Date activationDate,
                                    java.lang.String tenantId)
        Similar to activateProcessDefinitionByKey(String, boolean, Date) , but only applicable for the given tenant identifier.

      • getProcessModel

        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.
        Parameters:
        processDefinitionId - id of a ProcessDefinition, cannot be null.
        Throws:
        ActivitiObjectNotFoundException - when the process model doesn't exist.

      • getProcessDefinition

        ProcessDefinition getProcessDefinition​(java.lang.String processDefinitionId)
        Returns the ProcessDefinition including all BPMN information like additional Properties (e.g. documentation).

      • isProcessDefinitionSuspended

        boolean isProcessDefinitionSuspended​(java.lang.String processDefinitionId)
        Checks if the process definition is suspended.

      • getBpmnModel

        org.activiti.bpmn.model.BpmnModel getBpmnModel​(java.lang.String processDefinitionId)
        Returns the BpmnModel 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.

      • newModel

        Model newModel()
        Creates a new model. The model is transient and must be saved using saveModel(Model).

      • saveModel

        void saveModel​(Model model)
        Saves the model. If the model already existed, the model is updated otherwise a new model is created.
        Parameters:
        model - model to save, cannot be null.

      • deleteModel

        void deleteModel​(java.lang.String modelId)
        Parameters:
        modelId - id of model to delete, cannot be null. When an id is passed for an unexisting model, this operation is ignored.

      • addModelEditorSource

        void addModelEditorSource​(java.lang.String modelId,
                          byte[] bytes)
        Saves the model editor source for a model
        Parameters:
        modelId - id of model to delete, cannot be null. When an id is passed for an unexisting model, this operation is ignored.

      • addModelEditorSourceExtra

        void addModelEditorSourceExtra​(java.lang.String modelId,
                               byte[] bytes)
        Saves the model editor source extra for a model
        Parameters:
        modelId - id of model to delete, cannot be null. When an id is passed for an unexisting model, this operation is ignored.

      • createModelQuery

        ModelQuery createModelQuery()
        Query models.

      • getModel

        Model getModel​(java.lang.String modelId)
        Returns the Model
        Parameters:
        modelId - id of model

      • getModelEditorSource

        byte[] getModelEditorSource​(java.lang.String modelId)
        Returns the model editor source as a byte array
        Parameters:
        modelId - id of model

      • getModelEditorSourceExtra

        byte[] getModelEditorSourceExtra​(java.lang.String modelId)
        Returns the model editor source extra as a byte array
        Parameters:
        modelId - id of model

      • addCandidateStarterUser

        void addCandidateStarterUser​(java.lang.String processDefinitionId,
                             java.lang.String userId)
        Authorizes a candidate user for a process definition.
        Parameters:
        processDefinitionId - id of the process definition, cannot be null.
        userId - id of the user involve, cannot be null.
        Throws:
        ActivitiObjectNotFoundException - when the process definition or user doesn't exist.

      • addCandidateStarterGroup

        void addCandidateStarterGroup​(java.lang.String processDefinitionId,
                              java.lang.String groupId)
        Authorizes a candidate group for a process definition.
        Parameters:
        processDefinitionId - id of the process definition, cannot be null.
        groupId - id of the group involve, cannot be null.
        Throws:
        ActivitiObjectNotFoundException - when the process definition or group doesn't exist.

      • deleteCandidateStarterUser

        void deleteCandidateStarterUser​(java.lang.String processDefinitionId,
                                java.lang.String userId)
        Removes the authorization of a candidate user for a process definition.
        Parameters:
        processDefinitionId - id of the process definition, cannot be null.
        userId - id of the user involve, cannot be null.
        Throws:
        ActivitiObjectNotFoundException - when the process definition or user doesn't exist.

      • deleteCandidateStarterGroup

        void deleteCandidateStarterGroup​(java.lang.String processDefinitionId,
                                 java.lang.String groupId)
        Removes the authorization of a candidate group for a process definition.
        Parameters:
        processDefinitionId - id of the process definition, cannot be null.
        groupId - id of the group involve, cannot be null.
        Throws:
        ActivitiObjectNotFoundException - when the process definition or group doesn't exist.

      • getIdentityLinksForProcessDefinition

        java.util.List<IdentityLink> getIdentityLinksForProcessDefinition​(java.lang.String processDefinitionId)
        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

      • validateProcess

        java.util.List<org.activiti.validation.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. To create such a BpmnModel 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);