org.avaje.jettyrunner.JettyRun Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of avaje-jetty-runner Show documentation
avaje-jetty-runner
There is a newer version: 2.3.1
package org.avaje.jettyrunner;


/**
 * Provides a Jetty Runner that can be used in an IDE to run a local expanded war.
 * 
 * By default this assumes a maven webapp structure with a 'resource base' of "src/main/webapp".
 * 
 */
public class JettyRun extends BaseRunner {

  /**
   * The path to the webapp resource base ("src/main/webapp" by default).
   */
  protected String resourceBase;

  /**
   * Construct reading system properties for http port etc.
   */
  public JettyRun() {
    this.resourceBase = System.getProperty(WEBAPP_RESOURCE_BASE,"src/main/webapp");
    // In IDE can use this to shutdown in a console window
    this.useStdInShutdown = true;
  }
  
  /**
   * Configure and run the webapp using jetty.
   */
  public void runServer() {

    setDefaultLogbackConfig();

    createWebAppContext();

    setupForExpandedWar();

    startServer();
  }

  /**
   * If logback.configurationFile is not set then setup to look for logback.xml in the current working directory.
   */
  protected void setDefaultLogbackConfig() {

    String logbackFile = System.getProperty("logback.configurationFile");
    if (logbackFile == null) {
      // set default behaviour to look in current working directory for logback.xml
      System.setProperty("logback.configurationFile", "logback.xml");
    }
  }

  /**
   * Setup for an expanded webapp with resource base as a relative path.
   */
  protected void setupForExpandedWar() {

    webapp.setServerClasses(getServerClasses());
    webapp.setDescriptor(webapp + "/WEB-INF/web.xml");
    webapp.setResourceBase(resourceBase);
    webapp.setParentLoaderPriority(false);
  }

  /**
   * Return the resource base.
   */
  public String getResourceBase() {
      return resourceBase;
  }
  
  /**
   * Set the resource base.
   */
  public JettyRun setResourceBase(String resourceBase) {
    this.resourceBase = resourceBase;
    return this;
  }

  /**
   * Set the http port to use.
   */
  public JettyRun setHttpPort(int httpPort) {
    this.httpPort = httpPort;
    return this;
  }
  
 /**
  * Set the context path to use.
  */
  public JettyRun setContextPath(String contextPath) {
    this.contextPath = contextPath;
    return this;
  }

  /**
   * Set the secure cookies setting.
   */
  public JettyRun setSecureCookies(boolean secureCookies) {
    this.secureCookies = secureCookies;
    return this;
  }
}