Package org.gradle.api.tasks.bundling
Class War
java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
org.gradle.api.internal.ConventionTask
- All Implemented Interfaces:
- Comparable<Task>,- ContentFilterable,- CopyProcessingSpec,- CopySourceSpec,- CopySpec,- org.gradle.api.internal.DynamicObjectAware,- org.gradle.api.internal.file.copy.CopySpecSource,- org.gradle.api.internal.IConventionAware,- org.gradle.api.internal.TaskInternal,- Named,- ExtensionAware,- Task,- PatternFilterable,- Configurable<Task>
Assembles a WAR archive.
- 
Nested Class SummaryNested classes/interfaces inherited from interface org.gradle.api.TaskTask.Namer
- 
Field SummaryFieldsFields inherited from class org.gradle.jvm.tasks.JarDEFAULT_EXTENSIONFields inherited from class org.gradle.api.tasks.bundling.ZipZIP_EXTENSIONFields inherited from interface org.gradle.api.TaskTASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidAdds files to the classpath to include in the WAR archive.Returns the classpath to include in the WAR archive.Returns the app directory of the task.Returns theweb.xmlfile to include in the WAR archive.voidsetClasspath(Object classpath) Sets the classpath to include in the WAR archive.voidsetClasspath(FileCollection classpath) Sets the classpath to include in the WAR archive.voidSets theweb.xmlfile to include in the WAR archive.Adds some content to theWEB-INFdirectory for this WAR archive.Adds some content to theWEB-INFdirectory for this WAR archive.Methods inherited from class org.gradle.jvm.tasks.JargetManifest, getManifestContentCharset, getMetadataCharset, getMetaInf, manifest, metaInf, metaInf, setManifest, setManifestContentCharset, setMetadataCharsetMethods inherited from class org.gradle.api.tasks.bundling.ZipcreateCopyAction, getCompressor, getEntryCompression, isZip64, setEntryCompression, setZip64Methods inherited from class org.gradle.api.tasks.bundling.AbstractArchiveTaskcreateCopyActionExecuter, getArchiveAppendix, getArchiveBaseName, getArchiveClassifier, getArchiveExtension, getArchiveFile, getArchiveFileName, getArchivePath, getArchiveVersion, getDestinationDirectory, into, into, into, isPreserveFileTimestamps, isReproducibleFileOrder, setPreserveFileTimestamps, setReproducibleFileOrderMethods inherited from class org.gradle.api.tasks.AbstractCopyTaskcopy, createRootSpec, dirPermissions, eachFile, eachFile, exclude, exclude, exclude, exclude, expand, expand, filePermissions, filesMatching, filesMatching, filesNotMatching, filesNotMatching, filter, filter, filter, filter, from, from, from, getDirectoryFileTreeFactory, getDirMode, getDirPermissions, getDocumentationRegistry, getDuplicatesStrategy, getExcludes, getFileLookup, getFileMode, getFilePermissions, getFileResolver, getFileSystem, getFilteringCharset, getIncludeEmptyDirs, getIncludes, getInstantiator, getMainSpec, getPropertyFactory, getRootSpec, getSource, include, include, include, include, isCaseSensitive, rename, rename, rename, rename, setCaseSensitive, setDirMode, setDuplicatesStrategy, setExcludes, setFileMode, setFilteringCharset, setIncludeEmptyDirs, setIncludes, withMethods inherited from class org.gradle.api.internal.ConventionTaskconventionMapping, conventionMapping, getConventionMappingMethods inherited from class org.gradle.api.DefaultTaskcompareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesServiceMethods inherited from class org.gradle.api.internal.AbstractTaskacceptServiceReferences, appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjectsMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.gradle.api.TaskdoNotTrackState, getConvention, notCompatibleWithConfigurationCache
- 
Field Details- 
WAR_EXTENSION- See Also:
 
 
- 
- 
Constructor Details- 
Warpublic War()
 
- 
- 
Method Details- 
getObjectFactory- Overrides:
- getObjectFactoryin class- AbstractCopyTask
 
- 
getWebInf
- 
webInfAdds some content to theWEB-INFdirectory for this WAR archive.The given closure is executed to configure a CopySpec. TheCopySpecis passed to the closure as its delegate.- Parameters:
- configureClosure- The closure to execute
- Returns:
- The newly created CopySpec.
 
- 
webInfAdds some content to theWEB-INFdirectory for this WAR archive.The given action is executed to configure a CopySpec.- Parameters:
- configureAction- The action to execute
- Returns:
- The newly created CopySpec.
- Since:
- 3.5
 
- 
getClasspathReturns the classpath to include in the WAR archive. Any JAR or ZIP files in this classpath are included in theWEB-INF/libdirectory. Any directories in this classpath are included in theWEB-INF/classesdirectory.- Returns:
- The classpath. Returns an empty collection when there is no classpath to include in the WAR.
 
- 
setClasspathSets the classpath to include in the WAR archive.- Parameters:
- classpath- The classpath. Must not be null.
- Since:
- 4.0
 
- 
setClasspathSets the classpath to include in the WAR archive.- Parameters:
- classpath- The classpath. Must not be null.
 
- 
classpathAdds files to the classpath to include in the WAR archive.- Parameters:
- classpath- The files to add. These are evaluated as per- Project.files(Object...)
 
- 
getWebXmlReturns theweb.xmlfile to include in the WAR archive. Whennull, noweb.xmlfile is included in the WAR.- Returns:
- The web.xmlfile.
 
- 
setWebXmlSets theweb.xmlfile to include in the WAR archive. Whennull, noweb.xmlfile is included in the WAR.- Parameters:
- webXml- The- web.xmlfile. Maybe null.
 
- 
getWebAppDirectoryReturns the app directory of the task. Added to the output web archive by default.The warplugin sets the default value for allWartasks tosrc/main/webappand adds it as a task input.Note, that if the warplugin is not applied then this property is ignored. In that case, clients can manually set an app directory as a task input.- Returns:
- The app directory.
- Since:
- 7.1
 
 
-