com.martiansoftware.nailgun.NGSession Maven / Gradle / Ivy
The newest version!
/*
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.BufferedOutputStream;
import java.io.DataInputStream;
import java.io.DataOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.PrintStream;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.net.Socket;
import java.net.SocketException;
import java.util.List;
import java.util.Properties;
import java.util.concurrent.atomic.AtomicLong;
import java.util.logging.Level;
import java.util.logging.Logger;
/**
* Reads the NailGun stream from the client through the command, then hands off processing to the
* appropriate class. The NGSession obtains its sockets from an NGSessionPool, which created this
* NGSession.
*
* @author Marty Lamb
*/
public class NGSession extends Thread {
private static final Logger LOG = Logger.getLogger(NGSession.class.getName());
/**
* The server this NGSession is working for
*/
private final NGServer server;
/**
* The pool this NGSession came from, and to which it will return itself
*/
private final NGSessionPool sessionPool;
/**
* Synchronization object
*/
private final Object lock = new Object();
/**
* The next socket this NGSession has been tasked with processing (by NGServer)
*/
private Socket nextSocket = null;
/**
* True if the server has been shutdown and this NGSession should terminate completely
*/
private boolean done = false;
/**
* The instance number of this NGSession. That is, if this is the Nth NGSession to be created,
* then this is the value for N.
*/
private final long instanceNumber;
/**
* The interval to wait between heartbeats before considering the client to have disconnected.
*/
private final int heartbeatTimeoutMillis;
/**
* The instance counter shared among all NGSessions
*/
private static AtomicLong instanceCounter = new AtomicLong(0);
/**
* signature of main(String[]) for reflection operations
*/
private final static Class[] mainSignature = {
String[].class,
};
/**
* signature of nailMain(NGContext) for reflection operations
*/
private final static Class[] nailMainSignature = {
NGContext.class,
};
/**
* A ClassLoader that may be set by a client. Defaults to the classloader of this class.
*/
public static volatile ClassLoader classLoader = null; // initialized in the static initializer - see below
static {
try {
classLoader = NGSession.class.getClassLoader();
} catch (SecurityException e) {
throw e;
}
}
/**
* Creates a new NGSession running for the specified NGSessionPool and NGServer.
*
* @param sessionPool The NGSessionPool we're working for
* @param server The NGServer we're working for
*/
NGSession(NGSessionPool sessionPool, NGServer server) {
super();
this.sessionPool = sessionPool;
this.server = server;
this.heartbeatTimeoutMillis = server.getHeartbeatTimeout();
this.instanceNumber = instanceCounter.incrementAndGet();
}
/**
* Shuts down this NGSession gracefully
*/
void shutdown() {
synchronized (lock) {
done = true;
nextSocket = null;
lock.notifyAll();
}
}
/**
* Instructs this NGSession to process the specified socket, after which this NGSession will
* return itself to the pool from which it came.
*
* @param socket the socket (connected to a client) to process
*/
public void run(Socket socket) {
synchronized (lock) {
nextSocket = socket;
lock.notify();
}
Thread.yield();
}
/**
* Returns the next socket to process. This will block the NGSession thread until there's a
* socket to process or the NGSession has been shut down.
*
* @return the next socket to process, or null if the NGSession has been shut down.
*/
private Socket nextSocket() {
Socket result;
synchronized (lock) {
result = nextSocket;
while (!done && result == null) {
try {
lock.wait();
} catch (InterruptedException e) {
done = true;
}
result = nextSocket;
}
nextSocket = null;
}
if (result != null) {
// Java InputStream API is blocking by default with no reliable way to stop pending
// read() call. Setting the timeout to underlying socket will make socket's underlying
// read() calls throw SocketTimeoutException which unblocks read(). The exception must
// be properly handled by calling code.
try {
// TODO(buck_team): this does not work with current NGUnixDomainSocket
// implementation
result.setSoTimeout(this.heartbeatTimeoutMillis);
} catch (SocketException e) {
// this exception might be thrown if socket is already closed
// so we just return null
return null;
}
}
return result;
}
/**
* The main NGSession loop. This gets the next socket to process, runs the nail for the socket,
* and loops until shut down.
*/
public void run() {
updateThreadName(null);
LOG.log(Level.FINE, "Waiting for first client to connect");
Socket socket = nextSocket();
while (socket != null) {
LOG.log(Level.FINE, "Client connected");
try (DataInputStream sockin = new DataInputStream(socket.getInputStream());
DataOutputStream sockout = new DataOutputStream(socket.getOutputStream())) {
// client info - command line arguments and environment
List remoteArgs = new java.util.ArrayList();
Properties remoteEnv = new Properties();
String cwd = null; // working directory
String command = null; // alias or class name
// read everything from the client up to and including the command
while (command == null) {
int bytesToRead = sockin.readInt();
byte chunkType = sockin.readByte();
byte[] b = new byte[bytesToRead];
sockin.readFully(b);
String line = new String(b, "UTF-8");
switch (chunkType) {
case NGConstants.CHUNKTYPE_ARGUMENT:
// command line argument
remoteArgs.add(line);
break;
case NGConstants.CHUNKTYPE_ENVIRONMENT:
// parse environment into property
int equalsIndex = line.indexOf('=');
if (equalsIndex > 0) {
remoteEnv.setProperty(
line.substring(0, equalsIndex),
line.substring(equalsIndex + 1));
}
break;
case NGConstants.CHUNKTYPE_COMMAND:
// command (alias or classname)
command = line;
break;
case NGConstants.CHUNKTYPE_WORKINGDIRECTORY:
// client working directory
cwd = line;
break;
default: // freakout?
}
}
String threadName;
if (socket.getInetAddress() != null) {
threadName = socket.getInetAddress().getHostAddress() + ": " + command;
} else {
threadName = command;
}
updateThreadName(threadName);
// can't create NGCommunicator until we've received a command, because at
// that point the stream from the client will only include stdin and stdin-eof
// chunks
try (
NGCommunicator comm = new NGCommunicator(sockin, sockout,
heartbeatTimeoutMillis);
InputStream in = new NGInputStream(comm);
PrintStream out = new PrintStream(
new NGOutputStream(comm, NGConstants.CHUNKTYPE_STDOUT));
PrintStream err = new PrintStream(
new NGOutputStream(comm, NGConstants.CHUNKTYPE_STDERR));
PrintStream exit = new PrintStream(
new NGOutputStream(comm, NGConstants.CHUNKTYPE_EXIT));
) {
// ThreadLocal streams for System.in/out/err redirection
((ThreadLocalInputStream) System.in).init(in);
((ThreadLocalPrintStream) System.out).init(out);
((ThreadLocalPrintStream) System.err).init(err);
try {
Alias alias = server.getAliasManager().getAlias(command);
Class cmdclass = null;
if (alias != null) {
cmdclass = alias.getAliasedClass();
} else if (server.allowsNailsByClassName()) {
cmdclass = Class.forName(command, true, classLoader);
} else {
cmdclass = server.getDefaultNailClass();
}
Object[] methodArgs = new Object[1];
Method mainMethod = null; // will be either main(String[]) or nailMain(NGContext)
String[] cmdlineArgs = (String[]) remoteArgs
.toArray(new String[remoteArgs.size()]);
boolean isStaticNail = true; // See: NonStaticNail.java
Class[] interfaces = cmdclass.getInterfaces();
for (int i = 0; i < interfaces.length; i++) {
if (interfaces[i].equals(NonStaticNail.class)) {
isStaticNail = false;
break;
}
}
if (!isStaticNail) {
mainMethod = cmdclass
.getMethod("nailMain", new Class[]{String[].class});
methodArgs[0] = cmdlineArgs;
} else {
try {
mainMethod = cmdclass.getMethod("nailMain", nailMainSignature);
NGContext context = new NGContext();
context.setArgs(cmdlineArgs);
context.in = in;
context.out = out;
context.err = err;
context.setCommand(command);
context.setExitStream(exit);
context.setNGServer(server);
context.setCommunicator(comm);
context.setEnv(remoteEnv);
context.setInetAddress(socket.getInetAddress());
context.setPort(socket.getPort());
context.setWorkingDirectory(cwd);
methodArgs[0] = context;
} catch (NoSuchMethodException toDiscard) {
// that's ok - we'll just try main(String[]) next.
}
if (mainMethod == null) {
mainMethod = cmdclass.getMethod("main", mainSignature);
methodArgs[0] = cmdlineArgs;
}
}
if (mainMethod != null) {
server.nailStarted(cmdclass);
NGSecurityManager.setExit(exit);
try {
if (isStaticNail) {
mainMethod.invoke(null, methodArgs);
} else {
mainMethod.invoke(cmdclass.newInstance(), methodArgs);
}
} catch (InvocationTargetException ite) {
throw (ite.getCause());
} catch (InstantiationException e) {
throw (e);
} catch (IllegalAccessException e) {
throw (e);
} catch (Throwable t) {
throw (t);
} finally {
server.nailFinished(cmdclass);
}
exit.println(0);
}
} catch (NGExitException exitEx) {
LOG.log(Level.INFO, "Server cleanly exited with status {0}",
exitEx.getStatus());
exit.println(exitEx.getStatus());
server.out.println(
Thread.currentThread().getName() + " exited with status " + exitEx
.getStatus());
} catch (Throwable t) {
LOG.log(Level.INFO, "Server unexpectedly exited with unhandled exception",
t);
t.printStackTrace();
exit.println(NGConstants.EXIT_EXCEPTION); // remote exception constant
}
}
} catch (Throwable t) {
LOG.log(Level.WARNING, "Internal error in session", t);
t.printStackTrace();
}
((ThreadLocalInputStream) System.in).init(null);
((ThreadLocalPrintStream) System.out).init(null);
((ThreadLocalPrintStream) System.err).init(null);
updateThreadName(null);
sessionPool.give(this);
LOG.log(Level.FINE, "Closing client socket");
try {
socket.close();
} catch (Throwable t) {
LOG.log(Level.WARNING, "Internal error closing socket", t);
}
LOG.log(Level.FINE, "Waiting for next client to connect");
socket = nextSocket();
}
LOG.log(Level.INFO, "NGSession shutting down");
}
/**
* Updates the current thread name (useful for debugging).
*/
private void updateThreadName(String detail) {
setName("NGSession " + instanceNumber + ": " + ((detail == null) ? "(idle)" : detail));
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy