public class Module extends java.lang.Object implements java.lang.Comparable<Module>
A module consists of:
${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.Modifier and Type | Field and Description |
---|---|
private java.util.List<java.lang.String> |
_defaultConfig
List of default config
|
private java.util.List<java.lang.String> |
_depends
Dependencies
|
private java.util.List<java.lang.String> |
_description
The module description
|
private boolean |
_dynamic
Is the module dynamic - ie referenced rather than discovered
|
private java.util.Set<java.lang.String> |
_enables
List of selections for this Module
|
private java.util.List<java.lang.String> |
_files
List of files for this Module
|
private java.util.List<java.lang.String> |
_iniTemplate
List of ini template lines
|
private java.util.List<java.lang.String> |
_jpms
List of JPMS options for this Module
|
private java.util.List<java.lang.String> |
_jvmArgs
List of jvm Args
|
private java.util.List<java.lang.String> |
_libs
List of library options for this Module
|
private java.util.List<java.lang.String> |
_license
License lines
|
private java.lang.String |
_name
The name of the module
|
private boolean |
_notTransitive
Boolean true if directly enabled, false if all selections are transitive
|
private java.util.Set<java.lang.String> |
_optional
Optional
|
private java.nio.file.Path |
_path
The file of the module
|
private java.util.Set<java.lang.String> |
_provides
List of provides for this Module
|
private boolean |
_skipFilesValidation
Skip File Validation (default: false)
|
private java.util.List<java.lang.String> |
_tags
List of tags for this Module
|
private java.util.List<java.lang.String> |
_xmls
List of xml configurations for this Module
|
(package private) static java.util.regex.Pattern |
MOD_NAME |
(package private) static java.util.regex.Pattern |
SET_PROPERTY |
private Version |
version
The version of Jetty the module supports
|
private static java.lang.String |
VERSION_UNSPECIFIED |
Constructor and Description |
---|
Module(BaseHome basehome,
java.nio.file.Path path) |
Modifier and Type | Method and Description |
---|---|
boolean |
clearTransitiveEnable() |
int |
compareTo(Module m) |
boolean |
enable(java.lang.String source,
boolean transitive) |
boolean |
equals(java.lang.Object obj) |
void |
expandDependencies(Props props) |
java.util.List<java.lang.String> |
getDefaultConfig() |
java.util.List<java.lang.String> |
getDepends() |
java.util.List<java.lang.String> |
getDescription() |
java.util.Set<java.lang.String> |
getEnableSources() |
java.util.List<java.lang.String> |
getFiles() |
java.util.List<java.lang.String> |
getIniTemplate() |
java.util.List<java.lang.String> |
getJPMS() |
java.util.List<java.lang.String> |
getJvmArgs() |
java.util.List<java.lang.String> |
getLibs() |
java.util.List<java.lang.String> |
getLicense() |
java.lang.String |
getName() |
java.util.Set<java.lang.String> |
getOptional() |
java.lang.String |
getPrimaryTag() |
java.util.Set<java.lang.String> |
getProvides() |
java.util.List<java.lang.String> |
getTags() |
Version |
getVersion() |
java.util.List<java.lang.String> |
getXmls() |
boolean |
hasDefaultConfig() |
boolean |
hasFiles(BaseHome baseHome,
Props props) |
int |
hashCode() |
boolean |
hasIniTemplate() |
boolean |
hasLicense() |
boolean |
isDynamic()
Indicates a module that is dynamic in nature
|
boolean |
isEnabled() |
boolean |
isSkipFilesValidation() |
boolean |
isTransitive() |
void |
process(BaseHome basehome) |
void |
setSkipFilesValidation(boolean skipFilesValidation) |
java.lang.String |
toString() |
void |
writeIniSection(java.io.BufferedWriter writer,
Props props) |
private static final java.lang.String VERSION_UNSPECIFIED
static java.util.regex.Pattern MOD_NAME
static java.util.regex.Pattern SET_PROPERTY
private final java.nio.file.Path _path
private final java.lang.String _name
private final boolean _dynamic
private Version version
private final java.util.List<java.lang.String> _description
private final java.util.List<java.lang.String> _xmls
private final java.util.List<java.lang.String> _iniTemplate
private final java.util.List<java.lang.String> _defaultConfig
private final java.util.List<java.lang.String> _libs
private final java.util.List<java.lang.String> _jpms
private final java.util.List<java.lang.String> _files
private final java.util.Set<java.lang.String> _enables
private final java.util.Set<java.lang.String> _provides
private final java.util.List<java.lang.String> _tags
private boolean _notTransitive
private boolean _skipFilesValidation
private final java.util.List<java.lang.String> _jvmArgs
private final java.util.List<java.lang.String> _license
private final java.util.List<java.lang.String> _depends
private final java.util.Set<java.lang.String> _optional
public Module(BaseHome basehome, java.nio.file.Path path) throws java.io.FileNotFoundException, java.io.IOException
java.io.FileNotFoundException
java.io.IOException
public java.lang.String getName()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public void expandDependencies(Props props)
public java.util.List<java.lang.String> getDefaultConfig()
public java.util.List<java.lang.String> getIniTemplate()
public java.util.List<java.lang.String> getFiles()
public boolean isSkipFilesValidation()
public java.util.List<java.lang.String> getJvmArgs()
public java.util.List<java.lang.String> getLibs()
public java.util.List<java.lang.String> getLicense()
public java.util.List<java.lang.String> getXmls()
public java.util.List<java.lang.String> getJPMS()
public Version getVersion()
public boolean hasDefaultConfig()
public boolean hasIniTemplate()
public int hashCode()
hashCode
in class java.lang.Object
public boolean hasLicense()
public boolean isDynamic()
public void process(BaseHome basehome) throws java.io.FileNotFoundException, java.io.IOException
java.io.FileNotFoundException
java.io.IOException
public boolean clearTransitiveEnable()
public void setSkipFilesValidation(boolean skipFilesValidation)
public java.lang.String toString()
toString
in class java.lang.Object
public java.util.List<java.lang.String> getDepends()
public java.util.Set<java.lang.String> getProvides()
public java.util.Set<java.lang.String> getOptional()
public java.util.List<java.lang.String> getDescription()
public java.util.List<java.lang.String> getTags()
public java.lang.String getPrimaryTag()
public boolean isEnabled()
public java.util.Set<java.lang.String> getEnableSources()
public boolean enable(java.lang.String source, boolean transitive)
source
- String describing where the module was enabled fromtransitive
- True if the enable is transitivepublic boolean isTransitive()
public void writeIniSection(java.io.BufferedWriter writer, Props props)