Package org.eclipse.jetty.start

Class Module

java.lang.Object
org.eclipse.jetty.start.Module
All Implemented Interfaces:
Comparable<Module>
public class Module extends Object implements Comparable<Module>
Represents a Module metadata, as defined in Jetty.

A module consists of:

  • A set of jar files, directories and/or jar file patterns to be added to the classpath
  • A list of XML configuration files
  • Properties set either directly or via a file of properties
  • A set of modules names (or capability names) that this module depends on.
  • A set of capability names that this module provides (including it's own name).
  • Licence details for using the module
Modules are discovered in the ${jetty.home}/modules and ${jetty.home}/modules directories. A module may refer to non-discovered dynamic module in a subdirectory, using a property as part or all of the name. A module may be enabled, either directly by name or transiently via a dependency from another module by name or provided capability.

  • Constructor Details

  • Method Details

    • isConditionalDependency

      public static boolean isConditionalDependency(String depends)

    • normalizeModuleName

      public static String normalizeModuleName(String name)

    • getEnvironment

      public String getEnvironment()

    • getName

      public String getName()

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • expandDependencies

      public void expandDependencies(Props props)

    • getIniSection

      public List<String> getIniSection()

    • getIniTemplate

      public List<String> getIniTemplate()

    • getFiles

      public List<String> getFiles()

    • isSkipFilesValidation

      public boolean isSkipFilesValidation()

    • getJvmArgs

      public List<String> getJvmArgs()

    • getLibs

      public List<String> getLibs()

    • getLicense

      public List<String> getLicense()

    • getXmls

      public List<String> getXmls()

    • getJPMS

      public List<String> getJPMS()

    • getVersion

      public Version getVersion()

    • hasDefaultConfig

      public boolean hasDefaultConfig()

    • hasIniTemplate

      public boolean hasIniTemplate()

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • hasLicense

      public boolean hasLicense()

    • isDynamic

      public boolean isDynamic()
      Indicates a module that is dynamic in nature
      Returns:
      a module where the name is not in the top level of the modules directory

    • hasFiles

      public boolean hasFiles(BaseHome baseHome, Props props)

    • process

      public void process(BaseHome basehome) throws FileNotFoundException, IOException
      Throws:
      FileNotFoundException
      IOException

    • clearTransitiveEnable

      public boolean clearTransitiveEnable()

    • setSkipFilesValidation

      public void setSkipFilesValidation(boolean skipFilesValidation)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getDepends

      public List<String> getDepends()

    • getDeprecated

      public List<String> getDeprecated()

    • getProvides

      public Set<String> getProvides()

    • getBefore

      public Set<String> getBefore()

    • getAfter

      public Set<String> getAfter()

    • getOptional

      @Deprecated public Set<String> getOptional()
      Deprecated.
      use getAfter() instead
      Returns:
      the module names in the [after] section

    • getDescription

      public List<String> getDescription()

    • getTags

      public List<String> getTags()

    • getPrimaryTag

      public String getPrimaryTag()

    • isEnabled

      public boolean isEnabled()

    • getEnableSources

      public Set<String> getEnableSources()

    • enable

      public boolean enable(String source, boolean transitive)
      Parameters:
      source - String describing where the module was enabled from
      transitive - True if the enable is transitive
      Returns:
      true if the module was not previously enabled

    • isTransitive

      public boolean isTransitive()

    • writeIniSection

      public void writeIniSection(BufferedWriter writer, Props props)

    • compareTo

      public int compareTo(Module m)
      Specified by:
      compareTo in interface Comparable<Module>