Root element for a module declaration.
The module declaration type; contains dependencies, resources, and the main class specification.| Name | Type | Default | Description |
|---|---|---|---|
| name | The name of this module (required). | ||
| version | The version of this module (optional). |
exports?
Lists filter expressions to apply to the export filter of the local resources of this module (optional). By default, everything is exported. If filter expressions are provided, the default action is to accept all paths if no filters match.
A filter specification, consisting of zero or more filter items.include?
A path to include. The path value can be a path name or a "glob" which may include the special wildcards "*", "**", and "?".
A path specification type, which may include wildcards.| Name | Type | Default | Description |
|---|---|---|---|
| path | The path name, which can be a literal path name or it may include the special wildcards "*", "**", and "?". |
exclude?
A path to exclude. The path value can be a path name or a "glob" which may include the special wildcards "*", "**", and "?".
A path specification type, which may include wildcards.| Name | Type | Default | Description |
|---|---|---|---|
| path | The path name, which can be a literal path name or it may include the special wildcards "*", "**", and "?". |
include-set?
A set of literal path names to include. Wildcards are not supported.
A set of literal path names which can be used for efficient matching against multiple possible values.path?
The path name to include in the set.
A filesystem path name.| Name | Type | Default | Description |
|---|---|---|---|
| name | The path name. |
exclude-set?
A set of literal path names to exclude. Wildcards are not supported.
A set of literal path names which can be used for efficient matching against multiple possible values.path?
The path name to include in the set.
A filesystem path name.| Name | Type | Default | Description |
|---|---|---|---|
| name | The path name. |
dependencies?
Lists the dependencies of this module (optional).
A list of zero or more module dependencies.module
A specified module dependency.
A single module dependency expression.| Name | Type | Default | Description |
|---|---|---|---|
| name | The dependency module name (required). | ||
| export | false | Specifies whether this module dependency is re-exported by default (default is "false"). Setting this attribute to true sets the default action for the export filter list to "accept"; leaving it as false sets the default action to "reject". Thus you can still export dependency resources even if this attribute is false by listing explicit paths for the export list. | |
| services | none | Specifies whether and how services found in this dependency are used (default is "none"). Specifying a value of "import" for this attribute is equivalent to adding a filter at the end of the import filter list which includes the META-INF/services path from the dependency module. Setting a value of "export" for this attribute is equivalent to the same action on the export filter list. | |
| optional | false | Specifies whether this dependency is optional (defaults to false). An optional dependency will not cause the module to fail to load if not found; however if the module is added later, it will not be retroactively linked into this module's dependency list. |
properties?
Lists the user-defined properties to be associated with this module dependency (optional).
property
A property in this property list.
| Name | Type | Default | Description |
|---|---|---|---|
| name | The property name as a string (required). | ||
| value | true | The property value (optional, defaults to "true"). |
exports?
A filter used to restrict what packages or directories from this dependency are re-exported by this module. See also the "export" and "services" attributes. The default action of this filter list is controlled by the value of the "export" attribute. Regardless of the setting of these attributes, this filter always behaves as if it has a final entry which rejects META-INF and all of its subdirectories.
A filter specification, consisting of zero or more filter items.include?
A path to include. The path value can be a path name or a "glob" which may include the special wildcards "*", "**", and "?".
A path specification type, which may include wildcards.| Name | Type | Default | Description |
|---|---|---|---|
| path | The path name, which can be a literal path name or it may include the special wildcards "*", "**", and "?". |
exclude?
A path to exclude. The path value can be a path name or a "glob" which may include the special wildcards "*", "**", and "?".
A path specification type, which may include wildcards.| Name | Type | Default | Description |
|---|---|---|---|
| path | The path name, which can be a literal path name or it may include the special wildcards "*", "**", and "?". |
include-set?
A set of literal path names to include. Wildcards are not supported.
A set of literal path names which can be used for efficient matching against multiple possible values.path?
The path name to include in the set.
A filesystem path name.| Name | Type | Default | Description |
|---|---|---|---|
| name | The path name. |
exclude-set?
A set of literal path names to exclude. Wildcards are not supported.
A set of literal path names which can be used for efficient matching against multiple possible values.path?
The path name to include in the set.
A filesystem path name.| Name | Type | Default | Description |
|---|---|---|---|
| name | The path name. |
imports?
A filter used to restrict what packages or directories from this dependency are visible to this module. See also the "services" attribute. The default action of this filter list is to reject a path if not matched.
A filter specification, consisting of zero or more filter items.include?
A path to include. The path value can be a path name or a "glob" which may include the special wildcards "*", "**", and "?".
A path specification type, which may include wildcards.| Name | Type | Default | Description |
|---|---|---|---|
| path | The path name, which can be a literal path name or it may include the special wildcards "*", "**", and "?". |
exclude?
A path to exclude. The path value can be a path name or a "glob" which may include the special wildcards "*", "**", and "?".
A path specification type, which may include wildcards.| Name | Type | Default | Description |
|---|---|---|---|
| path | The path name, which can be a literal path name or it may include the special wildcards "*", "**", and "?". |
include-set?
A set of literal path names to include. Wildcards are not supported.
A set of literal path names which can be used for efficient matching against multiple possible values.path?
The path name to include in the set.
A filesystem path name.| Name | Type | Default | Description |
|---|---|---|---|
| name | The path name. |
exclude-set?
A set of literal path names to exclude. Wildcards are not supported.
A set of literal path names which can be used for efficient matching against multiple possible values.path?
The path name to include in the set.
A filesystem path name.| Name | Type | Default | Description |
|---|---|---|---|
| name | The path name. |
resources?
Lists the resource roots of this module (optional).
A list of zero or more resource roots for this deployment.resource-root
A resource root within this deployment.
A resource root within a deployment.| Name | Type | Default | Description |
|---|---|---|---|
| path | The path of this resource root, either absolute or relative. Relative paths are resolved with respect to the location at which the module.xml file is found. |
filter?
A path filter specification for this resource root (optional). By default all paths are accepted.
A filter specification, consisting of zero or more filter items.include?
A path to include. The path value can be a path name or a "glob" which may include the special wildcards "*", "**", and "?".
A path specification type, which may include wildcards.| Name | Type | Default | Description |
|---|---|---|---|
| path | The path name, which can be a literal path name or it may include the special wildcards "*", "**", and "?". |
exclude?
A path to exclude. The path value can be a path name or a "glob" which may include the special wildcards "*", "**", and "?".
A path specification type, which may include wildcards.| Name | Type | Default | Description |
|---|---|---|---|
| path | The path name, which can be a literal path name or it may include the special wildcards "*", "**", and "?". |
include-set?
A set of literal path names to include. Wildcards are not supported.
A set of literal path names which can be used for efficient matching against multiple possible values.path?
The path name to include in the set.
A filesystem path name.| Name | Type | Default | Description |
|---|---|---|---|
| name | The path name. |
exclude-set?
A set of literal path names to exclude. Wildcards are not supported.
A set of literal path names which can be used for efficient matching against multiple possible values.path?
The path name to include in the set.
A filesystem path name.| Name | Type | Default | Description |
|---|---|---|---|
| name | The path name. |
conditions?
A condition filter specification for this resource root (optional). If this resolves to false the resource will not be used.
A condition that determines if a resource is used. All conditions must resolve to true for the resource to be included in the module.property-equal?
A condition that evaluates to true if the property is equal to the provided value.
A condition based on the value of a system property.| Name | Type | Default | Description |
|---|---|---|---|
| name | FIXME | The property name | |
| value | FIXME | The property value |
property-not-equal?
A condition that evaluates to true if the property is equal to the provided value.
A condition based on the value of a system property.| Name | Type | Default | Description |
|---|---|---|---|
| name | FIXME | The property name | |
| value | FIXME | The property value |
artifact
A maven artifact within this deployment.
A maven artifact within a deployment.| Name | Type | Default | Description |
|---|---|---|---|
| name | URI that points to the maven artifact "group:artifact:version[:classifier]" |
filter?
A path filter specification for this resource root (optional). By default all paths are accepted.
A filter specification, consisting of zero or more filter items.include?
A path to include. The path value can be a path name or a "glob" which may include the special wildcards "*", "**", and "?".
A path specification type, which may include wildcards.| Name | Type | Default | Description |
|---|---|---|---|
| path | The path name, which can be a literal path name or it may include the special wildcards "*", "**", and "?". |
exclude?
A path to exclude. The path value can be a path name or a "glob" which may include the special wildcards "*", "**", and "?".
A path specification type, which may include wildcards.| Name | Type | Default | Description |
|---|---|---|---|
| path | The path name, which can be a literal path name or it may include the special wildcards "*", "**", and "?". |
include-set?
A set of literal path names to include. Wildcards are not supported.
A set of literal path names which can be used for efficient matching against multiple possible values.path?
The path name to include in the set.
A filesystem path name.| Name | Type | Default | Description |
|---|---|---|---|
| name | The path name. |
exclude-set?
A set of literal path names to exclude. Wildcards are not supported.
A set of literal path names which can be used for efficient matching against multiple possible values.path?
The path name to include in the set.
A filesystem path name.| Name | Type | Default | Description |
|---|---|---|---|
| name | The path name. |
conditions?
A condition filter specification for this resource root (optional). If this resolves to false the resource will not be used.
A condition that determines if a resource is used. All conditions must resolve to true for the resource to be included in the module.property-equal?
A condition that evaluates to true if the property is equal to the provided value.
A condition based on the value of a system property.| Name | Type | Default | Description |
|---|---|---|---|
| name | FIXME | The property name | |
| value | FIXME | The property value |
property-not-equal?
A condition that evaluates to true if the property is equal to the provided value.
A condition based on the value of a system property.| Name | Type | Default | Description |
|---|---|---|---|
| name | FIXME | The property name | |
| value | FIXME | The property value |
native-artifact
A maven native artifact within this deployment. This is a jar that contains a lib/ directory with corresponding platform directories and binaries. This element will cause the jar to be unzipped within the artifact's local repository directory.
A maven artifact within a deployment.| Name | Type | Default | Description |
|---|---|---|---|
| name | URI that points to the maven artifact "group:artifact:version[:classifier]" |
filter?
A path filter specification for this resource root (optional). By default all paths are accepted.
A filter specification, consisting of zero or more filter items.include?
A path to include. The path value can be a path name or a "glob" which may include the special wildcards "*", "**", and "?".
A path specification type, which may include wildcards.| Name | Type | Default | Description |
|---|---|---|---|
| path | The path name, which can be a literal path name or it may include the special wildcards "*", "**", and "?". |
exclude?
A path to exclude. The path value can be a path name or a "glob" which may include the special wildcards "*", "**", and "?".
A path specification type, which may include wildcards.| Name | Type | Default | Description |
|---|---|---|---|
| path | The path name, which can be a literal path name or it may include the special wildcards "*", "**", and "?". |
include-set?
A set of literal path names to include. Wildcards are not supported.
A set of literal path names which can be used for efficient matching against multiple possible values.path?
The path name to include in the set.
A filesystem path name.| Name | Type | Default | Description |
|---|---|---|---|
| name | The path name. |
exclude-set?
A set of literal path names to exclude. Wildcards are not supported.
A set of literal path names which can be used for efficient matching against multiple possible values.path?
The path name to include in the set.
A filesystem path name.| Name | Type | Default | Description |
|---|---|---|---|
| name | The path name. |
conditions?
A condition filter specification for this resource root (optional). If this resolves to false the resource will not be used.
A condition that determines if a resource is used. All conditions must resolve to true for the resource to be included in the module.property-equal?
A condition that evaluates to true if the property is equal to the provided value.
A condition based on the value of a system property.| Name | Type | Default | Description |
|---|---|---|---|
| name | FIXME | The property name | |
| value | FIXME | The property value |
property-not-equal?
A condition that evaluates to true if the property is equal to the provided value.
A condition based on the value of a system property.| Name | Type | Default | Description |
|---|---|---|---|
| name | FIXME | The property name | |
| value | FIXME | The property value |
main-class?
Specifies the main class of this module; used to run the module from the command-line (optional).
A class name.| Name | Type | Default | Description |
|---|---|---|---|
| name | The class name. |
properties?
Lists the user-defined properties to be associated with this module (optional).
property
A property in this property list.
| Name | Type | Default | Description |
|---|---|---|---|
| name | The property name as a string (required). | ||
| value | true | The property value (optional, defaults to "true"). |
permissions?
Lists the requested permission set for this module. If the requested permissions cannot be assigned, the module cannot be loaded.
A list of permissions that this module requires.grant
The permission to grant.
| Name | Type | Default | Description |
|---|---|---|---|
| permission | The qualified class name of the permission to grant. | ||
| name | The permission name to provide to the permission class constructor. | ||
| actions | The (optional) list of actions, required by some permission types. |
provides?
Lists items that are statically provided by this module.
The items that are provided by a module.service
A service to provide.
A service that is provided by one or more implementations.| Name | Type | Default | Description |
|---|---|---|---|
| name | The name of the service type. |
with-class
| Name | Type | Default | Description |
|---|---|---|---|
| name | The class name. |