Package org.flowable.cmmn.engine.test

Class FlowableCmmnRule

java.lang.Object
org.flowable.cmmn.engine.test.FlowableCmmnRule
All Implemented Interfaces:
org.junit.rules.TestRule
@Deprecated(forRemoval=true, since="7.2.0") public class FlowableCmmnRule extends Object implements org.junit.rules.TestRule
Deprecated, for removal: This API element is subject to removal in a future version.
Use JUnit Jupiter with FlowableCmmnTest instead
Convenience for CmmnEngine and services initialization in the form of a JUnit rule.

Usage: 

 public class YourTest {
 
   @Rule
   public FlowableCmmnRule flowableRule = new FlowableCmmnRule();
   
   ...
 }

The CmmnEngine and the services will be made available to the test class through the getters of the FlowableCmmnRule. The cmmnEngine will be initialized by default with the flowable.cfg.xml resource on the classpath. To specify a different configuration file, pass the resource location in the appropriate constructor. Cmmn engines will be cached statically. Right before the first time the setUp is called for a given configuration resource, the cmmn engine will be constructed.

You can declare a deployment with the CmmnDeployment annotation. This base class will make sure that this deployment gets deployed before the setUp and cascade deleted after the tearDown.

The FlowableRule also lets you set the current time used by the process engine. This can be handy to control the exact time that is used by the engine in order to verify e.g. e.g. due dates of timers. Or start, end and duration times in the history service. In the tearDown, the internal clock will automatically be reset to use the current system time rather then the time that was set during a test method.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected CmmnEngine
    cmmnEngine
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected CmmnEngineConfiguration
    cmmnEngineConfiguration
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected CmmnHistoryService
    cmmnHistoryService
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected CmmnManagementService
    cmmnManagementService
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected CmmnRepositoryService
    cmmnRepositoryService
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected CmmnRuntimeService
    cmmnRuntimeService
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected CmmnTaskService
    cmmnTaskService
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected String
    configurationResource
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected String
    deploymentId
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    FlowableCmmnRule()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    FlowableCmmnRule(String configurationResource)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    FlowableCmmnRule(CmmnEngine cmmnEngine)
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.junit.runners.model.Statement
    apply(org.junit.runners.model.Statement base, org.junit.runner.Description description)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Implementation based on TestWatcher.
    protected void
    configureProcessEngine()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected void
    failed(Throwable e, org.junit.runner.Description description)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Invoked when a test fails
    protected void
    finished(org.junit.runner.Description description)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    CmmnEngine
    getCmmnEngine()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    CmmnEngineConfiguration
    getCmmnEngineConfiguration()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    CmmnHistoryService
    getCmmnHistoryService()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    CmmnManagementService
    getCmmnManagementService()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    CmmnRepositoryService
    getCmmnRepositoryService()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    CmmnRuntimeService
    getCmmnRuntimeService()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    CmmnTaskService
    getCmmnTaskService()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    getConfigurationResource()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected void
    initializeCmmnEngine()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected void
    initializeServices()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setCmmnEngine(CmmnEngine cmmnEngine)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setConfigurationResource(String configurationResource)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setCurrentTime(Date currentTime)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected void
    skipped(org.junit.internal.AssumptionViolatedException e, org.junit.runner.Description description)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Invoked when a test is skipped due to a failed assumption.
    protected void
    starting(org.junit.runner.Description description)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected void
    succeeded(org.junit.runner.Description description)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Invoked when a test succeeds

    Methods inherited from class java.lang.Object

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

  • Field Details

    • configurationResource

      protected String configurationResource
      Deprecated, for removal: This API element is subject to removal in a future version.

    • deploymentId

      protected String deploymentId
      Deprecated, for removal: This API element is subject to removal in a future version.

    • cmmnEngineConfiguration

      protected CmmnEngineConfiguration cmmnEngineConfiguration
      Deprecated, for removal: This API element is subject to removal in a future version.

    • cmmnEngine

      protected CmmnEngine cmmnEngine
      Deprecated, for removal: This API element is subject to removal in a future version.

    • cmmnRepositoryService

      protected CmmnRepositoryService cmmnRepositoryService
      Deprecated, for removal: This API element is subject to removal in a future version.

    • cmmnRuntimeService

      protected CmmnRuntimeService cmmnRuntimeService
      Deprecated, for removal: This API element is subject to removal in a future version.

    • cmmnTaskService

      protected CmmnTaskService cmmnTaskService
      Deprecated, for removal: This API element is subject to removal in a future version.

    • cmmnHistoryService

      protected CmmnHistoryService cmmnHistoryService
      Deprecated, for removal: This API element is subject to removal in a future version.

    • cmmnManagementService

      protected CmmnManagementService cmmnManagementService
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Constructor Details

    • FlowableCmmnRule

      public FlowableCmmnRule()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • FlowableCmmnRule

      public FlowableCmmnRule(String configurationResource)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • FlowableCmmnRule

      public FlowableCmmnRule(CmmnEngine cmmnEngine)
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • apply

      public org.junit.runners.model.Statement apply(org.junit.runners.model.Statement base, org.junit.runner.Description description)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Implementation based on TestWatcher.
      Specified by:
      apply in interface org.junit.rules.TestRule

    • succeeded

      protected void succeeded(org.junit.runner.Description description)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Invoked when a test succeeds

    • failed

      protected void failed(Throwable e, org.junit.runner.Description description)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Invoked when a test fails

    • skipped

      protected void skipped(org.junit.internal.AssumptionViolatedException e, org.junit.runner.Description description)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Invoked when a test is skipped due to a failed assumption.

    • starting

      protected void starting(org.junit.runner.Description description)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • initializeCmmnEngine

      protected void initializeCmmnEngine()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • initializeServices

      protected void initializeServices()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • configureProcessEngine

      protected void configureProcessEngine()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • finished

      protected void finished(org.junit.runner.Description description)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setCurrentTime

      public void setCurrentTime(Date currentTime)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getConfigurationResource

      public String getConfigurationResource()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setConfigurationResource

      public void setConfigurationResource(String configurationResource)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getCmmnEngine

      public CmmnEngine getCmmnEngine()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setCmmnEngine

      public void setCmmnEngine(CmmnEngine cmmnEngine)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getCmmnEngineConfiguration

      public CmmnEngineConfiguration getCmmnEngineConfiguration()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getCmmnRepositoryService

      public CmmnRepositoryService getCmmnRepositoryService()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getCmmnRuntimeService

      public CmmnRuntimeService getCmmnRuntimeService()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getCmmnTaskService

      public CmmnTaskService getCmmnTaskService()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getCmmnHistoryService

      public CmmnHistoryService getCmmnHistoryService()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getCmmnManagementService

      public CmmnManagementService getCmmnManagementService()
      Deprecated, for removal: This API element is subject to removal in a future version.