You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by fm...@apache.org on 2011/09/19 10:29:07 UTC
svn commit: r1172508 - in /sling/trunk/launchpad/base/src:
main/java/org/apache/sling/launchpad/app/
main/java/org/apache/sling/launchpad/base/app/
test/java/org/apache/sling/launchpad/app/
Author: fmeschbe
Date: Mon Sep 19 08:29:07 2011
New Revision: 1172508
URL: http://svn.apache.org/viewvc?rev=1172508&view=rev
Log:
SLING-2225 Provide proper embedding support.
Added:
sling/trunk/launchpad/base/src/main/java/org/apache/sling/launchpad/app/ControlAction.java (with props)
Modified:
sling/trunk/launchpad/base/src/main/java/org/apache/sling/launchpad/app/ControlListener.java
sling/trunk/launchpad/base/src/main/java/org/apache/sling/launchpad/app/Main.java
sling/trunk/launchpad/base/src/main/java/org/apache/sling/launchpad/base/app/MainDelegate.java
sling/trunk/launchpad/base/src/test/java/org/apache/sling/launchpad/app/MainTest.java
Added: sling/trunk/launchpad/base/src/main/java/org/apache/sling/launchpad/app/ControlAction.java
URL: http://svn.apache.org/viewvc/sling/trunk/launchpad/base/src/main/java/org/apache/sling/launchpad/app/ControlAction.java?rev=1172508&view=auto
==============================================================================
--- sling/trunk/launchpad/base/src/main/java/org/apache/sling/launchpad/app/ControlAction.java (added)
+++ sling/trunk/launchpad/base/src/main/java/org/apache/sling/launchpad/app/ControlAction.java Mon Sep 19 08:29:07 2011
@@ -0,0 +1,45 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.sling.launchpad.app;
+
+/**
+ * The <code>ControlAction</code> defines values to used as the action for the
+ * Sling control with the {@link Main#doControlAction()} method.
+ */
+public enum ControlAction {
+
+ /**
+ * Indicates the Sling application should be started and a listener should
+ * be installed to accept control commands.
+ */
+ START,
+
+ /**
+ * Indicates to connect to a running Sling application having installed a
+ * listener and send that application the command to shutdown.
+ */
+ STOP,
+
+ /**
+ * Indicates to connect to a running Sling application having installed a
+ * listener and ask that application about its state.
+ */
+ STATUS;
+
+}
Propchange: sling/trunk/launchpad/base/src/main/java/org/apache/sling/launchpad/app/ControlAction.java
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: sling/trunk/launchpad/base/src/main/java/org/apache/sling/launchpad/app/ControlAction.java
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision Rev Url
Modified: sling/trunk/launchpad/base/src/main/java/org/apache/sling/launchpad/app/ControlListener.java
URL: http://svn.apache.org/viewvc/sling/trunk/launchpad/base/src/main/java/org/apache/sling/launchpad/app/ControlListener.java?rev=1172508&r1=1172507&r2=1172508&view=diff
==============================================================================
--- sling/trunk/launchpad/base/src/main/java/org/apache/sling/launchpad/app/ControlListener.java (original)
+++ sling/trunk/launchpad/base/src/main/java/org/apache/sling/launchpad/app/ControlListener.java Mon Sep 19 08:29:07 2011
@@ -154,7 +154,7 @@ class ControlListener implements Runnabl
Main.info(s.getRemoteSocketAddress() + ">" + command, null);
if (COMMAND_STOP.equals(command)) {
- slingMain.shutdown();
+ slingMain.doStop();
writeLine(s, RESPONSE_OK);
Main.info("Apache Sling shut down, exiting Java VM", null);
Modified: sling/trunk/launchpad/base/src/main/java/org/apache/sling/launchpad/app/Main.java
URL: http://svn.apache.org/viewvc/sling/trunk/launchpad/base/src/main/java/org/apache/sling/launchpad/app/Main.java?rev=1172508&r1=1172507&r2=1172508&view=diff
==============================================================================
--- sling/trunk/launchpad/base/src/main/java/org/apache/sling/launchpad/app/Main.java (original)
+++ sling/trunk/launchpad/base/src/main/java/org/apache/sling/launchpad/app/Main.java Mon Sep 19 08:29:07 2011
@@ -26,6 +26,7 @@ import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;
+import java.util.Map.Entry;
import org.apache.sling.launchpad.base.shared.Launcher;
import org.apache.sling.launchpad.base.shared.Loader;
@@ -35,7 +36,7 @@ import org.apache.sling.launchpad.base.s
/**
* The <code>Main</code> is the externally visible Standalone Java Application
* launcher for Sling. Please refer to the full description <i>The Sling
- * Launchpad</i> on the Sling Wiki for a full description of this class.
+ * Launchpad</i> on the Sling Web Site for a full description of this class.
* <p>
* Logging goes to standard output for informational messages and to standard
* error for error messages.
@@ -43,54 +44,252 @@ import org.apache.sling.launchpad.base.s
* This class goes into the secondary artifact with the classifier <i>app</i> to
* be used as the main class when starting the Java Application.
*
- * @see <a href="http://cwiki.apache.org/SLING/the-sling-launchpad.html">The
+ * @see <a href="http://sling.apache.org/site/the-sling-launchpad.html">The
* Sling Launchpad</a>
*/
-public class Main extends Thread implements Notifiable {
+public class Main {
// The name of the environment variable to consult to find out
// about sling.home
private static final String ENV_SLING_HOME = "SLING_HOME";
+ /**
+ * The name of the configuration property indicating the
+ * {@link ControlAction} to be taken in the {@link #doControlAction()}
+ * method.
+ */
+ protected static final String PROP_CONTROL_ACTION = "sling.control.action";
+
+ /** The Sling configuration property name setting the initial log level */
+ private static final String PROP_LOG_LEVEL = "org.apache.sling.commons.log.level";
+
+ /** The Sling configuration property name setting the initial log file */
+ private static final String PROP_LOG_FILE = "org.apache.sling.commons.log.file";
+
+ /**
+ * The configuration property setting the port on which the HTTP service
+ * listens
+ */
+ private static final String PROP_PORT = "org.osgi.service.http.port";
+
+ /**
+ * The main entry point to the Sling Launcher Standalone Java Application.
+ * This method is generally only called by the Java VM to launch Sling.
+ *
+ * @param args The command line arguments supplied when starting the Sling
+ * Launcher through the Java VM.
+ */
public static void main(String[] args) {
- new Main(args);
+ final Map<String, String> rawArgs = parseCommandLine(args);
+
+ // support usage first
+ if (doHelp(rawArgs)) {
+ System.exit(0);
+ }
+
+ final Map<String, String> props = convertCommandLineArgs(rawArgs);
+ if (props == null) {
+ System.exit(1);
+ }
+
+ Main main = new Main(props);
+
+ // check for control commands
+ int rc = main.doControlAction();
+ if (rc >= 0) {
+ System.exit(rc);
+ }
+
+ // finally start Sling
+ main.doStart();
}
+ /**
+ * The map of command line arguments where the keys are the actual
+ * property names as known to the OSGi Framework and its installed
+ * bundles.
+ */
private final Map<String, String> commandLineArgs;
- private final String slingHome;
+ /**
+ * The shutdown hook installed into the Java VM after Sling has been
+ * started. The hook is removed again when Sling is being shut down
+ * or the {@link Notified notifier} is notified of the framework shutdown.
+ *
+ * @see #addShutdownHook()
+ * @see #removeShutdownHook()
+ */
+ private Thread shutdownHook;
+
+ /**
+ * The absolute path to the home directory of the launched Sling
+ * application. This corresponds to the value of the <code>sling.home</code>
+ * framework property.
+ *
+ * @see #getSlingHome(Map)
+ */
+ private String slingHome;
- private final Loader loader;
+ /**
+ * The {@link Loader} class used to create the Framework class loader and
+ * to launch the framework.
+ */
+ private Loader loader;
+ /**
+ * The actual launcher accessed through the {@link #loader} to launch
+ * the OSGi Framework.
+ */
private Launcher sling;
- private Main(String[] args) {
+ /**
+ * Creates an instance of this main loader class. The provided arguments are
+ * used to configure the OSGi framework being launched with the
+ * {@link #startSling(URL)} method.
+ *
+ * @param args The map of configuration properties to be supplied to the
+ * OSGi framework. The keys in this map are assumed to be usefull
+ * without translation to the launcher and the OSGi Framework. If
+ * this parameter is <code>null</code> and empty map without
+ * configuration is assumed.
+ */
+ protected Main(Map<String, String> args) {
+ this.commandLineArgs = (args == null)
+ ? new HashMap<String, String>()
+ : args;
+ }
- // set the thread name
- super("Apache Sling Terminator");
+ /**
+ * After instantiating this class, this method may be called to help with
+ * the communication with a running Sling instance. To setup this
+ * communication the configuration properties supplied to the constructor
+ * are evaluated as follows:
+ * <p>
+ * <table>
+ * <tr>
+ * <td><code>j</code></td>
+ * <td>Specifies the socket to use for the control connection. This
+ * specification is of the form <i>host:port</i> where the host can be a
+ * host name or IP Address and may be omitted (along with the separating
+ * colon) and port is just the numberic port number at which to listen. The
+ * default is <i>localhost:63000</i>. It is suggested to not use an
+ * externally accessible interface for security reasons because there is no
+ * added security on this control channel for now.</td>
+ * </tr>
+ * <tr>
+ * <td><code>{@value #PROP_CONTROL_ACTION}</code></td>
+ * <td>The actual action to execute:
+ * <ul>
+ * <b>start</b> -- Start the listener on the configured socket and expect
+ * commands there. This action is useful only when launching the Sling
+ * application since this action helps manage a running system.
+ * </ul>
+ * <ul>
+ * <b>stop</b> -- Connects to the listener running on the configured socket
+ * and send the command to terminate the Sling Application. If this command
+ * is used, it is expected the Sling Application will not start.
+ * </ul>
+ * <ul>
+ * <b>status</b> -- Connects to the listener running on the configured
+ * socket and query about its status. If this command is used, it is
+ * expected the Sling Application will not start.
+ * </ul>
+ * </td>
+ * </tr>
+ * </table>
+ * <p>
+ * After this method has executed the <code>j</code> and
+ * {@link #PROP_CONTROL_ACTION} properties have been removed from the
+ * configuration properties.
+ * <p>
+ * While the {@link #doStart()} and {@link #doStop()} methods may be called
+ * multiple times this method should only be called once after creating this
+ * class's instance.
+ *
+ * @return An code indicating whether the Java VM is expected to be
+ * terminated or not. If <code>-1</code> is returned, the VM should
+ * continue as intended, maybe starting the Sling Application. This
+ * code is returned if the start action (or no action at all) is
+ * supplied. Otherwise the VM should terminate with the returned
+ * code as its exit code. For the stop action, this will be zero. For
+ * the status action, this will be a LSB compliant code for daemon
+ * status check: 0 (application running), 1 (Programm Dead), 3
+ * (Programm Not Running), 4 (Unknown Problem).
+ */
+ protected int doControlAction() {
+ String commandSocketSpec = commandLineArgs.remove("j");
+ if ("j".equals(commandSocketSpec)) {
+ commandSocketSpec = null;
+ }
- this.commandLineArgs = parseCommandLine(args);
+ ControlAction action = getControlAction();
+ if (action != null) {
+ ControlListener sl = new ControlListener(this, commandSocketSpec);
+ switch (action) {
+ case START:
+ sl.listen();
+ break;
+ case STATUS:
+ return sl.statusServer();
+ case STOP:
+ sl.shutdownServer();
+ return 0;
+ default:
+ error("Unsupported control action: " + action, null);
+ }
+ }
- // support usage first
- doHelp();
+ return -1;
+ }
+
+ private ControlAction getControlAction() {
+ Object action = this.commandLineArgs.remove(PROP_CONTROL_ACTION);
+ if (action != null) {
+ if (action instanceof ControlAction) {
+ return (ControlAction) action;
+ }
+
+ try {
+ return ControlAction.valueOf(action.toString());
+ } catch (IllegalArgumentException iae) {
+ error("Illegal control action value: " + action, null);
+ }
+ }
+ return null;
+ }
+
+ /**
+ * Starts the application with the configuration supplied with the
+ * configuration properties when this instance has been created.
+ * <p>
+ * Calling this method multiple times before calling {@link #doStop()} will
+ * cause a message to be printed and <code>true</code> being returned.
+ *
+ * @return <code>true</code> if startup was successfull or the application
+ * is considered to be started already. Otherwise an error message
+ * has been logged and <code>false</code> is returned.
+ */
+ protected boolean doStart() {
- // check for control commands (might exit)
- doControlCommand();
+ // prevent duplicate start
+ if (this.slingHome != null) {
+ info("Apache Sling has already been started", null);
+ return true;
+ }
// sling.home from the command line or system properties, else default
- this.slingHome = getSlingHome(commandLineArgs);
+ String slingHome = getSlingHome(commandLineArgs);
File slingHomeFile = new File(slingHome);
- if (slingHomeFile.isAbsolute()) {
- info("Starting Apache Sling in " + slingHome, null);
- } else {
- info("Starting Apache Sling in " + slingHome + " ("
- + slingHomeFile.getAbsolutePath() + ")", null);
+ if (!slingHomeFile.isAbsolute()) {
+ slingHome = slingHomeFile.getAbsolutePath();
}
+ info("Starting Apache Sling in " + slingHome, null);
+ this.slingHome = slingHome;
// The Loader helper
Loader loaderTmp = null;
try {
- loaderTmp = new Loader(slingHome) {
+ loaderTmp = new Loader(slingHomeFile) {
@Override
protected void info(String msg) {
Main.info(msg, null);
@@ -98,126 +297,61 @@ public class Main extends Thread impleme
};
} catch (IllegalArgumentException iae) {
startupFailure(iae.getMessage(), null);
+ return false;
}
this.loader = loaderTmp;
- Runtime.getRuntime().addShutdownHook(this);
-
// ensure up-to-date launcher jar
- startSling(getClass().getResource(
+ return startSling(getClass().getResource(
SharedConstants.DEFAULT_SLING_LAUNCHER_JAR));
}
- // ---------- Shutdown support for control listener and shutdown hook
-
- void shutdown() {
- // remove the shutdown hook, will fail if called from the
- // shutdown hook itself. Otherwise this prevents shutdown
- // from being called again
- try {
- Runtime.getRuntime().removeShutdownHook(this);
- } catch (Throwable t) {
- // don't care for problems removing the hook
- }
-
- // now really shutdown sling
- if (sling != null) {
- info("Stopping Apache Sling", null);
- sling.stop();
- }
- }
-
- // ---------- Notifiable interface
-
/**
- * The framework has been stopped by calling the <code>Bundle.stop()</code>
- * on the system bundle. This actually terminates the Sling Standalone
- * application.
+ * Maybe called by the application to cause the Sling Application to
+ * properly terminate by stopping the OSGi Framework.
+ * <p>
+ * After calling this method the Sling Application can be started again
+ * by calling the {@link #doStart()} method.
+ * <p>
+ * Calling this method multiple times without calling the {@link #doStart()}
+ * method in between has no effect after the Sling Application has been
+ * terminated.
*/
- public void stopped() {
- /**
- * This method is called if the framework is stopped from within by
- * calling stop on the system bundle or if the framework is stopped
- * because the VM is going down and the shutdown hook has initated the
- * shutdown In any case we ensure the reference to the framework is
- * removed and remove the shutdown hook (but don't care if that fails).
- */
-
- info("Apache Sling has been stopped", null);
-
- // clear the reference to the framework
- sling = null;
+ protected void doStop() {
+ this.stopSling();
+ }
- // remove the shutdown hook, the framework has terminated and
- // we do not need to do anything else
- try {
- Runtime.getRuntime().removeShutdownHook(this);
- } catch (Throwable t) {
- // don't care for problems removing the hook
+ private void addShutdownHook() {
+ if (this.shutdownHook == null) {
+ this.shutdownHook = new Thread(new ShutdownHook(),
+ "Apache Sling Terminator");
+ Runtime.getRuntime().addShutdownHook(this.shutdownHook);
}
}
- /**
- * The framework has been stopped with the intent to be restarted by calling
- * either of the <code>Bundle.update</code> methods on the system bundle.
- * <p>
- * If an <code>InputStream</code> was provided, this has been copied to a
- * temporary file, which will be used in place of the existing launcher jar
- * file.
- *
- * @param updateFile The temporary file to replace the existing launcher jar
- * file. If <code>null</code> the existing launcher jar will be
- * used again.
- */
- public void updated(File updateFile) {
-
- // clear the reference to the framework
- sling = null;
-
- // ensure we have a VM as clean as possible
- loader.cleanupVM();
-
- if (updateFile == null) {
-
- info("Restarting Framework and Apache Sling", null);
- startSling(null);
-
- } else {
+ private void removeShutdownHook() {
+ // remove the shutdown hook, will fail if called from the
+ // shutdown hook itself. Otherwise this prevents shutdown
+ // from being called again
+ Thread shutdownHook = this.shutdownHook;
+ this.shutdownHook = null;
- info("Restarting Framework with update from " + updateFile, null);
+ if (shutdownHook != null) {
try {
- startSling(updateFile.toURI().toURL());
- } catch (MalformedURLException mue) {
- error("Cannot get URL for file " + updateFile, mue);
- } finally {
- updateFile.delete();
+ Runtime.getRuntime().removeShutdownHook(shutdownHook);
+ } catch (Throwable t) {
+ // don't care for problems removing the hook
}
-
}
}
- // --------- Thread
-
- /**
- * Called when the Java VM is being terminiated, for example because the
- * KILL signal has been sent to the process. This method calls stop on the
- * launched Sling instance to terminate the framework before returning.
- */
- @Override
- public void run() {
- info("Java VM is shutting down", null);
- shutdown();
- }
-
- // ---------- internal
-
- private void startSling(URL launcherJar) {
+ private boolean startSling(final URL launcherJar) {
if (launcherJar != null) {
try {
- info("Checking launcher JAR in folder " + slingHome, null);
loader.installLauncherJar(launcherJar);
} catch (IOException ioe) {
startupFailure("Failed installing " + launcherJar, ioe);
+ return false;
}
} else {
info("No Launcher JAR to install", null);
@@ -229,13 +363,14 @@ public class Main extends Thread impleme
} catch (IllegalArgumentException iae) {
startupFailure("Failed loading Sling class "
+ SharedConstants.DEFAULT_SLING_MAIN, iae);
+ return false;
}
if (object instanceof Launcher) {
// configure the launcher
Launcher sling = (Launcher) object;
- sling.setNotifiable(this);
+ sling.setNotifiable(new Notified());
sling.setCommandLine(commandLineArgs);
sling.setSlingHome(slingHome);
@@ -244,63 +379,34 @@ public class Main extends Thread impleme
if (sling.start()) {
info("Startup completed", null);
this.sling = sling;
- } else {
- error("There was a problem launching Apache Sling", null);
+ addShutdownHook();
+ return true;
}
+
+ error("There was a problem launching Apache Sling", null);
}
+
+ return false;
}
- /**
- * Parses the command line arguments into a map of strings indexed by
- * strings. This method suppports single character option names only at the
- * moment. Each pair of an option name and its value is stored into the
- * map. If a single dash '-' character is encountered the rest of the command
- * line are interpreted as option names and are stored in the map unmodified
- * as entries with the same key and value.
- * <table>
- * <tr><th>Command Line</th><th>Mapping</th></tr>
- * <tr><td>x</td><td>x -> x</td></tr>
- * <tr><td>-y z</td><td>y -> z</td></tr>
- * <tr><td>-yz</td><td>y -> z</td></tr>
- * <tr><td>-y -z</td><td>y -> y, z -> z</td></tr>
- * <tr><td>-y x - -z a</td><td>y -> x, -z -> -z, a -> a</td></tr>
- * </table>
- *
- * @param args The command line to parse
- *
- * @return The map of command line options and their values
- */
- static Map<String, String> parseCommandLine(String[] args) {
- Map<String, String> commandLine = new HashMap<String, String>();
- boolean readUnparsed = false;
- for (int argc = 0; args != null && argc < args.length; argc++) {
- String arg = args[argc];
+ void stopSling() {
+ removeShutdownHook();
- if (readUnparsed) {
- commandLine.put(arg, arg);
- } else if (arg.startsWith("-")) {
- if (arg.length() == 1) {
- readUnparsed = true;
- } else {
- String key = String.valueOf(arg.charAt(1));
- if (arg.length() > 2) {
- commandLine.put(key, arg.substring(2));
- } else {
- argc++;
- if (argc < args.length
- && (args[argc].equals("-") || !args[argc].startsWith("-"))) {
- commandLine.put(key, args[argc]);
- } else {
- commandLine.put(key, key);
- argc--;
- }
- }
- }
- } else {
- commandLine.put(arg, arg);
- }
+ // now really shutdown sling
+ if (this.sling != null) {
+ info("Stopping Apache Sling", null);
+ this.sling.stop();
+ this.sling = null;
}
- return commandLine;
+
+ // clean and VM caches
+ if (this.loader != null) {
+ this.loader.cleanupVM();
+ this.loader = null;
+ }
+
+ // further cleanup
+ this.slingHome = null;
}
/**
@@ -319,7 +425,7 @@ public class Main extends Thread impleme
private static String getSlingHome(Map<String, String> commandLine) {
String source = null;
- String slingHome = commandLine.get("c");
+ String slingHome = commandLine.get(SharedConstants.SLING_HOME);
if (slingHome != null) {
source = "command line";
@@ -354,18 +460,17 @@ public class Main extends Thread impleme
private void startupFailure(String message, Throwable cause) {
error("Launcher JAR access failure: " + message, cause);
error("Shutting Down", null);
- System.exit(1);
}
// ---------- logging
// emit an informational message to standard out
- static void info(String message, Throwable t) {
- log(System.out, "*INFO*", message, t);
+ protected static void info(String message, Throwable t) {
+ log(System.out, "*INFO *", message, t);
}
// emit an error message to standard err
- static void error(String message, Throwable t) {
+ protected static void error(String message, Throwable t) {
log(System.err, "*ERROR*", message, t);
}
@@ -391,23 +496,74 @@ public class Main extends Thread impleme
if (t != null) {
t.printStackTrace(new PrintStream(out) {
@Override
- public void println(String x) {
- synchronized (this) {
- print(linePrefix);
- super.println(x);
- flush();
- }
+ public void print(String x) {
+ super.print(linePrefix);
+ super.print(x);
}
});
}
}
- /** prints a simple usage plus optional error message and exists */
- private void doHelp() {
- if (commandLineArgs.remove("h") != null) {
+ /**
+ * Parses the command line arguments into a map of strings indexed by
+ * strings. This method suppports single character option names only at the
+ * moment. Each pair of an option name and its value is stored into the
+ * map. If a single dash '-' character is encountered the rest of the command
+ * line are interpreted as option names and are stored in the map unmodified
+ * as entries with the same key and value.
+ * <table>
+ * <tr><th>Command Line</th><th>Mapping</th></tr>
+ * <tr><td>x</td><td>x -> x</td></tr>
+ * <tr><td>-y z</td><td>y -> z</td></tr>
+ * <tr><td>-yz</td><td>y -> z</td></tr>
+ * <tr><td>-y -z</td><td>y -> y, z -> z</td></tr>
+ * <tr><td>-y x - -z a</td><td>y -> x, -z -> -z, a -> a</td></tr>
+ * </table>
+ *
+ * @param args The command line to parse
+ *
+ * @return The map of command line options and their values
+ */
+ // default accessor to enable unit tests wihtout requiring reflection
+ static Map<String, String> parseCommandLine(String... args) {
+ Map<String, String> commandLine = new HashMap<String, String>();
+ boolean readUnparsed = false;
+ for (int argc = 0; args != null && argc < args.length; argc++) {
+ String arg = args[argc];
+
+ if (readUnparsed) {
+ commandLine.put(arg, arg);
+ } else if (arg.startsWith("-")) {
+ if (arg.length() == 1) {
+ readUnparsed = true;
+ } else {
+ String key = String.valueOf(arg.charAt(1));
+ if (arg.length() > 2) {
+ commandLine.put(key, arg.substring(2));
+ } else {
+ argc++;
+ if (argc < args.length
+ && (args[argc].equals("-") || !args[argc].startsWith("-"))) {
+ commandLine.put(key, args[argc]);
+ } else {
+ commandLine.put(key, key);
+ argc--;
+ }
+ }
+ }
+ } else {
+ commandLine.put(arg, arg);
+ }
+ }
+ return commandLine;
+ }
+
+ /** prints a simple usage plus optional error message */
+ private static boolean doHelp(Map<String, String> args) {
+ if (args.remove("h") != null) {
System.out.println("usage: "
+ Main.class.getName()
- + " [ start | stop | status ] [ -j adr ] [ -l loglevel ] [ -f logfile ] [ -c slinghome ] [ -a address ] [ -p port ] [ -h ]");
+ + " [ start | stop | status ] [ -j adr ] [ -l loglevel ] [ -f logfile ] [ -c slinghome ] [ -i launchpadhome ] [ -a address ] [ -p port ] [ -h ]");
System.out.println(" start listen for control connection (uses -j)");
System.out.println(" stop terminate running Apache Sling (uses -j)");
@@ -416,29 +572,183 @@ public class Main extends Thread impleme
System.out.println(" -l loglevel the initial loglevel (0..4, FATAL, ERROR, WARN, INFO, DEBUG)");
System.out.println(" -f logfile the log file, \"-\" for stdout (default logs/error.log)");
System.out.println(" -c slinghome the sling context directory (default sling)");
+ System.out.println(" -i launchpadhome the launchpad directory (default slinghome)");
System.out.println(" -a address the interfact to bind to (use 0.0.0.0 for any) (not supported yet)");
System.out.println(" -p port the port to listen to (default 8080)");
System.out.println(" -h prints this usage message");
- System.exit(0);
+ return true;
}
+ return false;
}
- private void doControlCommand() {
- String commandSocketSpec = commandLineArgs.remove("j");
- if ("j".equals(commandSocketSpec)) {
- commandSocketSpec = null;
+ // default accessor to enable unit tests wihtout requiring reflection
+ static Map<String, String> convertCommandLineArgs(
+ Map<String, String> rawArgs) {
+ final HashMap<String, String> props = new HashMap<String, String>();
+ boolean errorArg = false;
+ for (Entry<String, String> arg : rawArgs.entrySet()) {
+ if (arg.getKey().length() == 1) {
+ String value = arg.getValue();
+ switch (arg.getKey().charAt(0)) {
+ case 'j':
+ // copy control connection spec unchecked
+ props.put(arg.getKey(), arg.getValue());
+ break;
+
+ case 'l':
+ if (value == arg.getKey()) {
+ errorArg("-l", "Missing log level value");
+ errorArg = true;
+ continue;
+ }
+ props.put(PROP_LOG_LEVEL, value);
+ break;
+
+ case 'f':
+ if (value == arg.getKey()) {
+ errorArg("-f", "Missing log file value");
+ errorArg = true;
+ continue;
+ } else if ("-".equals(value)) {
+ value = "";
+ }
+ props.put(PROP_LOG_FILE, value);
+ break;
+
+ case 'c':
+ if (value == arg.getKey()) {
+ errorArg("-c", "Missing directory value");
+ errorArg = true;
+ continue;
+ }
+ props.put(SharedConstants.SLING_HOME, value);
+ break;
+
+ case 'i':
+ if (value == arg.getKey()) {
+ errorArg("-i", "Missing launchpad directory value");
+ errorArg = true;
+ continue;
+ }
+ props.put(SharedConstants.SLING_LAUNCHPAD, value);
+ break;
+
+ case 'a':
+ if (value == arg.getKey()) {
+ errorArg("-a", "Missing address value");
+ errorArg = true;
+ continue;
+ }
+ info(
+ "Setting the address to bind to is not supported, binding to 0.0.0.0",
+ null);
+ break;
+
+ case 'p':
+ if (value == arg.getKey()) {
+ errorArg("-p", "Missing port value");
+ errorArg = true;
+ continue;
+ }
+ try {
+ // just to verify it is a number
+ Integer.parseInt(value);
+ props.put(PROP_PORT, value);
+ } catch (RuntimeException e) {
+ errorArg("-p", "Bad port: " + value);
+ errorArg = true;
+ }
+ break;
+
+ default:
+ errorArg("-" + arg.getKey(), "Unrecognized option");
+ errorArg = true;
+ break;
+ }
+ } else if ("start".equals(arg.getKey())
+ || "stop".equals(arg.getKey()) || "status".equals(arg.getKey())) {
+ props.put(arg.getKey(), arg.getValue());
+ } else {
+ errorArg(arg.getKey(), "Unrecognized option");
+ errorArg = true;
+ }
}
+ return errorArg ? null : props;
+ }
- ControlListener sl = new ControlListener(this, commandSocketSpec);
- if (commandLineArgs.remove(ControlListener.COMMAND_STOP) != null) {
- sl.shutdownServer();
- System.exit(0);
- } else if (commandLineArgs.remove(ControlListener.COMMAND_STATUS) != null) {
- final int status = sl.statusServer();
- System.exit(status);
- } else if (commandLineArgs.remove("start") != null) {
- sl.listen();
+ private static void errorArg(String option, String message) {
+ error(String.format("%s: %s (use -h for more information)", option,
+ message), null);
+ }
+
+ private class ShutdownHook implements Runnable {
+ public void run() {
+ info("Java VM is shutting down", null);
+ Main.this.stopSling();
}
}
+
+ private class Notified implements Notifiable {
+
+ /**
+ * The framework has been stopped by calling the
+ * <code>Bundle.stop()</code> on the system bundle. This actually
+ * terminates the Sling Standalone application.
+ */
+ public void stopped() {
+ /**
+ * This method is called if the framework is stopped from within by
+ * calling stop on the system bundle or if the framework is stopped
+ * because the VM is going down and the shutdown hook has initated
+ * the shutdown In any case we ensure the reference to the framework
+ * is removed and remove the shutdown hook (but don't care if that
+ * fails).
+ */
+
+ Main.info("Apache Sling has been stopped", null);
+
+ Main.this.sling = null;
+ Main.this.stopSling();
+ }
+
+ /**
+ * The framework has been stopped with the intent to be restarted by
+ * calling either of the <code>Bundle.update</code> methods on the
+ * system bundle.
+ * <p>
+ * If an <code>InputStream</code> was provided, this has been copied to
+ * a temporary file, which will be used in place of the existing
+ * launcher jar file.
+ *
+ * @param updateFile The temporary file to replace the existing launcher
+ * jar file. If <code>null</code> the existing launcher jar
+ * will be used again.
+ */
+ public void updated(File updateFile) {
+
+ Main.this.sling = null;
+ Main.this.stopSling();
+
+ if (updateFile == null) {
+
+ Main.info("Restarting Framework and Apache Sling", null);
+ Main.this.startSling(null);
+
+ } else {
+
+ Main.info(
+ "Restarting Framework with update from " + updateFile, null);
+ try {
+ Main.this.startSling(updateFile.toURI().toURL());
+ } catch (MalformedURLException mue) {
+ Main.error("Cannot get URL for file " + updateFile, mue);
+ } finally {
+ updateFile.delete();
+ }
+
+ }
+ }
+ }
+
}
Modified: sling/trunk/launchpad/base/src/main/java/org/apache/sling/launchpad/base/app/MainDelegate.java
URL: http://svn.apache.org/viewvc/sling/trunk/launchpad/base/src/main/java/org/apache/sling/launchpad/base/app/MainDelegate.java?rev=1172508&r1=1172507&r2=1172508&view=diff
==============================================================================
--- sling/trunk/launchpad/base/src/main/java/org/apache/sling/launchpad/base/app/MainDelegate.java (original)
+++ sling/trunk/launchpad/base/src/main/java/org/apache/sling/launchpad/base/app/MainDelegate.java Mon Sep 19 08:29:07 2011
@@ -170,10 +170,8 @@ public class MainDelegate implements Lau
sling = new Sling(notifiable, logger, resProvider, props) {
// overwrite the loadPropertiesOverride method to inject the
- // command
- // line arguments unconditionally. These will not be persisted
- // in any
- // properties file, though
+ // command line arguments unconditionally. These will not be
+ // persisted in any properties file, though
protected void loadPropertiesOverride(
Map<String, String> properties) {
if (commandLine != null) {
@@ -207,6 +205,16 @@ public class MainDelegate implements Lau
private static void parseCommandLine(Map<String, String> args,
Map<String, String> props) {
+ /*
+ * NOTE: We expect command line args to be suitable to use as
+ * properties to launch Sling. Any standalone Java application
+ * command line args have to be translated into Sling launcher
+ * properties by the Main class. For deployment of the Launchpad
+ * JAR into older launchers we keep converting existing command
+ * line args for now. New command line arguments must solely be
+ * known and converted in the Main class and not here.
+ */
+
for (Entry<String, String> arg : args.entrySet()) {
if (arg.getKey().length() == 1) {
String value = arg.getValue();
@@ -216,16 +224,7 @@ public class MainDelegate implements Lau
terminate("Missing log level value", 1);
continue;
}
- try {
- int logLevel = Integer.parseInt(value);
- value = toLogLevel(logLevel);
- } catch (NumberFormatException nfe) {
- // might be a log level string
- value = checkLogLevel(value);
- }
- if (value != null) {
- props.put(PROP_LOG_LEVEL, value);
- }
+ props.put(PROP_LOG_LEVEL, value);
break;
case 'f':
@@ -273,37 +272,23 @@ public class MainDelegate implements Lau
break;
}
} else {
- terminate("Unrecognized option " + arg.getKey(), 1);
+ info("Setting " + arg.getKey() + "=" + arg.getValue(), null);
+ props.put(arg.getKey(), arg.getValue());
}
}
}
- /** Converts the loglevel code to a loglevel string name */
- private static String toLogLevel(int level) {
- if (level >= 0 && level < logLevels.length) {
- return logLevels[level];
- }
-
- terminate("Bad log level: " + level, 1);
- return null;
- }
-
- /**
- * Verifies the log level is one of the known values, returns null otherwise
- */
- private static String checkLogLevel(String level) {
- for (int i = 0; i < logLevels.length; i++) {
- if (logLevels[i].equalsIgnoreCase(level)) {
- return logLevels[i];
+ /** Return the log level code for the string */
+ private static int toLogLevelInt(String level, int defaultLevel) {
+ try {
+ int logLevel = Integer.parseInt(level);
+ if (logLevel >= 0 && logLevel < logLevels.length) {
+ return logLevel;
}
+ } catch (NumberFormatException nfe) {
+ // might be a log level string
}
- terminate("Bad log level: " + level, 1);
- return null;
- }
-
- /** Return the log level code for the string */
- private static int toLogLevelInt(String level, int defaultLevel) {
for (int i = 0; i < logLevels.length; i++) {
if (logLevels[i].equalsIgnoreCase(level)) {
return i;
Modified: sling/trunk/launchpad/base/src/test/java/org/apache/sling/launchpad/app/MainTest.java
URL: http://svn.apache.org/viewvc/sling/trunk/launchpad/base/src/test/java/org/apache/sling/launchpad/app/MainTest.java?rev=1172508&r1=1172507&r2=1172508&view=diff
==============================================================================
--- sling/trunk/launchpad/base/src/test/java/org/apache/sling/launchpad/app/MainTest.java (original)
+++ sling/trunk/launchpad/base/src/test/java/org/apache/sling/launchpad/app/MainTest.java Mon Sep 19 08:29:07 2011
@@ -18,12 +18,21 @@
*/
package org.apache.sling.launchpad.app;
+import java.util.HashMap;
import java.util.Map;
+import org.apache.sling.launchpad.base.shared.SharedConstants;
+
import junit.framework.TestCase;
public class MainTest extends TestCase {
+ @Override
+ protected void setUp() throws Exception {
+ super.setUp();
+ System.setProperty("___sling_dont_exit___", "true");
+ }
+
public void test_parseCommandLine_null_args() {
String[] args = null;
Map<String, String> commandline = Main.parseCommandLine(args);
@@ -37,7 +46,7 @@ public class MainTest extends TestCase {
assertNotNull("commandline map must not be null", commandline);
assertTrue("commandline map must be empty", commandline.isEmpty());
}
-
+
public void test_parseCommandLine_single_dash() {
String[] args = { "-" };
Map<String, String> commandline = Main.parseCommandLine(args);
@@ -49,25 +58,35 @@ public class MainTest extends TestCase {
String[] args = { "-a" };
Map<String, String> commandline = Main.parseCommandLine(args);
assertNotNull("commandline map must not be null", commandline);
- assertEquals("commandline map must have one entry", 1, commandline.size());
- assertEquals("single argument must be " + args[0].charAt(1), String.valueOf(args[0].charAt(1)), commandline.keySet().iterator().next());
- assertEquals("single argument value must be " + args[0].charAt(1), String.valueOf(args[0].charAt(1)), commandline.values().iterator().next());
+ assertEquals("commandline map must have one entry", 1,
+ commandline.size());
+ assertEquals("single argument must be " + args[0].charAt(1),
+ String.valueOf(args[0].charAt(1)),
+ commandline.keySet().iterator().next());
+ assertEquals("single argument value must be " + args[0].charAt(1),
+ String.valueOf(args[0].charAt(1)),
+ commandline.values().iterator().next());
}
-
+
public void test_parseCommandLine_single_arg_with_par() {
String[] args = { "-a", "value" };
Map<String, String> commandline = Main.parseCommandLine(args);
assertNotNull("commandline map must not be null", commandline);
- assertEquals("commandline map must have one entry", 1, commandline.size());
- assertEquals("single argument must be " + args[0].charAt(1), String.valueOf(args[0].charAt(1)), commandline.keySet().iterator().next());
- assertEquals("single argument value must be " + args[1], args[1], commandline.values().iterator().next());
+ assertEquals("commandline map must have one entry", 1,
+ commandline.size());
+ assertEquals("single argument must be " + args[0].charAt(1),
+ String.valueOf(args[0].charAt(1)),
+ commandline.keySet().iterator().next());
+ assertEquals("single argument value must be " + args[1], args[1],
+ commandline.values().iterator().next());
}
public void test_parseCommandLine_two_args_no_par() {
String[] args = { "-a", "-b" };
Map<String, String> commandline = Main.parseCommandLine(args);
assertNotNull("commandline map must not be null", commandline);
- assertEquals("commandline map must have two entries", 2, commandline.size());
+ assertEquals("commandline map must have two entries", 2,
+ commandline.size());
assertEquals("argument a must a", "a", commandline.get("a"));
assertEquals("argument b must b", "b", commandline.get("b"));
}
@@ -76,7 +95,8 @@ public class MainTest extends TestCase {
String[] args = { "-a", "apar", "-b" };
Map<String, String> commandline = Main.parseCommandLine(args);
assertNotNull("commandline map must not be null", commandline);
- assertEquals("commandline map must have two entries", 2, commandline.size());
+ assertEquals("commandline map must have two entries", 2,
+ commandline.size());
assertEquals("argument a must apar", "apar", commandline.get("a"));
assertEquals("argument b must b", "b", commandline.get("b"));
}
@@ -85,7 +105,8 @@ public class MainTest extends TestCase {
String[] args = { "-a", "-b", "bpar" };
Map<String, String> commandline = Main.parseCommandLine(args);
assertNotNull("commandline map must not be null", commandline);
- assertEquals("commandline map must have two entries", 2, commandline.size());
+ assertEquals("commandline map must have two entries", 2,
+ commandline.size());
assertEquals("argument a must a", "a", commandline.get("a"));
assertEquals("argument b must bpar", "bpar", commandline.get("b"));
}
@@ -94,7 +115,8 @@ public class MainTest extends TestCase {
String[] args = { "-a", "apar", "-b", "bpar" };
Map<String, String> commandline = Main.parseCommandLine(args);
assertNotNull("commandline map must not be null", commandline);
- assertEquals("commandline map must have two entries", 2, commandline.size());
+ assertEquals("commandline map must have two entries", 2,
+ commandline.size());
assertEquals("argument a must apar", "apar", commandline.get("a"));
assertEquals("argument b must bpar", "bpar", commandline.get("b"));
}
@@ -103,7 +125,8 @@ public class MainTest extends TestCase {
String[] args = { "-a", "apar", "-", "-b", "bpar" };
Map<String, String> commandline = Main.parseCommandLine(args);
assertNotNull("commandline map must not be null", commandline);
- assertEquals("commandline map must have three entries", 3, commandline.size());
+ assertEquals("commandline map must have three entries", 3,
+ commandline.size());
assertEquals("argument a must apar", "apar", commandline.get("a"));
assertEquals("argument -b must -b", "-b", commandline.get("-b"));
assertEquals("argument bpar must bpar", "bpar", commandline.get("bpar"));
@@ -113,7 +136,146 @@ public class MainTest extends TestCase {
String[] args = { "-a", "-" };
Map<String, String> commandline = Main.parseCommandLine(args);
assertNotNull("commandline map must not be null", commandline);
- assertEquals("commandline map must have three entries", 1, commandline.size());
+ assertEquals("commandline map must have three entries", 1,
+ commandline.size());
assertEquals("argument a must -", "-", commandline.get("a"));
}
+
+ public void test_convertCommandLineArgs_no_args() {
+ Map<String, String> props = Main.convertCommandLineArgs(new HashMap<String, String>());
+ assertNotNull(props);
+ assertTrue(props.isEmpty());
+ }
+
+ public void test_converCommandLineArgs_unknown() {
+ assertNull(Main.convertCommandLineArgs(new HashMap<String, String>() {
+ {
+ put("u", "short");
+ }
+ }));
+ assertNull(Main.convertCommandLineArgs(new HashMap<String, String>() {
+ {
+ put("longer", "long");
+ }
+ }));
+ }
+
+ public void test_converCommandLineArgs_j_start_stop_status() {
+ Map<String, String> props = Main.convertCommandLineArgs(new HashMap<String, String>() {
+ {
+ put("j", "j");
+ put("start", "start");
+ put("stop", "stop");
+ put("status", "status");
+ }
+ });
+ assertNotNull(props);
+ assertEquals(4, props.size());
+ assertEquals("j", props.get("j"));
+ assertEquals("start", props.get("start"));
+ assertEquals("stop", props.get("stop"));
+ assertEquals("status", props.get("status"));
+ }
+
+ public void test_converCommandLineArgs_l() {
+ Map<String, String> props = Main.convertCommandLineArgs(new HashMap<String, String>() {
+ {
+ put("l", "INFO");
+ }
+ });
+ assertNotNull(props);
+ assertEquals(1, props.size());
+ assertEquals("INFO", props.get("org.apache.sling.commons.log.level"));
+
+ Map<String, String> props2 = Main.convertCommandLineArgs(new HashMap<String, String>() {
+ {
+ final String l = "l";
+ put(l, l);
+ }
+ });
+ assertNull(props2);
+ }
+
+ public void test_converCommandLineArgs_f() {
+ Map<String, String> props = Main.convertCommandLineArgs(new HashMap<String, String>() {
+ {
+ put("f", "sling.changed");
+ }
+ });
+ assertNotNull(props);
+ assertEquals(1, props.size());
+ assertEquals("sling.changed", props.get("org.apache.sling.commons.log.file"));
+
+ Map<String, String> props1 = Main.convertCommandLineArgs(new HashMap<String, String>() {
+ {
+ put("f", "-");
+ }
+ });
+ assertNotNull(props1);
+ assertEquals(1, props1.size());
+ assertEquals("", props1.get("org.apache.sling.commons.log.file"));
+
+ Map<String, String> props2 = Main.convertCommandLineArgs(new HashMap<String, String>() {
+ {
+ final String f = "f";
+ put(f, f);
+ }
+ });
+ assertNull(props2);
+ }
+
+ public void test_converCommandLineArgs_c() {
+ Map<String, String> props = Main.convertCommandLineArgs(new HashMap<String, String>() {
+ {
+ put("c", "sling.changed");
+ }
+ });
+ assertNotNull(props);
+ assertEquals(1, props.size());
+ assertEquals("sling.changed", props.get(SharedConstants.SLING_HOME));
+
+ Map<String, String> props2 = Main.convertCommandLineArgs(new HashMap<String, String>() {
+ {
+ final String c = "c";
+ put(c, c);
+ }
+ });
+ assertNull(props2);
+ }
+
+ public void test_converCommandLineArgs_a() {
+ Map<String, String> props = Main.convertCommandLineArgs(new HashMap<String, String>() {
+ {
+ put("a", "0.0.0.0");
+ }
+ });
+ assertNotNull(props);
+ assertEquals(0, props.size());
+ }
+
+ public void test_converCommandLineArgs_p() {
+ Map<String, String> props = Main.convertCommandLineArgs(new HashMap<String, String>() {
+ {
+ put("p", "1234");
+ }
+ });
+ assertNotNull(props);
+ assertEquals(1, props.size());
+ assertEquals("1234", props.get("org.osgi.service.http.port"));
+
+ Map<String, String> props1 = Main.convertCommandLineArgs(new HashMap<String, String>() {
+ {
+ put("p", "abc");
+ }
+ });
+ assertNull(props1);
+
+ Map<String, String> props2 = Main.convertCommandLineArgs(new HashMap<String, String>() {
+ {
+ final String p = "p";
+ put(p, p);
+ }
+ });
+ assertNull(props2);
+ }
}