Package com.flowable.form.engine

Class FormEngines

  • public abstract class FormEngines
extends java.lang.Object

    • Constructor Summary

      Constructors 
      Constructor Description
      FormEngines()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      protected static FormEngine buildFormEngine​(java.net.URL resource)  
      static void destroy()
      closes all form engines.
      static FormEngine getDefaultFormEngine()  
      static FormEngine getFormEngine​(java.lang.String formEngineName)
      Obtain a form engine by name.
      static org.flowable.common.engine.impl.EngineInfo getFormEngineInfo​(java.lang.String formEngineName)
      Get initialization results.
      static java.util.List<org.flowable.common.engine.impl.EngineInfo> getFormEngineInfos()
      Get initialization results.
      static java.util.Map<java.lang.String,​FormEngine> getFormEngines()
      provides access to form engine to application clients in a managed server environment.
      static void init()
      Initializes all form engines that can be found on the classpath for resources flowable.form.cfg.xml and for resources flowable-form-context.xml (Spring style configuration).
      protected static void initFormEngineFromSpringResource​(java.net.URL resource)  
      static boolean isInitialized()  
      static void registerFormEngine​(FormEngine formEngine)
      Registers the given form engine.
      static org.flowable.common.engine.impl.EngineInfo retry​(java.lang.String resourceUrl)
      retries to initialize a form engine that previously failed.
      static void setInitialized​(boolean isInitialized)  
      static void unregister​(FormEngine formEngine)
      Unregisters the given form engine.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • isInitialized

        protected static boolean isInitialized

      • formEngineMap

        protected static java.util.Map<java.lang.String,​FormEngine> formEngineMap

      • formEngineInfosByName

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

      • formEngineInfosByResourceUrl

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

      • formEngineInfos

        protected static java.util.List<org.flowable.common.engine.impl.EngineInfo> formEngineInfos

    • Constructor Detail

      • FormEngines

        public FormEngines()

    • Method Detail

      • init

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

      • initFormEngineFromSpringResource

        protected static void initFormEngineFromSpringResource​(java.net.URL resource)

      • registerFormEngine

        public static void registerFormEngine​(FormEngine formEngine)
        Registers the given form engine. No EngineInfo will be available for this form engine. An engine that is registered will be closed when the destroy() is called.

      • unregister

        public static void unregister​(FormEngine formEngine)
        Unregisters the given form engine.

      • buildFormEngine

        protected static FormEngine buildFormEngine​(java.net.URL resource)

      • getFormEngineInfos

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

      • getFormEngineInfo

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

      • getDefaultFormEngine

        public static FormEngine getDefaultFormEngine()

      • getFormEngine

        public static FormEngine getFormEngine​(java.lang.String formEngineName)
        Obtain a form engine by name.
        Parameters:
        formEngineName - is the name of the form engine or null for the default form engine.

      • retry

        public static org.flowable.common.engine.impl.EngineInfo retry​(java.lang.String resourceUrl)
        retries to initialize a form engine that previously failed.

      • getFormEngines

        public static java.util.Map<java.lang.String,​FormEngine> getFormEngines()
        provides access to form engine to application clients in a managed server environment.

      • destroy

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

      • isInitialized

        public static boolean isInitialized()

      • setInitialized

        public static void setInitialized​(boolean isInitialized)