Main Page | Packages | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | Related Pages

org.objectweb.cjdbc.console.text.Console Class Reference

List of all members.

Public Member Functions

void setDebug (boolean debug)
 Console (RmiJmxClient jmxClient, InputStream in, boolean interactive)
boolean isInteractive ()
void handlePrompt ()
String readLine (String prompt) throws ConsoleException
String readPassword (String prompt) throws ConsoleException
void print (String s)
void println (String s)
void println (String s, int color)
void println ()
void printError (String message)
void printInfo (String message)
void printError (String message, Exception e)
void showInfo (String[][] info, InfoViewer viewer)
RmiJmxClient getJmxClient ()
VirtualDatabaseAdmin getAdminModule ()
VirtualDatabaseConsole getConsoleModule ()
ControllerConsole getControllerModule ()
MonitorConsole getMonitorModule ()
final ConsoleReader getConsoleReader ()

Detailed Description

This is the C-JDBC controller console that allows remote administration and monitoring of any C-JDBC controller.

Author:
Emmanuel Cecchet

Mathieu Peltier

Nicolas Modrzyk

Version:
1.0

Definition at line 50 of file Console.java.


Constructor & Destructor Documentation

org.objectweb.cjdbc.console.text.Console.Console RmiJmxClient  jmxClient,
InputStream  in,
boolean  interactive
 

Creates a new Console instance.

Parameters:
jmxClient to connect to the jmxServer
in the inputstream to get the command from
interactive if set to true will display prompt

Definition at line 97 of file Console.java.

00098   {
00099     try
00100     {
00101       consoleReader = new ConsoleReader(in, new PrintWriter(System.out));
00102     }
00103     catch (IOException e)
00104     {
00105       System.err.println("Unable to create console: " + e.toString());
00106     }
00107     this.interactive = interactive;
00108     this.jmxClient = jmxClient;
00109 
00110     controllerModule = new ControllerConsole(this);
00111     adminModule = new VirtualDatabaseAdmin(this);
00112     monitorModule = new MonitorConsole(this);
00113     consoleModule = new VirtualDatabaseConsole(this);
00114     setSupportColors();
00115   }


Member Function Documentation

VirtualDatabaseAdmin org.objectweb.cjdbc.console.text.Console.getAdminModule  ) 
 

Returns the adminModule value.

Returns:
Returns the adminModule.

Definition at line 300 of file Console.java.

Referenced by org.objectweb.cjdbc.console.text.commands.controller.Admin.parse().

00301   {
00302     return adminModule;
00303   }

VirtualDatabaseConsole org.objectweb.cjdbc.console.text.Console.getConsoleModule  ) 
 

Returns the consoleModule value.

Returns:
Returns the consoleModule.

Definition at line 310 of file Console.java.

Referenced by org.objectweb.cjdbc.console.text.commands.controller.Connect.parse().

00311   {
00312     return consoleModule;
00313   }

final ConsoleReader org.objectweb.cjdbc.console.text.Console.getConsoleReader  ) 
 

Returns the consoleReader value.

Returns:
Returns the consoleReader.

Definition at line 340 of file Console.java.

00341   {
00342     return consoleReader;
00343   }

ControllerConsole org.objectweb.cjdbc.console.text.Console.getControllerModule  ) 
 

Returns the controllerModule value.

Returns:
Returns the controllerModule.

Definition at line 320 of file Console.java.

00321   {
00322     return controllerModule;
00323   }

RmiJmxClient org.objectweb.cjdbc.console.text.Console.getJmxClient  ) 
 

Returns the jmxClient value.

Returns:
Returns the jmxClient.

Definition at line 290 of file Console.java.

Referenced by org.objectweb.cjdbc.console.text.commands.monitor.AbstractMonitorCommand.AbstractMonitorCommand(), org.objectweb.cjdbc.console.text.commands.ConsoleCommand.ConsoleCommand(), org.objectweb.cjdbc.console.text.module.ControllerConsole.getPromptString(), and org.objectweb.cjdbc.console.text.module.VirtualDatabaseAdmin.login().

00291   {
00292     return jmxClient;
00293   }

MonitorConsole org.objectweb.cjdbc.console.text.Console.getMonitorModule  ) 
 

Returns the monitorModule value.

Returns:
Returns the monitorModule.

Definition at line 330 of file Console.java.

Referenced by org.objectweb.cjdbc.console.text.commands.controller.Monitor.parse().

00331   {
00332     return monitorModule;
00333   }

void org.objectweb.cjdbc.console.text.Console.handlePrompt  ) 
 

Main menu prompt handling.

Definition at line 140 of file Console.java.

Referenced by org.objectweb.cjdbc.console.text.ConsoleLauncher.startTextConsole().

00141   {
00142     controllerModule.handlePrompt();
00143   }

boolean org.objectweb.cjdbc.console.text.Console.isInteractive  ) 
 

Returns the interactive value.

Returns:
Returns the interactive.

Definition at line 132 of file Console.java.

00133   {
00134     return interactive;
00135   }

void org.objectweb.cjdbc.console.text.Console.print String  s  ) 
 

See also:
Console.print(java.lang.String)

Definition at line 203 of file Console.java.

Referenced by org.objectweb.cjdbc.console.text.module.VirtualDatabaseConsole.displayResultSet().

00204   {
00205     System.out.print(s);
00206   }

void org.objectweb.cjdbc.console.text.Console.printError String  message,
Exception  e
 

Display an error and stack trace if in debug mode.

Parameters:
message error message
e exception that causes the error

Definition at line 263 of file Console.java.

00264   {
00265     if (debug)
00266       e.printStackTrace();
00267     printError(message);
00268   }

void org.objectweb.cjdbc.console.text.Console.printError String  message  ) 
 

See also:
Console.printError(java.lang.String)

Definition at line 241 of file Console.java.

Referenced by org.objectweb.cjdbc.console.text.module.VirtualDatabaseConsole.callStoredProcedure(), org.objectweb.cjdbc.console.text.module.VirtualDatabaseConsole.execSQL(), org.objectweb.cjdbc.console.text.module.AbstractConsoleModule.handleCommandLine(), org.objectweb.cjdbc.console.text.module.VirtualDatabaseConsole.handlePrompt(), org.objectweb.cjdbc.console.text.module.AbstractConsoleModule.handlePrompt(), org.objectweb.cjdbc.console.text.module.VirtualDatabaseConsole.load(), org.objectweb.cjdbc.console.text.module.VirtualDatabaseAdmin.login(), org.objectweb.cjdbc.console.text.module.MonitorConsole.login(), org.objectweb.cjdbc.console.text.commands.controller.Shutdown.parse(), org.objectweb.cjdbc.console.text.commands.dbadmin.ShowBackendState.parse(), org.objectweb.cjdbc.console.text.commands.monitor.ChangeTarget.parse(), org.objectweb.cjdbc.console.text.module.VirtualDatabaseConsole.showtables(), and org.objectweb.cjdbc.console.text.module.VirtualDatabaseConsole.VirtualDatabaseConsole().

00242   {
00243     if (printColor)
00244       ColorPrinter.printMessage(message, System.err, ColorPrinter.ERROR);
00245     else
00246       System.err.println(message);
00247   }

void org.objectweb.cjdbc.console.text.Console.printInfo String  message  ) 
 

See also:
Console.println()

Definition at line 252 of file Console.java.

Referenced by org.objectweb.cjdbc.console.text.module.AbstractConsoleModule.help(), and org.objectweb.cjdbc.console.text.commands.controller.Shutdown.parse().

00253   {
00254     println(message, ColorPrinter.INFO);
00255   }

void org.objectweb.cjdbc.console.text.Console.println  ) 
 

See also:
Console.println()

Definition at line 233 of file Console.java.

00234   {
00235     System.out.println();
00236   }

void org.objectweb.cjdbc.console.text.Console.println String  s,
int  color
 

Print in color

Parameters:
s the message to display
color the color to use

Definition at line 222 of file Console.java.

00223   {
00224     if (printColor)
00225       ColorPrinter.printMessage(s, System.out, color);
00226     else
00227       System.out.println(s);
00228   }

void org.objectweb.cjdbc.console.text.Console.println String  s  ) 
 

See also:
Console.println(java.lang.String)

Definition at line 211 of file Console.java.

Referenced by org.objectweb.cjdbc.console.text.module.AbstractConsoleModule.AbstractConsoleModule(), org.objectweb.cjdbc.console.text.module.VirtualDatabaseConsole.callStoredProcedure(), org.objectweb.cjdbc.console.text.module.VirtualDatabaseConsole.displayResultSet(), org.objectweb.cjdbc.console.text.module.VirtualDatabaseConsole.execSQL(), org.objectweb.cjdbc.console.text.commands.Native.execute(), org.objectweb.cjdbc.console.text.module.VirtualDatabaseConsole.handlePrompt(), org.objectweb.cjdbc.console.text.module.VirtualDatabaseConsole.help(), org.objectweb.cjdbc.console.text.module.AbstractConsoleModule.help(), org.objectweb.cjdbc.console.text.module.VirtualDatabaseConsole.load(), org.objectweb.cjdbc.console.text.module.VirtualDatabaseAdmin.login(), org.objectweb.cjdbc.console.text.commands.dbadmin.ViewDumpNames.parse(), org.objectweb.cjdbc.console.text.commands.dbadmin.ViewCheckpointNames.parse(), org.objectweb.cjdbc.console.text.commands.dbadmin.TransferBackend.parse(), org.objectweb.cjdbc.console.text.commands.controller.Shutdown.parse(), org.objectweb.cjdbc.console.text.commands.dbadmin.ShowBackendState.parse(), org.objectweb.cjdbc.console.text.commands.dbadmin.SetCheckpoint.parse(), org.objectweb.cjdbc.console.text.commands.dbadmin.Restore.parse(), org.objectweb.cjdbc.console.text.commands.controller.Report.parse(), org.objectweb.cjdbc.console.text.commands.dbadmin.Replicate.parse(), org.objectweb.cjdbc.console.text.commands.controller.RefreshLogs.parse(), org.objectweb.cjdbc.console.text.commands.controller.Load.parse(), org.objectweb.cjdbc.console.text.commands.controller.ListDatabases.parse(), org.objectweb.cjdbc.console.text.commands.History.parse(), org.objectweb.cjdbc.console.text.commands.controller.GetXml.parse(), org.objectweb.cjdbc.console.text.commands.controller.GetInfo.parse(), org.objectweb.cjdbc.console.text.commands.dbadmin.GetBackendSchema.parse(), org.objectweb.cjdbc.console.text.commands.dbadmin.EnableWrite.parse(), org.objectweb.cjdbc.console.text.commands.dbadmin.EnableRead.parse(), org.objectweb.cjdbc.console.text.commands.dbadmin.Enable.parse(), org.objectweb.cjdbc.console.text.commands.controller.DropDB.parse(), org.objectweb.cjdbc.console.text.commands.dbadmin.DisableWrite.parse(), org.objectweb.cjdbc.console.text.commands.dbadmin.DisableRead.parse(), org.objectweb.cjdbc.console.text.commands.dbadmin.Disable.parse(), org.objectweb.cjdbc.console.text.commands.controller.Bind.parse(), org.objectweb.cjdbc.console.text.commands.dbadmin.Backup.parse(), org.objectweb.cjdbc.console.text.commands.controller.AddDriver.parse(), org.objectweb.cjdbc.console.text.module.ControllerConsole.quit(), org.objectweb.cjdbc.console.text.module.VirtualDatabaseConsole.showtables(), and org.objectweb.cjdbc.console.text.module.VirtualDatabaseConsole.VirtualDatabaseConsole().

00212   {
00213     System.out.println(s);
00214   }

String org.objectweb.cjdbc.console.text.Console.readLine String  prompt  )  throws ConsoleException
 

See also:
Console.readLine(java.lang.String)

Definition at line 148 of file Console.java.

Referenced by org.objectweb.cjdbc.console.text.module.VirtualDatabaseConsole.displayResultSet(), org.objectweb.cjdbc.console.text.module.VirtualDatabaseConsole.handlePrompt(), org.objectweb.cjdbc.console.text.module.AbstractConsoleModule.handlePrompt(), org.objectweb.cjdbc.console.text.module.VirtualDatabaseConsole.login(), org.objectweb.cjdbc.console.text.module.VirtualDatabaseAdmin.login(), org.objectweb.cjdbc.console.text.commands.controller.Load.parse(), org.objectweb.cjdbc.console.text.commands.controller.Bind.parse(), and org.objectweb.cjdbc.console.text.commands.controller.AddDriver.parse().

00149   {
00150     if (interactive)
00151       printPrompt(prompt + " > ");
00152     String line = "";
00153     try
00154     {
00155       line = consoleReader.readLine();
00156     }
00157     catch (IOException e)
00158     {
00159       throw new ConsoleException(ConsoleTranslate.get(
00160           "console.read.command.failed", e));
00161     }
00162     if (line != null)
00163       line = line.trim();
00164     return line;
00165   }

String org.objectweb.cjdbc.console.text.Console.readPassword String  prompt  )  throws ConsoleException
 

See also:
Console.readPassword(java.lang.String)

Definition at line 183 of file Console.java.

Referenced by org.objectweb.cjdbc.console.text.module.VirtualDatabaseConsole.login(), and org.objectweb.cjdbc.console.text.module.VirtualDatabaseAdmin.login().

00184   {
00185     if (interactive)
00186       printPrompt(prompt + " > ");
00187     String password;
00188     try
00189     {
00190       password = consoleReader.readLine(PASSWORD_CHAR);
00191     }
00192     catch (IOException e)
00193     {
00194       throw new ConsoleException(ConsoleTranslate.get(
00195           "console.read.password.failed", e));
00196     }
00197     return password;
00198   }

void org.objectweb.cjdbc.console.text.Console.setDebug boolean  debug  ) 
 

Alert this console to show additionnal debugging information

Parameters:
debug true if debug information needed

Definition at line 85 of file Console.java.

Referenced by org.objectweb.cjdbc.console.text.ConsoleLauncher.startTextConsole().

00086   {
00087     this.debug = debug;
00088   }

void org.objectweb.cjdbc.console.text.Console.showInfo String  info[][],
InfoViewer  viewer
 

Show a table of info in a formatted way

Parameters:
info the data to display
viewer the viewer to use to get the name of the columns and the format of data

Definition at line 277 of file Console.java.

References org.objectweb.cjdbc.console.views.InfoViewer.displayText().

Referenced by org.objectweb.cjdbc.console.text.commands.monitor.ShowStats.parse(), org.objectweb.cjdbc.console.text.commands.monitor.ShowScheduler.parse(), org.objectweb.cjdbc.console.text.commands.monitor.ShowRecoveryLog.parse(), org.objectweb.cjdbc.console.text.commands.monitor.ShowDatabases.parse(), org.objectweb.cjdbc.console.text.commands.monitor.ShowController.parse(), org.objectweb.cjdbc.console.text.commands.monitor.ShowCacheStats.parse(), org.objectweb.cjdbc.console.text.commands.monitor.ShowCache.parse(), org.objectweb.cjdbc.console.text.commands.monitor.ShowBackends.parse(), and org.objectweb.cjdbc.console.text.commands.dbadmin.ShowBackends.parse().

00278   {
00279     if (printColor)
00280       println(viewer.displayText(info), ColorPrinter.STATUS);
00281     else
00282       System.out.println(viewer.displayText(info));
00283   }


The documentation for this class was generated from the following file:
Generated on Mon Apr 11 22:02:40 2005 for C-JDBC by  doxygen 1.3.9.1