Package org.flowable.eventregistry.test

Class FlowableEventRule

java.lang.Object
org.flowable.eventregistry.test.FlowableEventRule
All Implemented Interfaces:
org.junit.rules.TestRule
@Deprecated(forRemoval=true, since="7.2.0") public class FlowableEventRule 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 FlowableEventExtension instead
Convenience for EventRegistryEngine and services initialization in the form of a JUnit rule.

Usage: 

 public class YourTest {
 
   @Rule
   public FlowableFormRule flowableEventRule = new FlowableEventRule();
   
   ...
 }

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

You can declare a deployment with the EventDeploymentAnnotation annotation. This base class will make sure that this deployment gets deployed before the setUp and EventRepositoryService.deleteDeployment(String) after the tearDown.

Author:
Tijs Rademakers

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    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.
     
    protected EventRegistryEngineConfiguration
    eventEngineConfiguration
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected EventRegistryEngine
    eventRegistryEngine
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected EventRepositoryService
    repositoryService
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    FlowableEventRule()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    FlowableEventRule(String configurationResource)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    FlowableEventRule(EventRegistryEngine eventRegistryEngine)
    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
    configureEventRegistryEngine()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    EventRegistryEngineConfiguration(EventRegistryEngineConfiguration eventEngineConfiguration)
    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.
     
    String
    getConfigurationResource()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    EventRegistryEngine
    getEventRegistryEngine()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    EventRepositoryService
    getRepositoryService()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected void
    initializeEventRegistryEngine()
    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
    setConfigurationResource(String configurationResource)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setEventRegistryEngine(EventRegistryEngine eventRegistryEngine)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setRepositoryService(EventRepositoryService repositoryService)
    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.

    • eventEngineConfiguration

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

    • eventRegistryEngine

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

    • repositoryService

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

  • Constructor Details

    • FlowableEventRule

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

    • FlowableEventRule

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

    • FlowableEventRule

      public FlowableEventRule(EventRegistryEngine eventRegistryEngine)
      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.

    • initializeEventRegistryEngine

      protected void initializeEventRegistryEngine()
      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.

    • configureEventRegistryEngine

      protected void configureEventRegistryEngine()
      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.

    • 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.

    • getEventRegistryEngine

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

    • setEventRegistryEngine

      public void setEventRegistryEngine(EventRegistryEngine eventRegistryEngine)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getRepositoryService

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

    • setRepositoryService

      public void setRepositoryService(EventRepositoryService repositoryService)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • EventRegistryEngineConfiguration

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