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
org.gradle.api.tasks.AbstractCopyTask
org.gradle.api.tasks.bundling.AbstractArchiveTask
org.gradle.api.tasks.bundling.Zip
org.gradle.jvm.tasks.Jar
org.gradle.api.tasks.bundling.Jar
org.gradle.api.tasks.bundling.War
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, ExtensionAware, Task, PatternFilterable, org.gradle.util.Configurable<Task>
public class War extends Jar
Assembles a WAR archive.

  • Field Details

  • Constructor Details

    • War

      public War()

  • Method Details

    • getWebInf

      @Internal public CopySpec getWebInf()

    • webInf

      public CopySpec webInf(Closure configureClosure)
      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.

      Parameters:
      configureClosure - The closure to execute
      Returns:
      The newly created CopySpec.

    • webInf

      public CopySpec webInf(Action<? super CopySpec> configureAction)
      Adds some content to the WEB-INF directory 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

    • getClasspath

      @Optional @Classpath public FileCollection getClasspath()
      Returns 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.
      Returns:
      The classpath. Returns an empty collection when there is no classpath to include in the WAR.

    • setClasspath

      public void setClasspath(FileCollection classpath)
      Sets the classpath to include in the WAR archive.
      Parameters:
      classpath - The classpath. Must not be null.
      Since:
      4.0

    • setClasspath

      public void setClasspath(Object classpath)
      Sets the classpath to include in the WAR archive.
      Parameters:
      classpath - The classpath. Must not be null.

    • classpath

      public void classpath(Object... classpath)
      Adds files to the classpath to include in the WAR archive.
      Parameters:
      classpath - The files to add. These are evaluated as per Project.files(Object...)

    • getWebXml

      @InputFile @PathSensitive(NONE) @Optional public File getWebXml()
      Returns the web.xml file to include in the WAR archive. When null, no web.xml file is included in the WAR.
      Returns:
      The web.xml file.

    • setWebXml

      public void setWebXml(File webXml)
      Sets the web.xml file to include in the WAR archive. When null, no web.xml file is included in the WAR.
      Parameters:
      webXml - The web.xml file. Maybe null.