Class AppEngines

java.lang.Object
com.flowable.app.engine.AppEngines

public abstract class AppEngines
extends java.lang.Object
  • Field Summary

    Fields 
    Modifier and Type Field Description
    protected static java.util.List<org.flowable.common.engine.impl.EngineInfo> appEngineInfos  
    protected static java.util.Map<java.lang.String,​org.flowable.common.engine.impl.EngineInfo> appEngineInfosByName  
    protected static java.util.Map<java.lang.String,​org.flowable.common.engine.impl.EngineInfo> appEngineInfosByResourceUrl  
    protected static java.util.Map<java.lang.String,​AppEngine> appEngines  
    protected static boolean isInitialized  
    static java.lang.String NAME_DEFAULT  
  • Constructor Summary

    Constructors 
    Constructor Description
    AppEngines()  
  • Method Summary

    Modifier and Type Method Description
    protected static AppEngine buildAppEngine​(java.net.URL resource)  
    static void destroy()
    closes all app engines.
    static AppEngine getAppEngine​(java.lang.String appEngineName)
    Obtain an app engine by name.
    static org.flowable.common.engine.impl.EngineInfo getAppEngineInfo​(java.lang.String appEngineName)
    Get initialization results.
    static java.util.List<org.flowable.common.engine.impl.EngineInfo> getAppEngineInfos()
    Get initialization results.
    static java.util.Map<java.lang.String,​AppEngine> getAppEngines()
    provides access to app engine to application clients in a managed server environment.
    static AppEngine getDefaultAppEngine()  
    static void init()
    Initializes all App engines that can be found on the classpath for resources flowable.app.cfg.xml and for resources flowable-app-context.xml (Spring style configuration).
    protected static void initAppEngineFromSpringResource​(java.net.URL resource)  
    static boolean isInitialized()  
    static void registerAppEngine​(AppEngine appEngine)
    Registers the given app engine.
    static org.flowable.common.engine.impl.EngineInfo retry​(java.lang.String resourceUrl)
    retries to initialize an app engine that previously failed.
    static void setInitialized​(boolean isInitialized)  
    static void unregister​(AppEngine appEngine)
    Unregisters the given app engine.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • NAME_DEFAULT

      public static final java.lang.String NAME_DEFAULT
      See Also:
      Constant Field Values
    • isInitialized

      protected static boolean isInitialized
    • appEngines

      protected static java.util.Map<java.lang.String,​AppEngine> appEngines
    • appEngineInfosByName

      protected static java.util.Map<java.lang.String,​org.flowable.common.engine.impl.EngineInfo> appEngineInfosByName
    • appEngineInfosByResourceUrl

      protected static java.util.Map<java.lang.String,​org.flowable.common.engine.impl.EngineInfo> appEngineInfosByResourceUrl
    • appEngineInfos

      protected static java.util.List<org.flowable.common.engine.impl.EngineInfo> appEngineInfos
  • Constructor Details

  • Method Details

    • init

      public static void init()
      Initializes all App engines that can be found on the classpath for resources flowable.app.cfg.xml and for resources flowable-app-context.xml (Spring style configuration).
    • initAppEngineFromSpringResource

      protected static void initAppEngineFromSpringResource​(java.net.URL resource)
    • registerAppEngine

      public static void registerAppEngine​(AppEngine appEngine)
      Registers the given app engine. No EngineInfo will be available for this app engine. An engine that is registered will be closed when the destroy() is called.
    • unregister

      public static void unregister​(AppEngine appEngine)
      Unregisters the given app engine.
    • buildAppEngine

      protected static AppEngine buildAppEngine​(java.net.URL resource)
    • getAppEngineInfos

      public static java.util.List<org.flowable.common.engine.impl.EngineInfo> getAppEngineInfos()
      Get initialization results.
    • getAppEngineInfo

      public static org.flowable.common.engine.impl.EngineInfo getAppEngineInfo​(java.lang.String appEngineName)
      Get initialization results. Only info will we available for app engines which were added in the init(). No EngineInfo is available for engines which were registered programmatically.
    • getDefaultAppEngine

      public static AppEngine getDefaultAppEngine()
    • getAppEngine

      public static AppEngine getAppEngine​(java.lang.String appEngineName)
      Obtain an app engine by name.
      Parameters:
      appEngineName - is the name of the app engine or null for the default app engine.
    • retry

      public static org.flowable.common.engine.impl.EngineInfo retry​(java.lang.String resourceUrl)
      retries to initialize an app engine that previously failed.
    • getAppEngines

      public static java.util.Map<java.lang.String,​AppEngine> getAppEngines()
      provides access to app engine to application clients in a managed server environment.
    • destroy

      public static void destroy()
      closes all app engines. This method should be called when the server shuts down.
    • isInitialized

      public static boolean isInitialized()
    • setInitialized

      public static void setInitialized​(boolean isInitialized)