com.martiansoftware.nailgun.NGServer Maven / Gradle / Ivy
/*
Copyright 2004-2012, Martian Software, Inc.
Licensed 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 com.martiansoftware.nailgun;
import java.io.InputStream;
import java.io.PrintStream;
import java.lang.reflect.Method;
import java.net.InetAddress;
import java.net.ServerSocket;
import java.net.Socket;
import java.net.UnknownHostException;
import java.util.Iterator;
import java.util.Map;
import com.martiansoftware.nailgun.builtins.DefaultNail;
import java.util.Properties;
/**
* Listens for new connections from NailGun clients and launches NGSession
* threads to process them.
*
* This class can be run as a standalone server or can be embedded within
* larger applications as a means of providing command-line interaction with the
* application.
*
* @author Marty Lamb
*/
public class NGServer implements Runnable {
/**
* Default size for thread pool
*/
public static final int DEFAULT_SESSIONPOOLSIZE = 10;
/**
* The address on which to listen, or null to listen on all local addresses
*/
private InetAddress addr = null;
/**
* The port on which to listen, or zero to select a port automatically
*/
private int port = 0;
/**
* The socket doing the listening
*/
private ServerSocket serversocket;
/**
* True if this NGServer has received instructions to shut down
*/
private boolean shutdown = false;
/**
* True if this NGServer has been started and is accepting connections
*/
private boolean running = false;
/**
* This NGServer's AliasManager, which maps aliases to classes
*/
private AliasManager aliasManager;
/**
* If true, fully-qualified classnames are valid commands
*/
private boolean allowNailsByClassName = true;
/**
* The default class to use if an invalid alias or classname is specified by
* the client.
*/
private Class defaultNailClass = null;
/**
* A pool of NGSessions ready to handle client connections
*/
private NGSessionPool sessionPool = null;
/**
* System.out at the time of the NGServer's creation
*/
public final PrintStream out = System.out;
/**
* System.err at the time of the NGServer's creation
*/
public final PrintStream err = System.err;
/**
* System.in at the time of the NGServer's creation
*/
public final InputStream in = System.in;
/**
* a collection of all classes executed by this server so far
*/
private Map allNailStats = null;
/**
* Remember the security manager we start with so we can restore it later
*/
private SecurityManager originalSecurityManager = null;
/**
* Creates a new NGServer that will listen at the specified address and on
* the specified port with the specified session pool size. This does
* not cause the server to start listening. To do so, create a new
* Thread wrapping this
* NGServer and start it.
*
* @param addr the address at which to listen, or
* null to bind to all local addresses
* @param port the port on which to listen.
* @param sessionPoolSize the max number of idle sessions allowed by the
* pool
*/
public NGServer(InetAddress addr, int port, int sessionPoolSize) {
init(addr, port, sessionPoolSize);
}
/**
* Creates a new NGServer that will listen at the specified address and on
* the specified port with the default session pool size. This does
* not cause the server to start listening. To do so, create a new
* Thread wrapping this
* NGServer and start it.
*
* @param addr the address at which to listen, or
* null to bind to all local addresses
* @param port the port on which to listen.
* @param sessionPoolSize the max number of idle sessions allowed by the
* pool
*/
public NGServer(InetAddress addr, int port) {
init(addr, port, DEFAULT_SESSIONPOOLSIZE);
}
/**
* Creates a new NGServer that will listen on the default port (defined in
* NGConstants.DEFAULT_PORT). This does not cause the
* server to start listening. To do so, create a new
* Thread wrapping this
* NGServer and start it.
*/
public NGServer() {
init(null, NGConstants.DEFAULT_PORT, DEFAULT_SESSIONPOOLSIZE);
}
/**
* Sets up the NGServer internals
*
* @param addr the InetAddress to bind to
* @param port the port on which to listen
* @param sessionPoolSize the max number of idle sessions allowed by the
* pool
*/
private void init(InetAddress addr, int port, int sessionPoolSize) {
this.addr = addr;
this.port = port;
this.aliasManager = new AliasManager();
allNailStats = new java.util.HashMap();
// allow a maximum of 10 idle threads. probably too high a number
// and definitely should be configurable in the future
sessionPool = new NGSessionPool(this, sessionPoolSize);
}
/**
* Sets a flag that determines whether Nails can be executed by class name.
* If this is false, Nails can only be run via aliases (and you should
* probably remove ng-alias from the AliasManager).
*
* @param allowNailsByClassName true iff Nail lookups by classname are
* allowed
*/
public void setAllowNailsByClassName(boolean allowNailsByClassName) {
this.allowNailsByClassName = allowNailsByClassName;
}
/**
* Returns a flag that indicates whether Nail lookups by classname are
* allowed. If this is false, Nails can only be run via aliases.
*
* @return a flag that indicates whether Nail lookups by classname are
* allowed.
*/
public boolean allowsNailsByClassName() {
return (allowNailsByClassName);
}
/**
* Sets the default class to use for the Nail if no Nails can be found via
* alias or classname. (may be
* null, in which case NailGun will use its own default)
*
* @param defaultNailClass the default class to use for the Nail if no Nails
* can be found via alias or classname. (may be
* null, in which case NailGun will use its own default)
*/
public void setDefaultNailClass(Class defaultNailClass) {
this.defaultNailClass = defaultNailClass;
}
/**
* Returns the default class that will be used if no Nails can be found via
* alias or classname.
*
* @return the default class that will be used if no Nails can be found via
* alias or classname.
*/
public Class getDefaultNailClass() {
return ((defaultNailClass == null) ? DefaultNail.class : defaultNailClass);
}
/**
* Returns the current NailStats object for the specified class, creating a
* new one if necessary
*
* @param nailClass the class for which we're gathering stats
* @return a NailStats object for the specified class
*/
private NailStats getOrCreateStatsFor(Class nailClass) {
NailStats result = null;
synchronized (allNailStats) {
result = (NailStats) allNailStats.get(nailClass);
if (result == null) {
result = new NailStats(nailClass);
allNailStats.put(nailClass, result);
}
}
return (result);
}
/**
* Provides a means for an NGSession to register the starting of a nail
* execution with the server.
*
* @param nailClass the nail class that was launched
*/
void nailStarted(Class nailClass) {
NailStats stats = getOrCreateStatsFor(nailClass);
stats.nailStarted();
}
/**
* Provides a means for an NGSession to register the completion of a nails
* execution with the server.
*
* @param nailClass the nail class that finished
*/
void nailFinished(Class nailClass) {
NailStats stats = (NailStats) allNailStats.get(nailClass);
stats.nailFinished();
}
/**
* Returns a snapshot of this NGServer's nail statistics. The result is a
* java.util.Map, keyed by class name, with NailStats objects as values.
*
* @return a snapshot of this NGServer's nail statistics.
*/
public Map getNailStats() {
Map result = new java.util.TreeMap();
synchronized (allNailStats) {
for (Iterator i = allNailStats.keySet().iterator(); i.hasNext();) {
Class nailclass = (Class) i.next();
result.put(nailclass.getName(), ((NailStats) allNailStats.get(nailclass)).clone());
}
}
return (result);
}
/**
* Returns the AliasManager in use by this NGServer.
*
* @return the AliasManager in use by this NGServer.
*/
public AliasManager getAliasManager() {
return (aliasManager);
}
/**
* Shuts down the server. The server will stop listening and its thread
* will finish. Any running nails will be allowed to finish.
*
* Any nails that provide a
*
public static void nailShutdown(NGServer)
method
* will have this method called with this NGServer as its sole
* parameter.
*
* @param exitVM if true, this method will also exit the JVM after calling
* nailShutdown() on any nails. This may prevent currently running nails
* from exiting gracefully, but may be necessary in order to perform some
* tasks, such as shutting down any AWT or Swing threads implicitly launched
* by your nails.
*/
public void shutdown(boolean exitVM) {
synchronized (this) {
if (shutdown) {
return;
}
shutdown = true;
}
try {
serversocket.close();
} catch (Throwable toDiscard) {
}
sessionPool.shutdown();
Class[] argTypes = new Class[1];
argTypes[0] = NGServer.class;
Object[] argValues = new Object[1];
argValues[0] = this;
// make sure that all aliased classes have associated nailstats
// so they can be shut down.
for (Iterator i = getAliasManager().getAliases().iterator(); i.hasNext();) {
Alias alias = (Alias) i.next();
getOrCreateStatsFor(alias.getAliasedClass());
}
synchronized (allNailStats) {
for (Iterator i = allNailStats.values().iterator(); i.hasNext();) {
NailStats ns = (NailStats) i.next();
Class nailClass = ns.getNailClass();
// yes, I know this is lazy, relying upon the exception
// to handle the case of no nailShutdown method.
try {
Method nailShutdown = nailClass.getMethod("nailShutdown", argTypes);
nailShutdown.invoke(null, argValues);
} catch (Throwable toDiscard) {
}
}
}
// restore system streams
System.setIn(in);
System.setOut(out);
System.setErr(err);
System.setSecurityManager(originalSecurityManager);
if (exitVM) {
System.exit(0);
}
}
/**
* Returns true iff the server is currently running.
*
* @return true iff the server is currently running.
*/
public boolean isRunning() {
return (running);
}
/**
* Returns the port on which this server is (or will be) listening.
*
* @return the port on which this server is (or will be) listening.
*/
public int getPort() {
return ((serversocket == null) ? port : serversocket.getLocalPort());
}
/**
* Listens for new connections and launches NGSession threads to process
* them.
*/
public void run() {
running = true;
NGSession sessionOnDeck = null;
originalSecurityManager = System.getSecurityManager();
System.setSecurityManager(
new NGSecurityManager(
originalSecurityManager));
synchronized (System.in) {
if (!(System.in instanceof ThreadLocalInputStream)) {
System.setIn(new ThreadLocalInputStream(in));
System.setOut(new ThreadLocalPrintStream(out));
System.setErr(new ThreadLocalPrintStream(err));
}
}
try {
if (addr == null) {
serversocket = new ServerSocket(port);
} else {
serversocket = new ServerSocket(port, 0, addr);
}
while (!shutdown) {
sessionOnDeck = sessionPool.take();
Socket socket = serversocket.accept();
sessionOnDeck.run(socket);
}
} catch (Throwable t) {
// if shutdown is called while the accept() method is blocking,
// an exception will be thrown that we don't care about. filter
// those out.
if (!shutdown) {
t.printStackTrace();
}
}
if (sessionOnDeck != null) {
sessionOnDeck.shutdown();
}
running = false;
}
private static void usage() {
System.err.println("Usage: java com.martiansoftware.nailgun.NGServer");
System.err.println(" or: java com.martiansoftware.nailgun.NGServer port");
System.err.println(" or: java com.martiansoftware.nailgun.NGServer IPAddress");
System.err.println(" or: java com.martiansoftware.nailgun.NGServer IPAddress:port");
}
/**
* Creates and starts a new
* NGServer. A single optional argument is valid, specifying
* the port on which this
* NGServer should listen. If omitted,
* NGServer.DEFAULT_PORT will be used.
*
* @param args a single optional argument specifying the port on which to
* listen.
* @throws NumberFormatException if a non-numeric port is specified
*/
public static void main(String[] args) throws NumberFormatException, UnknownHostException {
if (args.length > 1) {
usage();
return;
}
// null server address means bind to everything local
InetAddress serverAddress = null;
int port = NGConstants.DEFAULT_PORT;
// parse the sole command line parameter, which
// may be an inetaddress to bind to, a port number,
// or an inetaddress followed by a port, separated
// by a colon
if (args.length != 0) {
String[] argParts = args[0].split(":");
String addrPart = null;
String portPart = null;
if (argParts.length == 2) {
addrPart = argParts[0];
portPart = argParts[1];
} else if (argParts[0].indexOf('.') >= 0) {
addrPart = argParts[0];
} else {
portPart = argParts[0];
}
if (addrPart != null) {
serverAddress = InetAddress.getByName(addrPart);
}
if (portPart != null) {
port = Integer.parseInt(portPart);
}
}
NGServer server = new NGServer(serverAddress, port, DEFAULT_SESSIONPOOLSIZE);
Thread t = new Thread(server);
t.setName("NGServer(" + serverAddress + ", " + port + ")");
t.start();
Runtime.getRuntime().addShutdownHook(new NGServerShutdowner(server));
// if the port is 0, it will be automatically determined.
// add this little wait so the ServerSocket can fully
// initialize and we can see what port it chose.
int runningPort = server.getPort();
while (runningPort == 0) {
try {
Thread.sleep(50);
} catch (Throwable toIgnore) {
}
runningPort = server.getPort();
}
System.out.println("NGServer "
+ NGConstants.VERSION
+ " started on "
+ ((serverAddress == null)
? "all interfaces"
: serverAddress.getHostAddress())
+ ", port "
+ runningPort
+ ".");
}
/**
* A shutdown hook that will cleanly bring down the NGServer if it is
* interrupted.
*
* @author Marty
* Lamb
*/
private static class NGServerShutdowner extends Thread {
private NGServer server = null;
NGServerShutdowner(NGServer server) {
this.server = server;
}
public void run() {
int count = 0;
server.shutdown(false);
// give the server up to five seconds to stop. is that enough?
// remember that the shutdown will call nailShutdown in any
// nails as well
while (server.isRunning() && (count < 50)) {
try {
Thread.sleep(100);
} catch (InterruptedException e) {
}
++count;
}
if (server.isRunning()) {
System.err.println("Unable to cleanly shutdown server. Exiting JVM Anyway.");
} else {
System.out.println("NGServer shut down.");
}
}
}
}