Package org.nuxeo.ecm.webengine.model.impl

Class ModuleConfiguration

java.lang.Object
org.nuxeo.ecm.webengine.model.impl.ModuleConfiguration
public class ModuleConfiguration extends Object
Author:
Bogdan Stefanescu

  • Field Details

    • path

      @Deprecated public String path
      Deprecated.
      you should use new module definition - through WebEngineModule
      A web module may have multiple roots

    • rootType

      @Deprecated public String rootType
      Deprecated.
      you should use new module definition - through WebEngineModule

    • roots

      public Class<?>[] roots
      Paths of root resources in the module. This is replacing the deprecated root-type.

    • base

      public String base

    • name

      public String name

    • isHeadless

      @Deprecated public boolean isHeadless
      Deprecated.
      Use module links instead. If a module doesn't declare a module item it will be headless by default. Still used for compatibility mode - for those modules not yet using moduleItems.

    • moduleShortcuts

      public List<ModuleShortcut> moduleShortcuts
      A list of entry points into the module - to be shown in the main webengine page. This is optional and may be ignored if your don't want to provide shortcuts to your module entry points.

    • types

      public Class<?>[] types
      Web Types explicitly declared. If null no web types were explicitly declared and old type loading method from the generated web-types file should be used.

    • directory

      public File directory
      The module directory. Must be set by the client before registering the descriptor.

    • fragmentDirectories

      public List<File> fragmentDirectories

    • file

      public File file
      The module configuration file (this will be set by the module config parser)

    • natures

      public Set<String> natures

    • resources

      @Deprecated public List<ResourceBinding> resources
      Deprecated.
      resources are deprecated - you should use a jax-rs application to declare more resources.

    • templateFileExt

      public String templateFileExt

    • mediatTypeRefs

      public MediaTypeRef[] mediatTypeRefs

    • engine

      public WebEngine engine

    • allowHostOverride

      public boolean allowHostOverride

  • Constructor Details

    • ModuleConfiguration

      public ModuleConfiguration()

    • ModuleConfiguration

      public ModuleConfiguration(WebEngine engine)

  • Method Details

    • getEngine

      public WebEngine getEngine()

    • setEngine

      public void setEngine(WebEngine engine)

    • getName

      public String getName()

    • getShortcuts

      public List<ModuleShortcut> getShortcuts()

    • getLinks

      public List<LinkDescriptor> getLinks()

    • getDirectory

      public File getDirectory()

    • getBase

      public String getBase()

    • get

      public Module get(WebContext context)

    • flushCache

      public void flushCache()

    • isLoaded

      public boolean isLoaded()

    • isHeadless

      public boolean isHeadless()