/*
* JBoss, Home of Professional Open Source.
* Copyright 2010, Red Hat, Inc., and individual contributors
* as indicated by the @author tags. See the copyright.txt file in the
* distribution for a full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.as.server;
import java.util.concurrent.atomic.AtomicBoolean;
import org.jboss.as.server.logging.ServerLogger;
/**
* Used to override System.exit() calls. For our tests we don't
* want System.exit to have any effect.
*
* @author <a href="kabir.khan@jboss.com">Kabir Khan</a>
* @version $Revision: 1.1 $
*/
public class SystemExiter {
private static Exiter exiter;
private static final AtomicBoolean logged = new AtomicBoolean(false);
public static void initialize(Exiter exiter) {
SystemExiter.exiter = exiter;
}
/**
* Equivalent to {@link #logAndExit(ExitLogger, int)} but with an ExitLogger that
* writes an "Aborting..." message to the log. So this method should only be
* used for unexpected exits.
*
* @param status the status code to provide to the exiter
*/
public static void abort(final int status) {
logAndExit(new ExitLogger() {
@Override
public void logExit() {
ServerLogger.ROOT_LOGGER.aborting(status);
}
}, status);
}
public static void safeAbort() {
logAndExit(new ExitLogger() {
@Override
public void logExit() {
// no-op
}
}, 0);
}
/** @deprecated use {@link #logAndExit(ExitLogger, int)} or {@link #abort(int)} */
@Deprecated
public static void exit(final int status) {
getExiter().exit(status);
}
/**
* Invokes the exit logger if and only if no ExitLogger was previously invoked.
* @param logger the logger. Cannot be {@code null}
*/
public static void logBeforeExit(ExitLogger logger) {
try {
if (logged.compareAndSet(false, true)) {
logger.logExit();
}
} catch (Throwable ignored){
// ignored
}
}
/**
* Calls {@link #logBeforeExit(ExitLogger)} and then invokes the {@link Exiter}.
* @param logger logger the logger. Cannot be {@code null}
* @param status the status code to provide to the exiter
*/
public static void logAndExit(ExitLogger logger, int status) {
logBeforeExit(logger);
getExiter().exit(status);
// If we get here, the exiter didn't really exit. So we
// must be embedded or something, or perhaps in a test case
// Reset the logged flag so we can log again the next time
// someone "exits"
logged.set(false);
}
private static Exiter getExiter() {
return exiter == null ? Exiter.DEFAULT : exiter;
}
public interface Exiter {
Exiter DEFAULT = new DefaultExiter();
void exit(int status);
}
private static class DefaultExiter implements Exiter{
public void exit(int status) {
System.exit(status);
}
}
public interface ExitLogger {
void logExit();
}
}