org.beigesoft.ajetty.BootStrap Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of a-jetty-base Show documentation
A-Jetty Base can run on Android Java as well as on standard Java 7+ and it can run precompiled JSP/JSTL.
The newest version!
/*
BSD 2-Clause License

Copyright (c) 2019, Beigesoft™
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
  list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package org.beigesoft.ajetty;

import java.io.File;

import org.eclipse.jetty.server.Server;
import org.eclipse.jetty.server.Connector;
import org.eclipse.jetty.server.ServerConnector;
import org.eclipse.jetty.server.Handler;
import org.eclipse.jetty.server.handler.DefaultHandler;
import org.eclipse.jetty.server.handler.HandlerCollection;
import org.eclipse.jetty.server.handler.ContextHandlerCollection;
import org.eclipse.jetty.deploy.DeploymentManager;
import org.eclipse.jetty.deploy.providers.WebAppProvider;
import org.eclipse.jetty.deploy.PropertiesConfigurationManager;

import org.beigesoft.afactory.IFactoryAppBeans;

/**
 * 
 * BootStrap for Jetty for Android configured as minimum server
 * with WebAppDeployer that deploy ordinal non-JSP web-app
 * (JSP/JSTL must be precompiled into servlets) that must be unpacked
 * into [jetty-base]/webapps.
 * It must be follow working directory(jetty:base) containing:
 * 
 * webdefault.xml
 * webapps
 * 
 * 
 *
 * @author Yury Demidenko
 */
public class BootStrap {

  /**
   * Factory app-beans.
   **/
  private IFactoryAppBeans factoryAppBeans;

  /**
   * Port.
   **/
  private Integer port = 8080;

  /**
   * Jetty base.
   **/
  private String jettyBase = "";

  /**
   * Jetty.
   **/
  private Server server;

  /**
   * Is started.
   **/
  private boolean isStarted = false;

  /**
   * Deployment Manager.
   **/
  private DeploymentManager deploymentManager;

  /**
   * Jetty connector.
   **/
  private ServerConnector connector;

  /**
   * Create and configure server.
   * @throws Exception an Exception
   **/
  public final void createServer() throws Exception {
    // Create a basic jetty server object that will listen on port 8080.
    // Note that if you set this to port 0 then a randomly available port
    // will be assigned that you can either look in the logs for the port,
    // or programmatically obtain it for use in test cases.
    this.server = new Server();
    this.connector = new ServerConnector(server);
    this.connector.setPort(this.port);
    this.connector.setHost("127.0.0.1");
    this.server.setConnectors(new Connector[] {this.connector});
    // Handlers:
    HandlerCollection handlers = new HandlerCollection();
    DefaultHandler defaultHandler = new DefaultHandler();
    ContextHandlerCollection contextHandlerCollection =
      new ContextHandlerCollection();
    handlers.setHandlers(new Handler[] {contextHandlerCollection,
      defaultHandler }); // !!! defaultHandler must be second
    this.server.setHandler(handlers);
    // Create the deployment manager:
    this.deploymentManager = new DeploymentManager();
    this.deploymentManager.setContexts(contextHandlerCollection);
    WebAppProvider webAppProvider = new WebAppProvider();
    webAppProvider.setFactoryAppBeans(this.factoryAppBeans);
    webAppProvider.setMonitoredDirName(jettyBase + File.separator + "webapps");
    webAppProvider.setDefaultsDescriptor(jettyBase + File.separator
      + "webdefault.xml");
    webAppProvider.setExtractWars(false);
    PropertiesConfigurationManager confManager =
      new PropertiesConfigurationManager();
    webAppProvider.setConfigurationManager(confManager);
    this.deploymentManager.addAppProvider(webAppProvider);
    this.server.addBean(deploymentManager);
  }


  /**
   * Start server.
   * @throws Exception an Exception
   **/
  public final void startServer() throws Exception {
    this.connector.setPort(this.port);
    this.server.start();
    this.isStarted = true;
  }

  /**
   * Stop server.
   * @throws Exception an Exception
   **/
  public final void stopServer() throws Exception {
    this.server.stop();
    this.isStarted = false;
  }

  /**
   * This start preconfigured Jetty on non-Android OS.
   * It may takes up to tho parameters: port and jetty:base.
   * Example:
   * 
   * java -jar a-jetty-base.jar jetty:base=/home/my/a-jetty
   * or
   * java -jar a-jetty-base.jar jetty:base=/home/my/a-jetty port=8080
   * 
   * 
   * @param pArgs arguments
   **/
  public static final void main(final String[] pArgs) {
    try {
      BootStrap bootStrap = new BootStrap();
      for (String arg : pArgs) {
        if (arg.contains("port=")) {
          String strPort = arg.replace("port=", "").trim();
          bootStrap.setPort(Integer.parseInt(strPort));
        } else if (arg.contains("jetty:base=")) {
          bootStrap.setJettyBase(arg.replace("jetty:base=", "").trim());
        }
      }
      bootStrap.setFactoryAppBeans(new FctApp());
      bootStrap.createServer();
      bootStrap.startServer();
      // The use of server.join() the will make the current thread join and
      // wait until the server is done executing.
      // See http://docs.oracle.com/javase/7/docs/api/java/lang/Thread.html#join
      bootStrap.getServer().join();
    } catch (Exception e) {
      e.printStackTrace();
    }
  }

  //Simple getters and setters:
  /**
   * Getter for port.
   * @return Integer
   **/
  public final Integer getPort() {
    return this.port;
  }

  /**
   * Setter for port.
   * @param pPort reference
   **/
  public final void setPort(final Integer pPort) {
    this.port = pPort;
  }

  /**
   * Getter for jettyBase.
   * @return String
   **/
  public final String getJettyBase() {
    return this.jettyBase;
  }

  /**
   * Setter for jettyBase.
   * @param pJettyBase reference
   **/
  public final void setJettyBase(final String pJettyBase) {
    this.jettyBase = pJettyBase;
  }

  /**
   * Getter for server.
   * @return Server
   **/
  public final Server getServer() {
    return this.server;
  }

  /**
   * Getter for connector.
   * @return ServerConnector
   **/
  public final ServerConnector getConnector() {
    return this.connector;
  }

  /**
   * Getter for isStarted.
   * @return boolean
   **/
  public final boolean getIsStarted() {
    return this.isStarted;
  }

  /**
   * Getter for factoryAppBeans.
   * @return IFactoryAppBeans
   **/
  public final IFactoryAppBeans getFactoryAppBeans() {
    return this.factoryAppBeans;
  }

  /**
   * Setter for factoryAppBeans.
   * @param pFactoryAppBeans reference
   **/
  public final void setFactoryAppBeans(
    final IFactoryAppBeans pFactoryAppBeans) {
    this.factoryAppBeans = pFactoryAppBeans;
  }

  /**
   * Getter for deploymentManager.
   * @return DeploymentManager
   **/
  public final DeploymentManager getDeploymentManager() {
    return this.deploymentManager;
  }
}