org.eclipse.jetty.start.Main Maven / Gradle / Ivy
//
// ========================================================================
// Copyright (c) 1995-2017 Mort Bay Consulting Pty. Ltd.
// ------------------------------------------------------------------------
// All rights reserved. This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v1.0
// and Apache License v2.0 which accompanies this distribution.
//
// The Eclipse Public License is available at
// http://www.eclipse.org/legal/epl-v10.html
//
// The Apache License v2.0 is available at
// http://www.opensource.org/licenses/apache2.0.php
//
// You may elect to redistribute this code under either of these licenses.
// ========================================================================
//
package org.eclipse.jetty.start;
import static org.eclipse.jetty.start.UsageException.ERR_BAD_GRAPH;
import static org.eclipse.jetty.start.UsageException.ERR_BAD_STOP_PROPS;
import static org.eclipse.jetty.start.UsageException.ERR_INVOKE_MAIN;
import static org.eclipse.jetty.start.UsageException.ERR_NOT_STOPPED;
import static org.eclipse.jetty.start.UsageException.ERR_UNKNOWN;
import java.io.BufferedReader;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.LineNumberReader;
import java.io.OutputStream;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.net.ConnectException;
import java.net.InetAddress;
import java.net.Socket;
import java.net.SocketTimeoutException;
import java.nio.file.Path;
import java.util.List;
import java.util.Locale;
import org.eclipse.jetty.start.config.CommandLineConfigSource;
import org.eclipse.jetty.start.graph.GraphException;
import org.eclipse.jetty.start.graph.Selection;
/**
* Main start class.
*
* This class is intended to be the main class listed in the MANIFEST.MF of the start.jar archive. It allows the Jetty Application server to be started with the
* command "java -jar start.jar".
*
* Argument processing steps:
*
* - Directory Location: jetty.home=[directory] (the jetty.home location)
* - Directory Location: jetty.base=[directory] (the jetty.base location)
* - Start Logging behavior: --debug (debugging enabled)
* - Start Logging behavior: --start-log-file=logs/start.log (output start logs to logs/start.log location)
* - Module Resolution
* - Properties Resolution
* - Present Optional Informational Options
* - Normal Startup
*
*/
public class Main
{
private static final int EXIT_USAGE = 1;
public static void main(String[] args)
{
try
{
Main main = new Main();
StartArgs startArgs = main.processCommandLine(args);
main.start(startArgs);
}
catch (UsageException e)
{
System.err.println(e.getMessage());
usageExit(e.getCause(),e.getExitCode());
}
catch (Throwable e)
{
usageExit(e,UsageException.ERR_UNKNOWN);
}
}
static void usageExit(int exit)
{
usageExit(null,exit);
}
static void usageExit(Throwable t, int exit)
{
if (t != null)
{
t.printStackTrace(System.err);
}
System.err.println();
System.err.println("Usage: java -jar start.jar [options] [properties] [configs]");
System.err.println(" java -jar start.jar --help # for more information");
System.exit(exit);
}
private BaseHome baseHome;
private StartArgs startupArgs;
public Main() throws IOException
{
}
private void copyInThread(final InputStream in, final OutputStream out)
{
new Thread(new Runnable()
{
@Override
public void run()
{
try
{
byte[] buf = new byte[1024];
int len = in.read(buf);
while (len > 0)
{
out.write(buf,0,len);
len = in.read(buf);
}
}
catch (IOException e)
{
// e.printStackTrace();
}
}
}).start();
}
private void dumpClasspathWithVersions(Classpath classpath)
{
StartLog.endStartLog();
System.out.println();
System.out.println("Jetty Server Classpath:");
System.out.println("-----------------------");
if (classpath.count() == 0)
{
System.out.println("No classpath entries and/or version information available show.");
return;
}
System.out.println("Version Information on " + classpath.count() + " entr" + ((classpath.count() > 1)?"ies":"y") + " in the classpath.");
System.out.println("Note: order presented here is how they would appear on the classpath.");
System.out.println(" changes to the --module=name command line options will be reflected here.");
int i = 0;
for (File element : classpath.getElements())
{
System.out.printf("%2d: %24s | %s\n",i++,getVersion(element),baseHome.toShortForm(element));
}
}
public BaseHome getBaseHome()
{
return baseHome;
}
private String getVersion(File element)
{
if (element.isDirectory())
{
return "(dir)";
}
if (element.isFile())
{
String name = element.getName().toLowerCase(Locale.ENGLISH);
if (name.endsWith(".jar"))
{
return JarVersion.getVersion(element);
}
}
return "";
}
public void invokeMain(ClassLoader classloader, StartArgs args) throws IllegalAccessException, InvocationTargetException, NoSuchMethodException, ClassNotFoundException, IOException
{
Class invoked_class = null;
String mainclass = args.getMainClassname();
try
{
invoked_class = classloader.loadClass(mainclass);
}
catch (ClassNotFoundException e)
{
System.out.println("WARNING: Nothing to start, exiting ...");
StartLog.debug(e);
usageExit(ERR_INVOKE_MAIN);
return;
}
StartLog.debug("%s - %s",invoked_class,invoked_class.getPackage().getImplementationVersion());
CommandLineBuilder cmd = args.getMainArgs(baseHome,false);
String argArray[] = cmd.getArgs().toArray(new String[0]);
StartLog.debug("Command Line Args: %s",cmd.toString());
Class[] method_param_types = new Class[]
{ argArray.getClass() };
Method main = invoked_class.getDeclaredMethod("main",method_param_types);
Object[] method_params = new Object[] { argArray };
StartLog.endStartLog();
main.invoke(null,method_params);
}
public void listConfig(StartArgs args)
{
StartLog.endStartLog();
// Dump Jetty Home / Base
args.dumpEnvironment(baseHome);
// Dump JVM Args
args.dumpJvmArgs();
// Dump System Properties
args.dumpSystemProperties();
// Dump Properties
args.dumpProperties();
// Dump Classpath
dumpClasspathWithVersions(args.getClasspath());
// Dump Resolved XMLs
args.dumpActiveXmls(baseHome);
}
public void listModules(StartArgs args)
{
StartLog.endStartLog();
System.out.println();
System.out.println("Jetty All Available Modules:");
System.out.println("----------------------------");
args.getAllModules().dump();
// Dump Enabled Modules
System.out.println();
System.out.println("Jetty Selected Module Ordering:");
System.out.println("-------------------------------");
Modules modules = args.getAllModules();
modules.dumpSelected();
}
/**
* Convenience for processCommandLine(cmdLine.toArray(new String[cmdLine.size()]))
* @param cmdLine the command line
* @return the start args parsed from the command line
* @throws Exception if unable to process the command line
*/
public StartArgs processCommandLine(List cmdLine) throws Exception
{
return this.processCommandLine(cmdLine.toArray(new String[cmdLine.size()]));
}
public StartArgs processCommandLine(String[] cmdLine) throws Exception
{
// Processing Order is important!
// ------------------------------------------------------------
// 1) Configuration Locations
CommandLineConfigSource cmdLineSource = new CommandLineConfigSource(cmdLine);
baseHome = new BaseHome(cmdLineSource);
StartLog.debug("jetty.home=%s",baseHome.getHome());
StartLog.debug("jetty.base=%s",baseHome.getBase());
// ------------------------------------------------------------
// 2) Parse everything provided.
// This would be the directory information +
// the various start inis
// and then the raw command line arguments
StartLog.debug("Parsing collected arguments");
StartArgs args = new StartArgs();
args.parse(baseHome.getConfigSources());
try
{
// ------------------------------------------------------------
// 3) Module Registration
Modules modules = new Modules(baseHome,args);
StartLog.debug("Registering all modules");
modules.registerAll();
// ------------------------------------------------------------
// 4) Active Module Resolution
for (String enabledModule : args.getEnabledModules())
{
for (String source : args.getSources(enabledModule))
{
String shortForm = baseHome.toShortForm(source);
modules.selectNode(enabledModule,new Selection(shortForm));
}
}
StartLog.debug("Building Module Graph");
modules.buildGraph();
args.setAllModules(modules);
List activeModules = modules.getSelected();
final Version START_VERSION = new Version(StartArgs.VERSION);
for(Module enabled: activeModules)
{
if(enabled.getVersion().isNewerThan(START_VERSION))
{
throw new UsageException(UsageException.ERR_BAD_GRAPH, "Module [" + enabled.getName() + "] specifies jetty version [" + enabled.getVersion()
+ "] which is newer than this version of jetty [" + START_VERSION + "]");
}
}
for(String name: args.getSkipFileValidationModules())
{
Module module = modules.get(name);
module.setSkipFilesValidation(true);
}
// ------------------------------------------------------------
// 5) Lib & XML Expansion / Resolution
args.expandLibs(baseHome);
args.expandModules(baseHome,activeModules);
}
catch (GraphException e)
{
throw new UsageException(ERR_BAD_GRAPH,e);
}
// ------------------------------------------------------------
// 6) Resolve Extra XMLs
args.resolveExtraXmls(baseHome);
// ------------------------------------------------------------
// 9) Resolve Property Files
args.resolvePropertyFiles(baseHome);
return args;
}
public void start(StartArgs args) throws IOException, InterruptedException
{
StartLog.debug("StartArgs: %s",args);
// Get Desired Classpath based on user provided Active Options.
Classpath classpath = args.getClasspath();
System.setProperty("java.class.path",classpath.toString());
// Show the usage information and return
if (args.isHelp())
{
usage(true);
}
// Show the version information and return
if (args.isListClasspath())
{
dumpClasspathWithVersions(classpath);
}
// Show configuration
if (args.isListConfig())
{
listConfig(args);
}
// Show modules
if (args.isListModules())
{
listModules(args);
}
// Generate Module Graph File
if (args.getModuleGraphFilename() != null)
{
Path outputFile = baseHome.getBasePath(args.getModuleGraphFilename());
System.out.printf("Generating GraphViz Graph of Jetty Modules at %s%n",baseHome.toShortForm(outputFile));
ModuleGraphWriter writer = new ModuleGraphWriter();
writer.config(args.getProperties());
writer.write(args.getAllModules(),outputFile);
}
// Show Command Line to execute Jetty
if (args.isDryRun())
{
CommandLineBuilder cmd = args.getMainArgs(baseHome,true);
System.out.println(cmd.toString(StartLog.isDebugEnabled()?" \\\n":" "));
}
if (args.isStopCommand())
{
doStop(args);
}
BaseBuilder baseBuilder = new BaseBuilder(baseHome,args);
if(baseBuilder.build())
{
// base directory changed.
StartLog.info("Base directory was modified");
return;
}
// Informational command line, don't run jetty
if (!args.isRun())
{
return;
}
// execute Jetty in another JVM
if (args.isExec())
{
CommandLineBuilder cmd = args.getMainArgs(baseHome,true);
cmd.debug();
ProcessBuilder pbuilder = new ProcessBuilder(cmd.getArgs());
StartLog.endStartLog();
final Process process = pbuilder.start();
Runtime.getRuntime().addShutdownHook(new Thread()
{
@Override
public void run()
{
StartLog.debug("Destroying " + process);
process.destroy();
}
});
copyInThread(process.getErrorStream(),System.err);
copyInThread(process.getInputStream(),System.out);
copyInThread(System.in,process.getOutputStream());
process.waitFor();
System.exit(0); // exit JVM when child process ends.
return;
}
if (args.hasJvmArgs() || args.hasSystemProperties())
{
System.err.println("WARNING: System properties and/or JVM args set. Consider using --dry-run or --exec");
}
ClassLoader cl = classpath.getClassLoader();
Thread.currentThread().setContextClassLoader(cl);
// Invoke the Main Class
try
{
invokeMain(cl, args);
}
catch (Exception e)
{
usageExit(e,ERR_INVOKE_MAIN);
}
}
private void doStop(StartArgs args)
{
Props.Prop stopHostProp = args.getProperties().getProp("STOP.HOST", true);
Props.Prop stopPortProp = args.getProperties().getProp("STOP.PORT", true);
Props.Prop stopKeyProp = args.getProperties().getProp("STOP.KEY", true);
Props.Prop stopWaitProp = args.getProperties().getProp("STOP.WAIT", true);
String stopHost = "127.0.0.1";
int stopPort = -1;
String stopKey = "";
if (stopHostProp != null)
{
stopHost = stopHostProp.value;
}
if (stopPortProp != null)
{
stopPort = Integer.parseInt(stopPortProp.value);
}
if(stopKeyProp != null)
{
stopKey = stopKeyProp.value;
}
if (stopWaitProp != null)
{
int stopWait = Integer.parseInt(stopWaitProp.value);
stop(stopHost, stopPort, stopKey, stopWait);
}
else
{
stop(stopHost, stopPort, stopKey);
}
}
/**
* Stop a running jetty instance.
* @param host the host
* @param port the port
* @param key the key
*/
public void stop(String host, int port, String key)
{
stop(host,port,key,0);
}
public void stop(String host, int port, String key, int timeout)
{
if (host==null || host.length()==0)
{
host = "127.0.0.1";
}
try
{
if ( (port <= 0) || (port > 65535) )
{
System.err.println("STOP.PORT property must be specified with a valid port number");
usageExit(ERR_BAD_STOP_PROPS);
}
if (key == null)
{
key = "";
System.err.println("STOP.KEY property must be specified");
System.err.println("Using empty key");
}
try (Socket s = new Socket(InetAddress.getByName(host),port))
{
if (timeout > 0)
{
s.setSoTimeout(timeout * 1000);
}
try (OutputStream out = s.getOutputStream())
{
out.write((key + "\r\nstop\r\n").getBytes());
out.flush();
if (timeout > 0)
{
System.err.printf("Waiting %,d seconds for jetty to stop%n",timeout);
LineNumberReader lin = new LineNumberReader(new InputStreamReader(s.getInputStream()));
String response;
while ((response = lin.readLine()) != null)
{
StartLog.debug("Received \"%s\"",response);
if ("Stopped".equals(response))
{
StartLog.warn("Server reports itself as Stopped");
}
}
}
}
}
}
catch (SocketTimeoutException e)
{
System.err.println("Timed out waiting for stop confirmation");
System.exit(ERR_UNKNOWN);
}
catch (ConnectException e)
{
usageExit(e,ERR_NOT_STOPPED);
}
catch (Exception e)
{
usageExit(e,ERR_UNKNOWN);
}
}
public void usage(boolean exit)
{
StartLog.endStartLog();
if(!printTextResource("org/eclipse/jetty/start/usage.txt"))
{
System.err.println("ERROR: detailed usage resource unavailable");
}
if (exit)
{
System.exit(EXIT_USAGE);
}
}
public static boolean printTextResource(String resourceName)
{
boolean resourcePrinted = false;
try (InputStream stream = Thread.currentThread().getContextClassLoader().getResourceAsStream(resourceName))
{
if (stream != null)
{
try (InputStreamReader reader = new InputStreamReader(stream); BufferedReader buf = new BufferedReader(reader))
{
resourcePrinted = true;
String line;
while ((line = buf.readLine()) != null)
{
System.out.println(line);
}
}
}
else
{
System.out.println("Unable to find resource: " + resourceName);
}
}
catch (IOException e)
{
StartLog.warn(e);
}
return resourcePrinted;
}
// ------------------------------------------------------------
// implement Apache commons daemon (jsvc) lifecycle methods (init, start, stop, destroy)
public void init(String[] args) throws Exception
{
try
{
startupArgs = processCommandLine(args);
}
catch (UsageException e)
{
System.err.println(e.getMessage());
usageExit(e.getCause(),e.getExitCode());
}
catch (Throwable e)
{
usageExit(e,UsageException.ERR_UNKNOWN);
}
}
public void start() throws Exception
{
start(startupArgs);
}
public void stop() throws Exception
{
doStop(startupArgs);
}
public void destroy()
{
}
}