JonasAdmin.java

package org.objectweb.jonas.adm;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.rmi.RemoteException;
import java.util.Enumeration;
import java.util.Properties;
import java.util.Vector;

import javax.naming.InitialContext;
import javax.rmi.PortableRemoteObject;

import org.objectweb.jonas.ear.EarServiceException;
import org.objectweb.jonas.resource.ResourceServiceException;
import org.objectweb.jonas.web.JWebContainerServiceException;

/*
 * This class implements a rmi client to administrate the server. JonasAdmin may
 * be run either in interactive mode or command mode. @author Philippe Coq
 * Contributor(s): Florent Benoit & Ludovic Bert : Methods for wars and ear
 * files
 */
public class JonasAdmin {

    private static final String SERVERNAME = "JOnAS server ";

    private static String jonasName = null;

    private static AdmInterface admI = null;

    private static int state = -1;

    private static boolean reachable = false;

    private static boolean isNotEJB = false;

    private static boolean isError = false;

    private static void checkAdm() {

        // Gets reference on Adm object
        String admName = jonasName + Adm.ADMNAME_SUFFIX;
        try {
            InitialContext initialContext = new InitialContext();
            admI = (AdmInterface) PortableRemoteObject.narrow(initialContext.lookup(admName), AdmInterface.class);
            state = admI.getServerState();
            reachable = (state == Adm.READY);
            if (reachable) {
                isNotEJB = !admI.isEJBContainer();
            }
        } catch (Exception e) {
            reachable = false;
        }
    }

     private static void waitServer() {
        for (int i = 0; i < 200; i++) {
            try {
                // wait 0.5 second
                Thread.sleep(500);
            } catch (InterruptedException e) {
                return;
            }
            // test if server is ready
            if (reachable) {
                return;
            }
            checkAdm();
            if (state == Adm.STOPPED) {
                return;
            }
        }
        System.out.println(SERVERNAME + jonasName + " unreachable");
    }

    private static void addFile(String fileName) {

        if (!reachable) {
            System.err.println(SERVERNAME + jonasName + " unreachable");
            isError = true;
            return;
        }
        try {
            if (fileName.toLowerCase().endsWith(".jar") || fileName.toLowerCase().endsWith(".xml")) {
                //jar file
                if (isNotEJB) {
                    System.err.println("no beans on TMServer");
                    isError = true;
                    return;
                }
                admI.addBeans(fileName);
            } else if (fileName.toLowerCase().endsWith(".war")) {
                //War file
                admI.addWar(fileName);
            } else if (fileName.toLowerCase().endsWith(".ear")) {
                //ear file
                admI.addEar(fileName);
            } else if (fileName.toLowerCase().endsWith(".rar")) {
                //rar file
                admI.addRar(fileName);
            } else {
                //bad format
                System.err.println("Valid file extensions are : .jar, .xml, .war, .ear, .rar");
                return;
            }
        } catch (JWebContainerServiceException e) {
            System.err.println("admI.addWar: " + e);
            isError = true;
            return;
        } catch (EarServiceException e) {
            System.err.println("admI.addEar: " + e);
            isError = true;
            return;
        } catch (ResourceServiceException e) {
            System.err.println("admI.addRar: " + e);
            isError = true;
            return;
        } catch (RemoteException e) {
            System.err.println("RemoteException : " + e);
            isError = true;
            return;
        }
    }

    private static void removeFile(String fileName) {
        if (!reachable) {
            System.err.println(SERVERNAME + jonasName + " unreachable");
            isError = true;
            return;
        }
        //Remove a file (based upon the extension file
        try {
            if (fileName.toLowerCase().endsWith(".jar") || fileName.toLowerCase().endsWith(".xml")) {
                //jar file
                if (isNotEJB) {
                    System.err.println("no beans on TMServer");
                    isError = true;
                    return;
                }
                admI.removeBeans(fileName);
            } else if (fileName.toLowerCase().endsWith(".war")) {
                //War file
                admI.removeWar(fileName);
            } else if (fileName.toLowerCase().endsWith(".ear")) {
                //ear file
                admI.removeEar(fileName);
            } else if (fileName.toLowerCase().endsWith(".rar")) {
                //rar file
                admI.removeRar(fileName);
            } else {
                //bad format
                System.err.println("Valid file extensions are : .jar, xml, .war, .ear, *.rar");
                return;
            }
        } catch (JWebContainerServiceException e) {
            System.err.println("admI.removeWar: " + e.getMessage());
            isError = true;
            return;
        } catch (EarServiceException e) {
            System.err.println("admI.removeEar: " + e.getMessage());
            isError = true;
            return;
        } catch (ResourceServiceException e) {
            System.err.println("admI.removeRar: " + e);
            isError = true;
            return;
        } catch (RemoteException e) {
            System.err.println("RemoteException : " + e.getMessage());
            isError = true;
            return;
        }
    }

    private static void listbeans() {
        if (isNotEJB) {
            System.err.println("no beans on TMServer");
            isError = true;
            return;
        }
        if (!reachable) {
            System.err.println(SERVERNAME + jonasName + " unreachable");
            isError = true;
            return;
        }
        try {
            String[] result = admI.listBeans();
            if (result.length == 0) {
                System.out.println("No bean in " + jonasName);
            }
            for (int i = 0; i < result.length; i++) {
                System.out.println(result[i]);
            }
        } catch (RemoteException e) {
            System.err.println("admI.listBeans() : " + e);
            isError = true;
            return;
        }
    }

    private static void listnames() {
        if (!reachable) {
            System.err.println(SERVERNAME + jonasName + " unreachable");
            isError = true;
            return;
        }
        Vector result = new Vector();
        try {
            result = admI.listContext();
        } catch (RemoteException ex) {
            System.err.println("admI.listBeans() : " + ex);
            isError = true;
            return;
        }

        if (result.size() == 0) {
            System.out.println("No name in JNDI context.");
        }
        for (int i = 0; i < result.size(); i++) {
            System.out.println(result.elementAt(i));
        }
    }

    private static void listproperties() {
        if (!reachable) {
            System.err.println(SERVERNAME + jonasName + " unreachable");
            isError = true;
            return;
        }
        Properties p = new Properties();
        try {
            p = admI.listEnv();
        } catch (RemoteException ex) {
            System.err.println("admI.listBeans() : " + ex);
            isError = true;
            return;
        }
        for (Enumeration e = p.keys(); e.hasMoreElements();) {
            Object key = e.nextElement();
            Object value = p.get(key);
            System.out.println(key.toString() + "=" + value.toString());
        }
    }

    private static void sync(boolean passivate) {
        if (isNotEJB) {
            System.err.println("no beans on TMServer");
            isError = true;
            return;
        }
        if (!reachable) {
            System.err.println(SERVERNAME + jonasName + " unreachable");
            isError = true;
            return;
        }
        try {
            admI.syncAllEntities(passivate);
        } catch (RemoteException e) {
            System.err.println("admI.syncAllEntities : " + e);
            isError = true;
            return;
        }
    }

    private static void runGC() {
        if (!reachable) {
            System.err.println(SERVERNAME + jonasName + " unreachable");
            isError = true;
            return;
        }
        try {
            admI.runGC();
        } catch (RemoteException e) {
            System.err.println("admI.runGC : " + e);
            isError = true;
            return;
        }
    }

    private static void setTTimeout(String tstr) {
        if (!reachable) {
            System.err.println(SERVERNAME + jonasName + " unreachable");
            isError = true;
            return;
        }
        Integer i = new Integer(tstr);
        try {
            admI.setTransactionTimeout(i.intValue());
        } catch (RemoteException e) {
            System.err.println("admI.setTransactionTimeout : " + e);
            isError = true;
            return;
        }
    }

    private static void listTopics() {
        if (!reachable) {
            System.err.println(SERVERNAME + jonasName + " unreachable");
            isError = true;
            return;
        }
        try {
            String[] result = admI.getTopics();
            if (result.length == 0) {
                System.out.println("No topics in " + jonasName);
            }
            for (int i = 0; i < result.length; i++) {
                String level = admI.getTopicLevel(result[i]);
                System.out.println(level + "\t" + result[i]);
            }
        } catch (RemoteException e) {
            System.err.println("admI.getTopics : " + e);
            isError = true;
            return;
        }
    }

    private static void setTopic(String t, String l) {
        try {
            admI.setTopicLevel(t, l.toUpperCase());
        } catch (RemoteException e) {
            System.err.println("admI.setTopics : " + e);
            isError = true;
            return;
        }
    }

    private static void stopserver() {
        if (!reachable) {
            System.err.println(SERVERNAME + jonasName + " unreachable");
            isError = true;
            return;
        }
        try {
            admI.killServer();
        } catch (RemoteException e) {
            // go here usually: java.io.EOFException
        }
        System.out.println(SERVERNAME + jonasName + " stopped");
        reachable = false;
    }

    private static void help() {
        System.out.println("addbeans    adds beans in a new JOnAS container");
        System.out.println("addfile     adds beans/servlets/j2ee app/rars based upon the file extension");
        System.out.println("env         JOnAS properties used by the server");
        System.out.println("gc          run the garbage collector");
        System.out.println("help        help");
        System.out.println("jndinames   lists registered JNDI names");
        System.out.println("listbeans   lists beans");
        System.out.println("name        to identify a current JOnAS server");
        System.out.println("quit        quit JonasAdmin");
        System.out.println("removebeans remove beans in a new JOnAS container");
        System.out.println("removefile  remove beans/servlets/j2ee app/rars (based upon the file extension)");
        System.out.println("stop        stop current JOnAS");
        System.out.println("sync        synchronize all entities");
        System.out.println("passivate   passivate all entities");
        System.out.println("trace       get/set monolog topics");
        System.out.println("ttimeout    set default transaction timeout");
    }

    private static void usage() {
        System.out.println("usage : jonas admin <options>");
        System.out.println("if no option(except -n), mode is interactive.");
        System.out.println("list of available options:");
        System.out.println("    -n JonasName : to identify an JOnAS Server");
        System.out.println("    -s : stops the EJB server.");
        System.out.println("    -l : lists beans currently in the JOnAS Server.");
        System.out.println("    -j : lists registered JNDI names.");
        System.out.println("    -e : lists JOnAS properties currently used by the JOnAS Server.");
        System.out.println("    -a fileName : dynamically adds   : - beans from fileName in a new container");
        System.out.println("                                     : - servlets from a WAR file");
        System.out.println("                                     : - j2ee application from an EAR file");
        System.out.println("                                     : - resource adapter from a RAR file");
        System.out.println("    -r fileName : dynamically remove : - beans from container fileName");
        System.out.println("                                     : - servlets of a WAR file");
        System.out.println("                                     : - j2ee application of an EAR file");
        System.out.println("                                     : - resource adapter from a RAR file");
        System.out.println("    -sync: synchronize all entities");
        System.out.println("    -passivate: passivate all entities");
        System.out.println("    -gc: run the garbage collector");
        System.out.println("    -tt timeout: set default transaction timeout");
        System.out.println("    -t list monolog topics");
        System.out.println("    -debug topic : set DEBUG for a monolog topic");
        System.out.println("    -h : help message.");
        System.out.println("    -? : help message.");
    }

    /*
     * interactive mode
     */
    public static void menu() throws IOException {
        // First name the jonas server
        if (!reachable) {
            System.out.println("You must first choose a jonas server. (command `name`)");
            System.out.println("Type `help` to get the list of available commands");
        }

        // User interface
        BufferedReader inbuf = new BufferedReader(new InputStreamReader(System.in));
        while (true) {
            System.out.print("Admin (" + jonasName + ") > ");
            String command = inbuf.readLine();
            if (command.length() == 0) {
                continue;
            }
            if ("addbeans".startsWith(command) || "addfile".startsWith(command)) {
                String fName = null;
                System.out.print("file name ? > ");
                if ((fName = inbuf.readLine()).length() != 0) {
                    addFile(fName);
                }
                continue;
            }
            if ("env".startsWith(command)) {
                listproperties();
                continue;
            }
            if ("gc".startsWith(command)) {
                runGC();
                continue;
            }
            if ("help".startsWith(command) || command.equals("?")) {
                help();
                continue;
            }
            if ("jndinames".startsWith(command)) {
                listnames();
                continue;
            }
            if ("listbeans".startsWith(command)) {
                listbeans();
                continue;
            }
            if ("name".startsWith(command)) {
                System.out.print("Enter the " + SERVERNAME + "'s name (jonas.name property) : ");
                jonasName = new String(inbuf.readLine());
                checkAdm();
                continue;
            }
            if ("quit".startsWith(command) || "exit".startsWith(command)) {
                return;
            }
            if ("removebeans".startsWith(command) || "removefile".startsWith(command)) {
                String fName = null;
                System.out.print("file name ? > ");
                if ((fName = inbuf.readLine()).length() != 0) {
                    removeFile(fName);
                }
                continue;
            }
            if ("trace".startsWith(command)) {
                while (true) {
                    listTopics();
                    System.out.print("topic name ? > ");
                    String tname = inbuf.readLine().trim();
                    if (tname.length() == 0) {
                        break;
                    }
                    System.out.print("topic level ? (DEBUG | WARN | INFO | ERROR | INHERIT) > ");
                    String levstr = inbuf.readLine().trim();
                    setTopic(tname, levstr);
                }
                continue;
            }
            if ("stop".startsWith(command)) {
                stopserver();
                continue;
            }
            if ("sync".startsWith(command)) {
                sync(false);
                continue;
            }
            if ("passivate".startsWith(command)) {
                sync(true);
                continue;
            }
            if ("ttimeout".startsWith(command)) {
                String tstr = null;
                System.out.print("transaction timeout in seconds ? > ");
                if ((tstr = inbuf.readLine()).length() != 0) {
                    setTTimeout(tstr);
                }
                continue;
            }
            System.out.println("Unknown command. Type help to get for the list of commands.");
        }
    }

    public static void main(String[] args) throws IOException {

        String fileName = null;
        String timeout = null;
        String topic = null;

        boolean lOption = false;
        boolean pingOption = false;
        boolean jOption = false;
        boolean eOption = false;
        boolean aOption = false;
        boolean tOption = false;
        boolean sOption = false;
        boolean rOption = false;
        boolean syncOpt = false;
        boolean passivateOpt = false;
        boolean debugOption = false;
        boolean ttOpt = false;
        boolean gcOpt = false;

        boolean interactive = true;
        boolean namedServer = false;
        // Get command args
        for (int argn = 0; argn < args.length; argn++) {
            String arg = args[argn];
            boolean nextArgument = argn < args.length - 1;

            if (arg.equals("-a") && nextArgument) {
                fileName = args[++argn];
                aOption = true;
                interactive = false;
                continue;
            }
            if (arg.equals("-ping")) {
                pingOption = true;
                continue;
            }
            if (arg.equals("-e")) {
                eOption = true;
                interactive = false;
                continue;
            }
            if (arg.equals("-h") || arg.equals("-?")) {
                usage();
                System.exit(0);
            }
            if (arg.equals("-gc")) {
                gcOpt = true;
                interactive = false;
                continue;
            }
            if (arg.equals("-j")) {
                jOption = true;
                interactive = false;
                continue;
            }
            if (arg.equals("-l")) {
                lOption = true;
                interactive = false;
                continue;
            }
            if (arg.equals("-n") && nextArgument) {
                jonasName = args[++argn];
                namedServer = true;
                continue;
            }
            if (arg.equals("-r") && nextArgument) {
                fileName = args[++argn];
                rOption = true;
                interactive = false;
                continue;
            }
            if (arg.equals("-s")) {
                sOption = true;
                interactive = false;
                continue;
            }
            if (arg.equals("-sync")) {
                syncOpt = true;
                interactive = false;
                continue;
            }
            if (arg.equals("-passivate")) {
                passivateOpt = true;
                interactive = false;
                continue;
            }
            if (arg.equals("-debug") && nextArgument) {
                topic = args[++argn];
                debugOption = true;
                interactive = false;
                continue;
            }
            if (arg.equals("-t")) {
                tOption = true;
                interactive = false;
                continue;
            }
            if (arg.equals("-tt") && nextArgument) {
                timeout = args[++argn];
                ttOpt = true;
                interactive = false;
                continue;
            }
            System.out.println("Bad option: " + arg);
            usage();
            System.exit(2);
        }

        if (!namedServer) {
            jonasName = "jonas"; // default value
        }

        if (pingOption) {
            // Wait EJB server is ready
            waitServer();
            return;
        }

        // for all other options, first check server is reachable
        checkAdm();

        if (aOption) {
            // Adds beans in new JOnAS container
            addFile(fileName);
        }
        if (rOption) {
            // Remove beans in JOnAS container
            removeFile(fileName);
        }
        if (lOption) {
            // Lists beans
            listbeans();
        }
        if (jOption) {
            // jndi names
            listnames();
        }
        if (eOption) {
            // Lists JOnAS properties
            listproperties();
        }
        if (tOption) {
            // get monolog topics
            listTopics();
        }
        if (debugOption) {
            // set debug for a topic
            setTopic(topic, "DEBUG");
        }
        if (sOption) {
            // Stops Server
            stopserver();
        }
        if (ttOpt) {
            // set the default value for transaction timeout
            setTTimeout(timeout);
        }
        if (syncOpt) {
            // sync all entity instances outside transactions
            sync(false);
        }
        if (passivateOpt) {
            // sync all entity instances outside transactions
            sync(true);
        }
        if (gcOpt) {
            // run the garbage collector
            runGC();
        }

        // No option => interactive mode.
        if (interactive) {
            menu();
        }

        // Return status
        if (!interactive) {
            if (isError) {
                System.exit(2);
            }
        }
    }
}

---