org.gradle.api.plugins.jetty

## Class JettyRunWar

- java.lang.Object
- - org.gradle.api.internal.AbstractTask
  - - org.gradle.api.DefaultTask
    - - org.gradle.api.internal.ConventionTask
      - - org.gradle.api.plugins.jetty.AbstractJettyRunTask
        - - org.gradle.api.plugins.jetty.JettyRunWar

- All Implemented Interfaces:
    Comparable<Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.IConventionAware, org.gradle.api.internal.TaskInternal, ExtensionAware, Task, org.gradle.util.Configurable<Task>

      public class JettyRunWar
      extends AbstractJettyRunTask

  Deploys a WAR to an embedded Jetty web container.

  Once started, the web container can be configured to run continuously, scanning for changes to the war file and automatically performing a hot redeploy when necessary.

- - ### Nested Class Summary

    - ### Nested classes/interfaces inherited from interface org.gradle.api.Task

      `Task.Namer`

  - ### Field Summary

    - ### Fields inherited from class org.gradle.api.plugins.jetty.AbstractJettyRunTask

      `consoleScanner, PORT_SYSPROPERTY, reload, scannerListeners`

    - ### Fields inherited from interface org.gradle.api.Task

      `TASK_ACTION, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `JettyRunWar()`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `applyJettyXml()`
    `void` | `configureScanner()`
    `void` | `configureWebApplication()` Subclasses should invoke this to setup basic info on the webapp.
    `org.gradle.api.plugins.jetty.internal.JettyPluginServer` | `createServer()` create a proxy that wraps a particular jetty version Server object.
    `void` | `finishConfigurationBeforeStart()`
    `File` | `getWebApp()` Returns the web application to deploy.
    `void` | `restartWebApp(boolean reconfigureScanner)`
    `void` | `setWebApp(File webApp)`
    `void` | `validateConfiguration()`

    - ### Methods inherited from class org.gradle.api.plugins.jetty.AbstractJettyRunTask

      `findJettyWebXmlFile, getAdditionalRuntimeJars, getConnectors, getContextPath, getHttpPort, getJettyConfig, getOverrideWebXml, getReload, getRequestLog, getScanIntervalSeconds, getScanner, getScannerListeners, getServer, getStopKey, getStopPort, getUserRealms, getWebAppConfig, getWebDefaultXml, isDaemon, setAdditionalRuntimeJars, setConnectors, setContextPath, setDaemon, setHttpPort, setJettyConfig, setOverrideWebXml, setReload, setRequestLog, setScanIntervalSeconds, setScannerListeners, setServer, setStopKey, setStopPort, setUserRealms, setWebAppConfig, setWebDefaultXml, start, startConsoleScanner, startJetty, startJettyInternal`

    - ### Methods inherited from class org.gradle.api.internal.ConventionTask

      `conventionMapping, conventionMapping, getConventionMapping`

    - ### Methods inherited from class org.gradle.api.internal.AbstractTask

      `addValidator, appendParallelSafeAction, compareTo, configure, deleteAllActions, dependsOn, dependsOnTaskDidWork, doFirst, doFirst, doLast, doLast, execute, finalizedBy, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDidWork, getEnabled, getExecuter, getExtensions, getFinalizedBy, getGroup, getImpliesSubProjects, getInputs, getLogger, getLogging, getMustRunAfter, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getShouldRunAfter, getStandardOutputCapture, getState, getTaskActions, getTaskDependencies, getTemporaryDir, getTemporaryDirFactory, getValidators, hasProperty, injectIntoNewInstance, isEnabled, isHasCustomActions, leftShift, mustRunAfter, onlyIf, onlyIf, prependParallelSafeAction, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setExecuter, setFinalizedBy, setGroup, setImpliesSubProjects, setMustRunAfter, setName, setOnlyIf, setOnlyIf, setProject, setProperty, setShouldRunAfter, shouldRunAfter, toString`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- - ### Constructor Detail

    - #### JettyRunWar

          public JettyRunWar()

  - ### Method Detail

    - #### configureWebApplication

          public void configureWebApplication()
                                       throws Exception

      Description copied from class: `AbstractJettyRunTask`
      Subclasses should invoke this to setup basic info on the webapp.
      Overrides:
        `configureWebApplication` in class `AbstractJettyRunTask`
      Throws:
        `Exception`

    - #### validateConfiguration

          public void validateConfiguration()

      Specified by:
        `validateConfiguration` in class `AbstractJettyRunTask`

    - #### configureScanner

          public void configureScanner()

      Specified by:
        `configureScanner` in class `AbstractJettyRunTask`

    - #### restartWebApp

          public void restartWebApp(boolean reconfigureScanner)
                             throws Exception

      Specified by:
        `restartWebApp` in class `AbstractJettyRunTask`
      Throws:
        `Exception`

    - #### finishConfigurationBeforeStart

          public void finishConfigurationBeforeStart()

      Specified by:
        `finishConfigurationBeforeStart` in class `AbstractJettyRunTask`

    - #### getWebApp

          @InputFile
          public File getWebApp()

      Returns the web application to deploy.

    - #### setWebApp

          public void setWebApp(File webApp)

    - #### applyJettyXml

          public void applyJettyXml()
                             throws Exception

      Specified by:
        `applyJettyXml` in class `AbstractJettyRunTask`
      Throws:
        `Exception`

    - #### createServer

          public org.gradle.api.plugins.jetty.internal.JettyPluginServer createServer()
                                                                               throws Exception

      Description copied from class: `AbstractJettyRunTask`
      create a proxy that wraps a particular jetty version Server object.
      Specified by:
        `createServer` in class `AbstractJettyRunTask`
      Returns:
        The Jetty Plugin Server
      Throws:
        `Exception`