Interface DeploymentService

    • Method Detail

      • deploy

        void deploy​(DeploymentUnit unit)
        Performs deployment operation of given unit.
        Parameters:
        unit - deployment unit to be deployed to runtime
        Throws:
        RuntimeException - in case of problems encountered while deploying unit
      • undeploy

        void undeploy​(DeploymentUnit unit)
        Performs undeployment operation of given unit.
        Parameters:
        unit - deployment unit to be undeployed from runtime
        Throws:
        RuntimeException - in case of problems encountered while undeploying unit
      • undeploy

        void undeploy​(DeploymentUnit unit,
                      Function<DeploymentUnit,​Boolean> beforeUndeploy)
        Performs undeployment operation of given unit aborting existing process instances if needed.
        Parameters:
        unit - deployment unit to be undeployed from runtime
        beforeUndeploy - a function to run custom actions before undeploying a given DeploymentUnit . It should return if the unit can be deployed or not determining if the deployment can continue.
        Throws:
        RuntimeException - in case of problems encountered while undeploying unit
      • getRuntimeManager

        org.kie.api.runtime.manager.RuntimeManager getRuntimeManager​(String deploymentUnitId)
        Returns RuntimeManager instance dedicated to deployment unit identified by given id
        Parameters:
        deploymentUnitId - identifier of deployment unit
        Returns:
        RuntimeManager if exists for given deployment id otherwise null
      • getDeployedUnit

        DeployedUnit getDeployedUnit​(String deploymentUnitId)
        Returns DeployedUnit instance for given deployment id if exists
        Parameters:
        deploymentUnitId - identifier of deployment unit
        Returns:
        DeployedUnit instance if exists for given deployment id otherwise null
      • getDeployedUnits

        Collection<DeployedUnit> getDeployedUnits()
        Returns all (currently) deployed units.
        Returns:
        collections of all existing deployed units
      • activate

        void activate​(String deploymentId)
        Activates given deployment by making sure it will be available for execution.
        Parameters:
        deploymentId -
      • deactivate

        void deactivate​(String deploymentId)
        Deactivates given deployment by making it only available for already running instances.
        Parameters:
        deploymentId -
      • isDeployed

        boolean isDeployed​(String deploymentUnitId)
        Performs a check if given deployment is already active
        Parameters:
        deploymentUnitId -
        Returns:
        true if deployment is active, false if not