API Documentation: | War |
---|
Assembles a WAR archive.
Property | Description |
appendix | The appendix part of the archive name, if any. |
archiveName | The archive name. If the name has not been explicitly set, the pattern for the name is:
|
archivePath | The path where the archive is constructed. The path is simply the |
baseName | The base name of the archive. |
caseSensitive | Specifies whether case-sensitive pattern matching should be used. |
classifier | The classifier part of the archive name, if any. |
classpath | The classpath to include in the WAR archive. Any JAR or ZIP files in this classpath are included in the
|
destinationDir | The directory where the archive is generated into. |
dirMode | The Unix permissions to use for the target directories. It is dependent on the copy action implementation whether these permissions will actually be applied. |
excludes | The set of exclude patterns. |
extension | The extension part of the archive name. |
fileMode | The Unix permissions to use for the target files. It is dependent on the copy action implementation whether these permissions will actually be applied. |
includeEmptyDirs | Tells if empty target directories will be included in the copy. |
includes | The set of include patterns. |
manifest | The manifest for this JAR archive. |
source | The source files for this task. |
version | The version part of the archive name, if any. |
webXml | The |
String
archiveName
The archive name. If the name has not been explicitly set, the pattern for the name is:
[baseName]-[appendix]-[version]-[classifier].[extension]
- Default with
war
plugin: ${baseName}
-${appendix}
-${version}
-${classifier}
.${extension}
File
archivePath
(read-only)
The path where the archive is constructed. The path is simply the destinationDir
plus the archiveName
.
- Default with
war
plugin: ${destinationDir}
/${archiveName}
Specifies whether case-sensitive pattern matching should be used.
- Default with
war
plugin: true
FileCollection
classpath
The classpath to include in the WAR archive. Any JAR or ZIP files in this classpath are included in the
WEB-INF/lib
directory. Any directories in this classpath are included in the WEB-INF/classes
directory.
- Default with
war
plugin: project.configurations.runtime - project.configurations.providedRuntime
File
destinationDir
The directory where the archive is generated into.
- Default with
war
plugin: project.libsDir
The Unix permissions to use for the target directories. It is dependent on the copy action implementation whether these permissions will actually be applied.
- Default with
war
plugin: 0755
The Unix permissions to use for the target files. It is dependent on the copy action implementation whether these permissions will actually be applied.
- Default with
war
plugin: 0644
Tells if empty target directories will be included in the copy.
- Default with
war
plugin: true
Manifest
manifest
The manifest for this JAR archive.
FileCollection
source
(read-only)
The source files for this task.
- Default with
war
plugin: [project.webAppDir]
File
webXml
The web.xml
file to include in the WAR archive. When null
, no web.xml
file is
included in the WAR.
- Default with
war
plugin: null
Method | Description |
classpath(classpath) | Adds files to the classpath to include in the WAR archive. |
eachFile(closure) | Adds an action to be applied to each file as it about to be copied into its destination. The given closure is
called with a |
eachFile(action) | Adds an action to be applied to each file as it is about to be copied into its destination. The action can change the destination path of the file, filter the contents of the file, or exclude the file from the result entirely. Actions are executed in the order added, and are inherited from the parent spec. |
exclude(excludeSpec) | Adds an exclude spec. This method may be called multiple times to append new specs.The given closure is passed a
|
exclude(excludes) | Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed. |
exclude(excludes) | Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed. |
exclude(excludeSpec) | Adds an exclude spec. This method may be called multiple times to append new specs. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed. |
expand(properties) | Expands property references in each file as it is copied. More specifically, each file is transformed using
Groovy's |
filter(closure) | Adds a content filter based on the provided closure. The Closure will be called with each line (stripped of line endings) and should return a String to replace the line. |
filter(filterType) | Adds a content filter to be used during the copy. Multiple calls to filter, add additional filters to the
filter chain. Each filter should implement |
filter(properties, filterType) | Adds a content filter to be used during the copy. Multiple calls to filter, add additional filters to the
filter chain. Each filter should implement |
from(sourcePath, c) | Specifies the source files or directories for a copy and creates a child |
from(sourcePaths) | Specifies source files or directories for a copy. The given paths are evaluated as for |
include(includeSpec) | Adds an include spec. This method may be called multiple times to append new specs. The given closure is passed a
|
include(includes) | Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns to be processed. |
include(includes) | Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns to be processed. |
include(includeSpec) | Adds an include spec. This method may be called multiple times to append new specs. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns or specs to be included. |
into(destPath) | Specifies the destination directory *inside* the archive for the files.
The destination is evaluated as for |
into(destPath, configureClosure) | Creates and configures a child |
metaInf(configureClosure) | Adds content to this JAR archive's META-INF directory. |
rename(closure) | Renames a source file to a different relative location under the target directory. The closure will be called with a single parameter, the name of the file. The closure should return a String object with a new target name. The closure may return null, in which case the original name will be used. |
rename(sourceRegEx, replaceWith) | Renames files based on a regular expression. Uses java.util.regex type of regular expressions. Note that the replace string should use the '$1' syntax to refer to capture groups in the source regular expression. Files that do not match the source regular expression will be copied with the original name. |
rename(sourceRegEx, replaceWith) | Renames files based on a regular expression. See |
webInf(configureClosure) | Adds some content to the |
with(sourceSpecs) | Adds the given specs as a child of this spec. |
void
classpath
(Object
...
classpath)
Object
...Adds files to the classpath to include in the WAR archive.
AbstractCopyTask
eachFile
(Closure
closure)
Adds an action to be applied to each file as it about to be copied into its destination. The given closure is
called with a FileCopyDetails
as its parameter. Actions are executed in the order
added, and are inherited from the parent spec.
AbstractCopyTask
eachFile
(Action
<? super FileCopyDetails
>
action)
Action
<? super FileCopyDetails
>Adds an action to be applied to each file as it is about to be copied into its destination. The action can change the destination path of the file, filter the contents of the file, or exclude the file from the result entirely. Actions are executed in the order added, and are inherited from the parent spec.
AbstractCopyTask
exclude
(Closure
excludeSpec)
Adds an exclude spec. This method may be called multiple times to append new specs.The given closure is passed a
FileTreeElement
as its parameter.
If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match
any exclude pattern to be processed.
AbstractCopyTask
exclude
(Iterable
<String
>
excludes)
Iterable
<String
>Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed.
AbstractCopyTask
exclude
(String
...
excludes)
String
...Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed.
AbstractCopyTask
exclude
(Spec
<FileTreeElement
>
excludeSpec)
Spec
<FileTreeElement
>Adds an exclude spec. This method may be called multiple times to append new specs. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed.
AbstractCopyTask
expand
(Map
<String
, ?>
properties)
Map
<String
, ?>Expands property references in each file as it is copied. More specifically, each file is transformed using
Groovy's SimpleTemplateEngine
. This means you can use simple property references, such as
$property
or ${property}
in the file. You can also include arbitrary Groovy code in the
file, such as ${version ?: 'unknown'}
or ${classpath*.name.join(' ')}
AbstractCopyTask
filter
(Closure
closure)
Adds a content filter based on the provided closure. The Closure will be called with each line (stripped of line endings) and should return a String to replace the line.
AbstractCopyTask
filter
(Class
<? extends FilterReader
>
filterType)
Class
<? extends FilterReader
>Adds a content filter to be used during the copy. Multiple calls to filter, add additional filters to the
filter chain. Each filter should implement java.io.FilterReader
. Include org.apache.tools.ant.filters.*
for access to all the standard Ant filters.
Examples:
filter(StripJavaComments) filter(com.mycompany.project.CustomFilter)
AbstractCopyTask
filter
(Map
<String
, ?>
properties, Class
<? extends FilterReader
>
filterType)
Map
<String
, ?>Class
<? extends FilterReader
>Adds a content filter to be used during the copy. Multiple calls to filter, add additional filters to the
filter chain. Each filter should implement java.io.FilterReader
. Include org.apache.tools.ant.filters.*
for access to all the standard Ant filters.
Filter properties may be specified using groovy map syntax.
Examples:
filter(HeadFilter, lines:25, skip:2) filter(ReplaceTokens, tokens:[copyright:'2009', version:'2.3.1'])
AbstractCopyTask
from
(Object
sourcePath, Closure
c)
Specifies the source files or directories for a copy and creates a child CopySourceSpec
. The given source
path is evaluated as for Project.files()
.
AbstractCopyTask
from
(Object
...
sourcePaths)
Object
...Specifies source files or directories for a copy. The given paths are evaluated as for Project.files()
.
AbstractCopyTask
include
(Closure
includeSpec)
Adds an include spec. This method may be called multiple times to append new specs. The given closure is passed a
FileTreeElement
as its parameter.
If includes are not provided, then all files in this container will be included. If includes are provided, then a
file must match at least one of the include patterns or specs to be included.
AbstractCopyTask
include
(Iterable
<String
>
includes)
Iterable
<String
>Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns to be processed.
AbstractCopyTask
include
(String
...
includes)
String
...Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns to be processed.
AbstractCopyTask
include
(Spec
<FileTreeElement
>
includeSpec)
Spec
<FileTreeElement
>Adds an include spec. This method may be called multiple times to append new specs. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns or specs to be included.
AbstractArchiveTask
into
(Object
destPath)
Specifies the destination directory *inside* the archive for the files.
The destination is evaluated as for Project.file()
.
Don't mix it up with AbstractArchiveTask.getDestinationDir()
which specifies the output directory for the archive.
AbstractArchiveTask
into
(Object
destPath, Closure
configureClosure)
Creates and configures a child CopySpec
with a destination directory *inside* the archive for the files.
The destination is evaluated as for Project.file()
.
Don't mix it up with AbstractArchiveTask.getDestinationDir()
which specifies the output directory for the archive.
Adds content to this JAR archive's META-INF directory.
The given closure is executed to configure a CopySpec
. The CopySpec
is passed to the closure
as its delegate.
AbstractCopyTask
rename
(Closure
closure)
Renames a source file to a different relative location under the target directory. The closure will be called with a single parameter, the name of the file. The closure should return a String object with a new target name. The closure may return null, in which case the original name will be used.
AbstractCopyTask
rename
(String
sourceRegEx, String
replaceWith)
Renames files based on a regular expression. Uses java.util.regex type of regular expressions. Note that the replace string should use the '$1' syntax to refer to capture groups in the source regular expression. Files that do not match the source regular expression will be copied with the original name.
Example:
rename '(.*)_OEM_BLUE_(.*)', '$1$2'
would map the file 'style_OEM_BLUE_.css' to 'style.css'
AbstractCopyTask
rename
(Pattern
sourceRegEx, String
replaceWith)
Renames files based on a regular expression. See CopyProcessingSpec.rename()
.
Adds some content to the WEB-INF
directory for this WAR archive.
The given closure is executed to configure a CopySpec
. The CopySpec
is passed to the closure
as its delegate.