Field Detail

• public static final String PORT_SYSPROPERTY

• protected Thread consoleScanner

  A scanner to check ENTER hits on the console.

• protected String reload

• protected List<Scanner.Listener> scannerListeners

  List of Listeners for the scanner.

Method Detail

• public void applyJettyXml()

• public void configureScanner()

• public void configureWebApplication()

  Subclasses should invoke this to setup basic info on the webapp.

• public JettyPluginServer createServer()

  create a proxy that wraps a particular jetty version Server object.

  Returns:

  The Jetty Plugin Server

• public File findJettyWebXmlFile(File webInfDir)

  Try and find a jetty-web.xml file, using some historical naming conventions if necessary.

  Returns:

  File object to the location of the jetty-web.xml

• public void finishConfigurationBeforeStart()

• @InputFiles public Iterable<File> getAdditionalRuntimeJars()

  Returns the classpath to make available to the web application.

• public Connector[] getConnectors()

• public String getContextPath()

  Returns the context path to use to deploy the web application.

• public Integer getHttpPort()

  Returns the TCP port for Jetty to listen on for incoming HTTP requests.

• @InputFile @Optional public File getJettyConfig()

  Returns the jetty configuration file to use. When null, no configuration file is used.

• @InputFile @Optional public File getOverrideWebXml()

• public String getReload()

  Returns the reload mode, which is either "automatic" or "manual".

  In automatic mode, the web app is scanned for file changes every n seconds, where n is determined by the scanIntervalSeconds property. (Note that scanIntervalSeconds defaults to 0, which disables automatic reloading.) If files changes are detected, the web app is reloaded.

  In manual mode, the web app is reloaded whenever the Enter key is pressed.

• public RequestLog getRequestLog()

• public int getScanIntervalSeconds()

  Returns the interval in seconds between scanning the web app for file changes. If file changes are detected, the web app is reloaded. Only relevant if reload is set to "automatic". Defaults to 0, which disables automatic reloading.

• public Scanner getScanner()

• public List<Scanner.Listener> getScannerListeners()

• public JettyPluginServer getServer()

• public String getStopKey()

  Returns the key to use to stop Jetty.

• public Integer getStopPort()

  Returns the TCP port for Jetty to listen on for stop requests.

• public UserRealm[] getUserRealms()

• public JettyPluginWebAppContext getWebAppConfig()

• @InputFile @Optional public File getWebDefaultXml()

• public boolean isDaemon()

  Specifies whether the Jetty server should run in the background. When true, this task completes as soon as the server has started. When false, this task blocks until the Jetty server is stopped.

• public void restartWebApp(boolean reconfigureScanner)

• public void setAdditionalRuntimeJars(Iterable<File> additionalRuntimeJars)

• public void setConnectors(Connector[] connectors)

• public void setContextPath(String contextPath)

• public void setDaemon(boolean daemon)

• public void setHttpPort(Integer httpPort)

• public void setJettyConfig(File jettyConfig)

• public void setOverrideWebXml(File overrideWebXml)

• public void setReload(String reload)

  Sets the reload mode, which is either "automatic" or "manual".

  In automatic mode, the web app is scanned for file changes every n seconds, where n is determined by the scanIntervalSeconds property. (Note that scanIntervalSeconds defaults to 0, which disables automatic reloading.) If files changes are detected, the web app is reloaded.

  In manual mode, the web app is reloaded whenever the Enter key is pressed.

• public void setRequestLog(RequestLog requestLog)

• public void setScanIntervalSeconds(int scanIntervalSeconds)

  Sets the interval in seconds between scanning the web app for file changes. If file changes are detected, the web app is reloaded. Only relevant if reload is set to "automatic". Defaults to 0, which disables automatic reloading.

• public void setScannerListeners(List<Scanner.Listener> listeners)

• public void setServer(JettyPluginServer server)

• public void setStopKey(String stopKey)

• public void setStopPort(Integer stopPort)

• public void setUserRealms(UserRealm[] userRealms)

• public void setWebAppConfig(JettyPluginWebAppContext webAppConfig)

• public void setWebDefaultXml(File webDefaultXml)

• @TaskAction protected void start()

• protected void startConsoleScanner()

  Run a thread that monitors the console input to detect ENTER hits.

• public void startJetty()

• public void startJettyInternal()

• public void validateConfiguration()