Console.java

/**
 * C-JDBC: Clustered JDBC.
 * Copyright (C) 2002-2004 French National Institute For Research In Computer
 * Science And Control (INRIA).
 * Contact: c-jdbc@objectweb.org
 * 
 * This library 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 any later
 * version.
 * 
 * This library 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 library; if not, write to the Free Software Foundation,
 * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
 *
 * Initial developer(s): Emmanuel Cecchet. 
 * Contributor(s): Mathieu Peltier,Nicolas Modrzyk
 */

package org.objectweb.cjdbc.console.text;

import java.io.IOException;
import java.io.InputStream;
import java.io.PrintWriter;

import jline.ConsoleReader;

import org.objectweb.cjdbc.common.i18n.ConsoleTranslate;
import org.objectweb.cjdbc.console.jmx.RmiJmxClient;
import org.objectweb.cjdbc.console.text.module.ControllerConsole;
import org.objectweb.cjdbc.console.text.module.MonitorConsole;
import org.objectweb.cjdbc.console.text.module.VirtualDatabaseAdmin;
import org.objectweb.cjdbc.console.text.module.VirtualDatabaseConsole;
import org.objectweb.cjdbc.console.views.InfoViewer;

/**
 * This is the C-JDBC controller console that allows remote administration and
 * monitoring of any C-JDBC controller.
 * 
 * @author <a href="mailto:Emmanuel.Cecchet@inria.fr">Emmanuel Cecchet </a>
 * @author <a href="mailto:Mathieu.Peltier@inrialpes.fr">Mathieu Peltier </a>
 * @author <a href="mailto:Nicolas.Modrzyk@inrialpes.fr">Nicolas Modrzyk </a>
 * @version 1.0
 */
public class Console
{

  /** <code>ConsoleReader</code> allowing to reading input. */
  private ConsoleReader          consoleReader;

  private static final Character PASSWORD_CHAR = new Character('*');

  /** <code>true</code> if the console is used in interactive mode. */
  private boolean                interactive;

  private RmiJmxClient           jmxClient;

  /** Virtual database administration console. */
  private VirtualDatabaseAdmin   adminModule;

  /** Monitoring console */
  private MonitorConsole         monitorModule;

  /** Virtual database console. */
  private VirtualDatabaseConsole consoleModule;

  /** Controller Console */
  private ControllerConsole      controllerModule;

  /** Debug Mode */
  private boolean                debug         = false;

  private boolean                printColor    = true;

  /**
   * Alert this console to show additionnal debugging information
   * 
   * @param debug <code>true</code> if debug information needed
   */
  public void setDebug(boolean debug)
  {
    this.debug = debug;
  }

  /**
   * Creates a new <code>Console</code> instance.
   * 
   * @param jmxClient to connect to the jmxServer
   * @param in the inputstream to get the command from
   * @param interactive if set to <code>true</code> will display prompt
   */
  public Console(RmiJmxClient jmxClient, InputStream in, boolean interactive)
  {
    try
    {
      consoleReader = new ConsoleReader(in, new PrintWriter(System.out));
    }
    catch (IOException e)
    {
      System.err.println("Unable to create console: " + e.toString());
    }
    this.interactive = interactive;
    this.jmxClient = jmxClient;

    controllerModule = new ControllerConsole(this);
    adminModule = new VirtualDatabaseAdmin(this);
    monitorModule = new MonitorConsole(this);
    consoleModule = new VirtualDatabaseConsole(this);
    setSupportColors();
  }

  private void setSupportColors()
  {
    String os = System.getProperty("os.name").toLowerCase();
    boolean windows = os.indexOf("nt") > -1 || os.indexOf("windows") > -1;
    if (windows)
      printColor = false;
    else
      printColor = true;
  }

  /**
   * Returns the interactive value.
   * 
   * @return Returns the interactive.
   */
  public boolean isInteractive()
  {
    return interactive;
  }

  /**
   * Main menu prompt handling.
   */
  public void handlePrompt()
  {
    controllerModule.handlePrompt();
  }

  /**
   * @see Console#readLine(java.lang.String)
   */
  public String readLine(String prompt) throws ConsoleException
  {
    if (interactive)
      printPrompt(prompt + " > ");
    String line = "";
    try
    {
      line = consoleReader.readLine();
    }
    catch (IOException e)
    {
      throw new ConsoleException(ConsoleTranslate.get(
          "console.read.command.failed", e));
    }
    if (line != null)
      line = line.trim();
    return line;
  }

  /**
   * Print prompt line
   * 
   * @param string the string to pring
   */
  private void printPrompt(String string)
  {
    if (printColor)
      ColorPrinter.printMessage(string, System.out, ColorPrinter.PROMPT, false);
    else
      print(string);
  }

  /**
   * @see Console#readPassword(java.lang.String)
   */
  public String readPassword(String prompt) throws ConsoleException
  {
    if (interactive)
      printPrompt(prompt + " > ");
    String password;
    try
    {
      password = consoleReader.readLine(PASSWORD_CHAR);
    }
    catch (IOException e)
    {
      throw new ConsoleException(ConsoleTranslate.get(
          "console.read.password.failed", e));
    }
    return password;
  }

  /**
   * @see Console#print(java.lang.String)
   */
  public void print(String s)
  {
    System.out.print(s);
  }

  /**
   * @see Console#println(java.lang.String)
   */
  public void println(String s)
  {
    System.out.println(s);
  }

  /**
   * Print in color
   * 
   * @param s the message to display
   * @param color the color to use
   */
  public void println(String s, int color)
  {
    if (printColor)
      ColorPrinter.printMessage(s, System.out, color);
    else
      System.out.println(s);
  }

  /**
   * @see Console#println()
   */
  public void println()
  {
    System.out.println();
  }

  /**
   * @see Console#printError(java.lang.String)
   */
  public void printError(String message)
  {
    if (printColor)
      ColorPrinter.printMessage(message, System.err, ColorPrinter.ERROR);
    else
      System.err.println(message);
  }

  /**
   * @see Console#println()
   */
  public void printInfo(String message)
  {
    println(message, ColorPrinter.INFO);
  }

  /**
   * Display an error and stack trace if in debug mode.
   * 
   * @param message error message
   * @param e exception that causes the error
   */
  public void printError(String message, Exception e)
  {
    if (debug)
      e.printStackTrace();
    printError(message);
  }

  /**
   * Show a table of info in a formatted way
   * 
   * @param info the data to display
   * @param viewer the viewer to use to get the name of the columns and the
   *                 format of data
   */
  public void showInfo(String[][] info, InfoViewer viewer)
  {
    if (printColor)
      println(viewer.displayText(info), ColorPrinter.STATUS);
    else
      System.out.println(viewer.displayText(info));
  }

  /**
   * Returns the jmxClient value.
   * 
   * @return Returns the jmxClient.
   */
  public RmiJmxClient getJmxClient()
  {
    return jmxClient;
  }

  /**
   * Returns the adminModule value.
   * 
   * @return Returns the adminModule.
   */
  public VirtualDatabaseAdmin getAdminModule()
  {
    return adminModule;
  }

  /**
   * Returns the consoleModule value.
   * 
   * @return Returns the consoleModule.
   */
  public VirtualDatabaseConsole getConsoleModule()
  {
    return consoleModule;
  }

  /**
   * Returns the controllerModule value.
   * 
   * @return Returns the controllerModule.
   */
  public ControllerConsole getControllerModule()
  {
    return controllerModule;
  }

  /**
   * Returns the monitorModule value.
   * 
   * @return Returns the monitorModule.
   */
  public MonitorConsole getMonitorModule()
  {
    return monitorModule;
  }

  /**
   * Returns the consoleReader value.
   * 
   * @return Returns the consoleReader.
   */
  public final ConsoleReader getConsoleReader()
  {
    return consoleReader;
  }
}

---