Serialized Form
|
Package org.apache.maven.plugin.assembly |
serialVersionUID: 1L
|
Package org.apache.maven.plugin.assembly.archive |
serialVersionUID: 1L
serialVersionUID: 1L
|
Package org.apache.maven.plugin.assembly.artifact |
serialVersionUID: 1L
|
Package org.apache.maven.plugin.assembly.format |
serialVersionUID: 1L
serialVersionUID: 1L
project
org.apache.maven.project.MavenProject project
- Deprecated.
escapedBackslashesInFilePath
boolean escapedBackslashesInFilePath
- Deprecated.
|
Package org.apache.maven.plugin.assembly.interpolation |
serialVersionUID: 1L
expression
String expression
originalMessage
String originalMessage
|
Package org.apache.maven.plugin.assembly.io |
serialVersionUID: 1L
|
Package org.apache.maven.plugin.assembly.model |
id
String id
- Sets the id of this assembly. This is a symbolic
name for a
particular assembly of files from this project.
Also, aside from
being used to distinctly name the assembled
package by attaching
its value to the generated archive, the id is
used as your
artifact's classifier when deploying.
formats
List<E> formats
- Field formats.
includeBaseDirectory
boolean includeBaseDirectory
- Includes a base directory in the final archive.
For example,
if you are creating an assembly named
"your-app", setting
includeBaseDirectory to true will create an
archive that
includes this base directory. If this option is
set to false
the archive created will unzip its content to
the current
directory. Default value is true.
baseDirectory
String baseDirectory
- Sets the base directory of the resulting
assembly archive. If this is not
set and includeBaseDirectory == true,
${project.build.finalName} will be used instead.
(Since 2.2-beta-1)
.
includeSiteDirectory
boolean includeSiteDirectory
- Includes a site directory in the final archive.
The site directory
location of a project is determined by the
siteDirectory parameter
of the Assembly Plugin. Default value is false.
containerDescriptorHandlers
List<E> containerDescriptorHandlers
- Field containerDescriptorHandlers.
moduleSets
List<E> moduleSets
- Field moduleSets.
fileSets
List<E> fileSets
- Field fileSets.
files
List<E> files
- Field files.
dependencySets
List<E> dependencySets
- Field dependencySets.
repositories
List<E> repositories
- Field repositories.
componentDescriptors
List<E> componentDescriptors
- Field componentDescriptors.
modelEncoding
String modelEncoding
- Field modelEncoding.
moduleSets
List<E> moduleSets
- Field moduleSets.
fileSets
List<E> fileSets
- Field fileSets.
files
List<E> files
- Field files.
dependencySets
List<E> dependencySets
- Field dependencySets.
repositories
List<E> repositories
- Field repositories.
containerDescriptorHandlers
List<E> containerDescriptorHandlers
- Field containerDescriptorHandlers.
modelEncoding
String modelEncoding
- Field modelEncoding.
handlerName
String handlerName
- The handler's plexus role-hint, for lookup from
the container.
configuration
Object configuration
- Configuration options for the handler.
outputDirectory
String outputDirectory
- Sets the output directory relative to the root
of the root directory of the assembly. For
example,
"log" will put the specified files in the log
directory,
directly beneath the root of the archive.
includes
List<E> includes
- Field includes.
excludes
List<E> excludes
- Field excludes.
fileMode
String fileMode
- Similar to a UNIX permission, sets the file mode
of the files included.
THIS IS AN OCTAL VALUE.
Format: (User)(Group)(Other) where each
component is a sum of Read = 4,
Write = 2, and Execute = 1. For example, the
value 0644
translates to User read-write, Group and Other
read-only.
(more
on unix-style permissions)
directoryMode
String directoryMode
- Similar to a UNIX permission, sets the directory
mode of the directories
included.
THIS IS AN OCTAL VALUE.
Format: (User)(Group)(Other) where each
component is a sum of
Read = 4, Write = 2, and Execute = 1. For
example, the value
0755 translates to User read-write, Group and
Other read-only.
(more
on unix-style permissions)
useStrictFiltering
boolean useStrictFiltering
- When specified as true, any include/exclude
patterns which aren't used to filter an actual
artifact during assembly creation will cause the
build to fail with an error. This is meant
to highlight obsolete inclusions or exclusions, or
else signal that the assembly descriptor
is incorrectly configured. (Since 2.2)
.
outputFileNameMapping
String outputFileNameMapping
- Sets the mapping pattern for all dependencies
included in this
assembly. Default is
${artifact.artifactId}-${artifact.version}${dashClassifier?}.${artifact.extension}.
(Since 2.2-beta-2; 2.2-beta-1 uses
${artifactId}-${version}${dashClassifier?}.${extension})
.
unpack
boolean unpack
- If set to true, this property will unpack all
dependencies
into the specified output directory. When set to
false
dependencies will be includes as archives
(jars). Can only unpack
jar, zip, tar.gz, and tar.bz archives. Default
value is false.
unpackOptions
UnpackOptions unpackOptions
- Allows the specification of includes and excludes,
along with filtering options, for items
unpacked from a dependency artifact. (Since 2.2)
.
scope
String scope
- Sets the dependency scope for this
dependencySet.
Default scope value is "runtime".
useProjectArtifact
boolean useProjectArtifact
- Determines whether the artifact produced during
the current project's
build should be included in this dependency set.
Default value is true,
for backward compatibility. (Since 2.2)
.
useProjectAttachments
boolean useProjectAttachments
- Determines whether the attached artifacts produced
during the current project's
build should be included in this dependency set.
Default value is false. (Since 2.2)
.
useTransitiveDependencies
boolean useTransitiveDependencies
- Determines whether transitive dependencies will be
included in the processing of
the current dependency set. If true,
includes/excludes/useTransitiveFiltering
will apply to transitive dependency artifacts in
addition to the main project
dependency artifacts. If false,
useTransitiveFiltering is meaningless, and
includes/excludes only affect the immediate
dependencies of the project.
By default, this value is true. (Since 2.2)
.
useTransitiveFiltering
boolean useTransitiveFiltering
- Determines whether the include/exclude patterns in
this dependency set will be applied to
the transitive path of a given artifact. If true,
and the current artifact is a transitive
dependency brought in by another artifact which
matches an inclusion or exclusion pattern,
then the current artifact has the same
inclusion/exclusion logic applied to it as well. By
default, this value is false, in order to preserve
backward compatibility with version 2.1.
This means that includes/excludes only apply
directly to the current artifact, and not to
the transitive set of artifacts which brought it
in. (Since 2.2)
.
source
String source
- Sets the absolute or relative path from the
module's directory
of the file to be included in the assembly.
outputDirectory
String outputDirectory
- Sets the output directory relative to the root
of the root directory of the assembly. For
example,
"log" will put the specified files in the log
directory.
destName
String destName
- Sets the destination filename in the
outputDirectory.
Default is the same name as the source's file.
fileMode
String fileMode
- Similar to a UNIX permission, sets the file mode
of the files included.
THIS IS AN OCTAL VALUE.
Format: (User)(Group)(Other) where each
component is a sum of Read = 4,
Write = 2, and Execute = 1. For example, the
value 0644
translates to User read-write, Group and Other
read-only.
(more
on unix-style permissions)
lineEnding
String lineEnding
- Sets the line-endings of the files in this file.
Valid values are:
- "keep" - Preserve all line
endings
- "unix" - Use Unix-style line
endings
- "lf" - Use a single line-feed line
endings
- "dos" - Use DOS-style line
endings
- "crlf" - Use Carraige-return,
line-feed line endings
filtered
boolean filtered
- Sets whether to determine if the file is
filtered.
useDefaultExcludes
boolean useDefaultExcludes
- Whether standard exclusion patterns, such as
those matching CVS and Subversion
metadata files, should be used when calculating
the files affected by this set.
For backward compatibility, the default value is
true. (Since 2.2)
.
outputDirectory
String outputDirectory
- Sets the output directory relative to the root
of the root directory of the assembly. For
example,
"log" will put the specified files in the log
directory.
includes
List<E> includes
- Field includes.
excludes
List<E> excludes
- Field excludes.
fileMode
String fileMode
- Similar to a UNIX permission, sets the file mode
of the files included.
THIS IS AN OCTAL VALUE.
Format: (User)(Group)(Other) where each
component is a sum of Read = 4,
Write = 2, and Execute = 1. For example, the
value 0644
translates to User read-write, Group and Other
read-only.
(more
on unix-style permissions)
directoryMode
String directoryMode
- Similar to a UNIX permission, sets the directory
mode of the directories
included.
THIS IS AN OCTAL VALUE.
Format: (User)(Group)(Other) where each
component is a sum of
Read = 4, Write = 2, and Execute = 1. For
example, the value
0755 translates to User read-write, Group and
Other read-only.
(more
on unix-style permissions)
directory
String directory
- Sets the absolute or relative location from the
module's
directory. For example, "src/main/bin" would
select this
subdirectory of the project in which this
dependency is defined.
lineEnding
String lineEnding
- Sets the line-endings of the files in this
fileSet.
Valid values:
- "keep" - Preserve all line
endings
- "unix" - Use Unix-style line
endings
- "lf" - Use a single line-feed line
endings
- "dos" - Use DOS-style line
endings
- "crlf" - Use Carraige-return,
line-feed line endings
filtered
boolean filtered
- Whether to filter symbols in the files as they are
copied, using
properties from the build configuration. (Since
2.2)
.
id
String id
- The groupId of the artifacts for which you want
to align the
versions.
version
String version
- The version you want to align this group to.
excludes
List<E> excludes
- Field excludes.
outputDirectory
String outputDirectory
- Sets the output directory relative to the root
of the root directory of the assembly. For
example,
"log" will put the specified files in the log
directory,
directly beneath the root of the archive.
includes
List<E> includes
- Field includes.
excludes
List<E> excludes
- Field excludes.
fileMode
String fileMode
- Similar to a UNIX permission, sets the file mode
of the files included.
THIS IS AN OCTAL VALUE.
Format: (User)(Group)(Other) where each
component is a sum of Read = 4,
Write = 2, and Execute = 1. For example, the
value 0644
translates to User read-write, Group and Other
read-only.
(more
on unix-style permissions)
directoryMode
String directoryMode
- Similar to a UNIX permission, sets the directory
mode of the directories
included.
THIS IS AN OCTAL VALUE.
Format: (User)(Group)(Other) where each
component is a sum of
Read = 4, Write = 2, and Execute = 1. For
example, the value
0755 translates to User read-write, Group and
Other read-only.
(more
on unix-style permissions)
attachmentClassifier
String attachmentClassifier
- When specified, the attachmentClassifier will
cause the assembler to look at artifacts
attached to the module instead of the main project
artifact. If it can find an attached
artifact matching the specified classifier, it
will use it; otherwise, it will throw an
exception. (Since 2.2)
.
includeDependencies
boolean includeDependencies
- If set to true, the plugin will include the direct
and transitive dependencies of
of the project modules included here. Otherwise,
it will only include the module
packages only. Default value is true.
dependencySets
List<E> dependencySets
- Field dependencySets.
unpack
boolean unpack
- If set to true, this property will unpack all
module packages
into the specified output directory. When set to
false
module packages will be included as archives
(jars).
Default value is true.
unpackOptions
UnpackOptions unpackOptions
- Allows the specification of includes and excludes,
along with filtering options, for items
unpacked from a module artifact. (Since 2.2)
.
outputFileNameMapping
String outputFileNameMapping
- Sets the mapping pattern for all NON-UNPACKED
dependencies included
in this assembly.
Default is
${module.artifactId}-${module.version}${dashClassifier?}.${module.extension}.
(Since 2.2-beta-2; 2.2-beta-1 uses
${artifactId}-${version}${dashClassifier?}.${extension})
NOTE: If the
dependencySet specifies unpack == true,
outputFileNameMapping WILL NOT BE USED; in these cases, use
outputDirectory.
useAllReactorProjects
boolean useAllReactorProjects
- If set to true, the plugin will include all
projects in the current reactor for processing
in this ModuleSet. These will be subject to
include/exclude rules.
Default value is true. (Since 2.2)
.
includeSubModules
boolean includeSubModules
- If set to false, the plugin will exclude
sub-modules from processing in this ModuleSet.
Otherwise, it will process all sub-modules, each
subject to include/exclude rules.
Default value is true. (Since 2.2)
.
includes
List<E> includes
- Field includes.
excludes
List<E> excludes
- Field excludes.
sources
ModuleSources sources
- When this is present, the plugin will include
the source files of
the included modules from this set in the
resulting assembly.
binaries
ModuleBinaries binaries
- When this is present, the plugin will include
the binaries of the
included modules from this set in the resulting
assembly.
useDefaultExcludes
boolean useDefaultExcludes
- Whether standard exclusion patterns, such as
those matching CVS and Subversion
metadata files, should be used when calculating
the files affected by this set.
For backward compatibility, the default value is
true. (Since 2.2)
.
outputDirectory
String outputDirectory
- Sets the output directory relative to the root
of the root directory of the assembly. For
example,
"log" will put the specified files in the log
directory.
includes
List<E> includes
- Field includes.
excludes
List<E> excludes
- Field excludes.
fileMode
String fileMode
- Similar to a UNIX permission, sets the file mode
of the files included.
THIS IS AN OCTAL VALUE.
Format: (User)(Group)(Other) where each
component is a sum of Read = 4,
Write = 2, and Execute = 1. For example, the
value 0644
translates to User read-write, Group and Other
read-only.
(more
on unix-style permissions)
directoryMode
String directoryMode
- Similar to a UNIX permission, sets the directory
mode of the directories
included.
THIS IS AN OCTAL VALUE.
Format: (User)(Group)(Other) where each
component is a sum of
Read = 4, Write = 2, and Execute = 1. For
example, the value
0755 translates to User read-write, Group and
Other read-only.
(more
on unix-style permissions)
fileSets
List<E> fileSets
- Field fileSets.
includeModuleDirectory
boolean includeModuleDirectory
- Specifies whether the module's finalName should
be prepended to the outputDirectory
values of any fileSets applied to it. Default
value is true. (Since 2.2)
.
excludeSubModuleDirectories
boolean excludeSubModuleDirectories
- Specifies whether sub-module directories below
the current module should be excluded
from fileSets applied to that module. This might
be useful if you only mean to copy
the sources for the exact module list matched by
this ModuleSet, ignoring (or processing
separately) the modules which exist in
directories below the current one.
Default value is true. (Since 2.2)
.
outputDirectoryMapping
String outputDirectoryMapping
- Sets the mapping pattern for all module
base-directories included in this assembly.
NOTE: This field is only used if
includeModuleDirectory == true.
Default is the module's ${artifactId} in
2.2-beta-1, and ${module.artifactId} in subsequent versions.
(Since 2.2)
.
outputDirectory
String outputDirectory
- Sets the output directory relative to the root
of the root directory of the assembly. For
example,
"log" will put the specified files in the log
directory,
directly beneath the root of the archive.
includes
List<E> includes
- Field includes.
excludes
List<E> excludes
- Field excludes.
fileMode
String fileMode
- Similar to a UNIX permission, sets the file mode
of the files included.
THIS IS AN OCTAL VALUE.
Format: (User)(Group)(Other) where each
component is a sum of Read = 4,
Write = 2, and Execute = 1. For example, the
value 0644
translates to User read-write, Group and Other
read-only.
(more
on unix-style permissions)
directoryMode
String directoryMode
- Similar to a UNIX permission, sets the directory
mode of the directories
included.
THIS IS AN OCTAL VALUE.
Format: (User)(Group)(Other) where each
component is a sum of
Read = 4, Write = 2, and Execute = 1. For
example, the value
0755 translates to User read-write, Group and
Other read-only.
(more
on unix-style permissions)
includeMetadata
boolean includeMetadata
- If set to true, this property will trigger the
creation of repository
metadata which will allow the repository to be
used as a functional remote
repository. Default value is false.
groupVersionAlignments
List<E> groupVersionAlignments
- Field groupVersionAlignments.
scope
String scope
- Specifies the scope for artifacts included in
this repository.
Default scope value is "runtime". (Since 2.2)
.
includes
List<E> includes
- Field includes.
excludes
List<E> excludes
- Field excludes.
filtered
boolean filtered
- Whether to filter symbols in the files as they are
unpacked from the archive, using
properties from the build configuration. (Since
2.2)
.
lineEnding
String lineEnding
- Sets the line-endings of the files. (Since 2.2)
Valid values:
- "keep" - Preserve all line
endings
- "unix" - Use Unix-style line
endings
- "lf" - Use a single line-feed line
endings
- "dos" - Use DOS-style line
endings
- "crlf" - Use Carraige-return,
line-feed line endings
useDefaultExcludes
boolean useDefaultExcludes
- Whether standard exclusion patterns, such as
those matching CVS and Subversion
metadata files, should be used when calculating
the files affected by this set.
For backward compatibility, the default value is
true. (Since 2.2)
.
Copyright © 2002-2011 The Apache Software Foundation. All Rights Reserved.