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

org.objectweb.cjdbc.console.text.commands.ConsoleCommand Class Reference

Inheritance diagram for org.objectweb.cjdbc.console.text.commands.ConsoleCommand:

Inheritance graph
[legend]
Collaboration diagram for org.objectweb.cjdbc.console.text.commands.ConsoleCommand:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 ConsoleCommand (AbstractConsoleModule module)
int compareTo (Object o)
abstract void parse (String commandText) throws Exception
void execute (String commandText) throws Exception
abstract String getCommandName ()
String getCommandParameters ()
abstract String getCommandDescription ()

Protected Attributes

Console console
RmiJmxClient jmxClient
AbstractConsoleModule module

Detailed Description

This class defines a ConsoleCommand

Author:
Nicolas Modrzyk

Mathieu Peltier

Version:
1.0

Definition at line 40 of file ConsoleCommand.java.

Constructor & Destructor Documentation

org.objectweb.cjdbc.console.text.commands.ConsoleCommand.ConsoleCommand (  AbstractConsoleModule  module  ) 
 

Creates a new ConsoleCommand.java object

Parameters:
module module that owns this commands

Definition at line 51 of file ConsoleCommand.java.

References org.objectweb.cjdbc.console.text.Console.getJmxClient().

00052   {
00053     this.console = module.getConsole();
00054     this.module = module;
00055     jmxClient = console.getJmxClient();
00056   }

Member Function Documentation

int org.objectweb.cjdbc.console.text.commands.ConsoleCommand.compareTo (  Object  o  ) 
 

See also:
java.lang.Comparable#compareTo(java.lang.Object)

Definition at line 61 of file ConsoleCommand.java.

References org.objectweb.cjdbc.console.text.commands.ConsoleCommand.getCommandName().

00062   {
00063     if (o instanceof ConsoleCommand)
00064     {
00065       ConsoleCommand c = (ConsoleCommand) o;
00066       return getCommandName().compareTo(c.getCommandName());
00067     }
00068     else
00069     {
00070       throw new IllegalArgumentException();
00071     }
00072   }

void org.objectweb.cjdbc.console.text.commands.ConsoleCommand.execute (  String  commandText  )  throws Exception
 

Check if the JMX connection is still valid. Otherwise reconnect.

Parameters:
commandText the parameters to execute the command with
Exceptions:
Exception if fails

Reimplemented in org.objectweb.cjdbc.console.text.commands.Help, org.objectweb.cjdbc.console.text.commands.Native, and org.objectweb.cjdbc.console.text.commands.Quit.

Definition at line 89 of file ConsoleCommand.java.

References org.objectweb.cjdbc.console.text.commands.ConsoleCommand.parse().

Referenced by org.objectweb.cjdbc.console.text.module.AbstractConsoleModule.handleCommandLine().

00090   {
00091     if (!jmxClient.isValidConnection())
00092     {
00093       try
00094       {
00095         jmxClient.reconnect();
00096       }
00097       catch (Exception e)
00098       {
00099         throw new ConsoleException(ConsoleTranslate
00100             .get("jmx.server.connection.lost"));
00101       }
00102     }
00103     parse(commandText);
00104   }

abstract String org.objectweb.cjdbc.console.text.commands.ConsoleCommand.getCommandDescription (   )  [pure virtual]
 

Get the description of the command

Returns:
String of the command description

Implemented in org.objectweb.cjdbc.console.text.commands.controller.AddDriver, org.objectweb.cjdbc.console.text.commands.controller.Admin, org.objectweb.cjdbc.console.text.commands.controller.Bind, org.objectweb.cjdbc.console.text.commands.controller.Connect, org.objectweb.cjdbc.console.text.commands.controller.DropDB, org.objectweb.cjdbc.console.text.commands.controller.GetInfo, org.objectweb.cjdbc.console.text.commands.controller.GetXml, org.objectweb.cjdbc.console.text.commands.controller.ListDatabases, org.objectweb.cjdbc.console.text.commands.controller.Load, org.objectweb.cjdbc.console.text.commands.controller.Monitor, org.objectweb.cjdbc.console.text.commands.controller.RefreshLogs, org.objectweb.cjdbc.console.text.commands.controller.Report, org.objectweb.cjdbc.console.text.commands.controller.SaveConfiguration, org.objectweb.cjdbc.console.text.commands.controller.Shutdown, org.objectweb.cjdbc.console.text.commands.dbadmin.Backup, org.objectweb.cjdbc.console.text.commands.dbadmin.Disable, org.objectweb.cjdbc.console.text.commands.dbadmin.DisableAll, org.objectweb.cjdbc.console.text.commands.dbadmin.DisableRead, org.objectweb.cjdbc.console.text.commands.dbadmin.DisableWrite, org.objectweb.cjdbc.console.text.commands.dbadmin.Enable, org.objectweb.cjdbc.console.text.commands.dbadmin.EnableAll, org.objectweb.cjdbc.console.text.commands.dbadmin.EnableRead, org.objectweb.cjdbc.console.text.commands.dbadmin.EnableWrite, org.objectweb.cjdbc.console.text.commands.dbadmin.GetBackendSchema, org.objectweb.cjdbc.console.text.commands.dbadmin.RemoveCheckpoint, org.objectweb.cjdbc.console.text.commands.dbadmin.RemoveDumpFile, org.objectweb.cjdbc.console.text.commands.dbadmin.Replicate, org.objectweb.cjdbc.console.text.commands.dbadmin.Restore, org.objectweb.cjdbc.console.text.commands.dbadmin.SetCheckpoint, org.objectweb.cjdbc.console.text.commands.dbadmin.ShowBackends, org.objectweb.cjdbc.console.text.commands.dbadmin.ShowBackendState, org.objectweb.cjdbc.console.text.commands.dbadmin.TransferBackend, org.objectweb.cjdbc.console.text.commands.dbadmin.ViewCheckpointNames, org.objectweb.cjdbc.console.text.commands.dbadmin.ViewDumpNames, org.objectweb.cjdbc.console.text.commands.Help, org.objectweb.cjdbc.console.text.commands.History, org.objectweb.cjdbc.console.text.commands.monitor.ChangeTarget, org.objectweb.cjdbc.console.text.commands.monitor.ShowBackends, org.objectweb.cjdbc.console.text.commands.monitor.ShowCache, org.objectweb.cjdbc.console.text.commands.monitor.ShowCacheStats, org.objectweb.cjdbc.console.text.commands.monitor.ShowController, org.objectweb.cjdbc.console.text.commands.monitor.ShowDatabases, org.objectweb.cjdbc.console.text.commands.monitor.ShowRecoveryLog, org.objectweb.cjdbc.console.text.commands.monitor.ShowScheduler, org.objectweb.cjdbc.console.text.commands.monitor.ShowStats, org.objectweb.cjdbc.console.text.commands.Native, and org.objectweb.cjdbc.console.text.commands.Quit.

Referenced by org.objectweb.cjdbc.console.text.module.AbstractConsoleModule.help().

abstract String org.objectweb.cjdbc.console.text.commands.ConsoleCommand.getCommandName (   )  [pure virtual]
 

Get the name of the command

Returns:
String of the command name

Implemented in org.objectweb.cjdbc.console.text.commands.controller.AddDriver, org.objectweb.cjdbc.console.text.commands.controller.Admin, org.objectweb.cjdbc.console.text.commands.controller.Bind, org.objectweb.cjdbc.console.text.commands.controller.Connect, org.objectweb.cjdbc.console.text.commands.controller.DropDB, org.objectweb.cjdbc.console.text.commands.controller.GetInfo, org.objectweb.cjdbc.console.text.commands.controller.GetXml, org.objectweb.cjdbc.console.text.commands.controller.ListDatabases, org.objectweb.cjdbc.console.text.commands.controller.Load, org.objectweb.cjdbc.console.text.commands.controller.Monitor, org.objectweb.cjdbc.console.text.commands.controller.RefreshLogs, org.objectweb.cjdbc.console.text.commands.controller.Report, org.objectweb.cjdbc.console.text.commands.controller.SaveConfiguration, org.objectweb.cjdbc.console.text.commands.controller.Shutdown, org.objectweb.cjdbc.console.text.commands.dbadmin.Backup, org.objectweb.cjdbc.console.text.commands.dbadmin.Disable, org.objectweb.cjdbc.console.text.commands.dbadmin.DisableAll, org.objectweb.cjdbc.console.text.commands.dbadmin.DisableRead, org.objectweb.cjdbc.console.text.commands.dbadmin.DisableWrite, org.objectweb.cjdbc.console.text.commands.dbadmin.Enable, org.objectweb.cjdbc.console.text.commands.dbadmin.EnableAll, org.objectweb.cjdbc.console.text.commands.dbadmin.EnableRead, org.objectweb.cjdbc.console.text.commands.dbadmin.EnableWrite, org.objectweb.cjdbc.console.text.commands.dbadmin.GetBackendSchema, org.objectweb.cjdbc.console.text.commands.dbadmin.RemoveCheckpoint, org.objectweb.cjdbc.console.text.commands.dbadmin.RemoveDumpFile, org.objectweb.cjdbc.console.text.commands.dbadmin.Replicate, org.objectweb.cjdbc.console.text.commands.dbadmin.Restore, org.objectweb.cjdbc.console.text.commands.dbadmin.SetCheckpoint, org.objectweb.cjdbc.console.text.commands.dbadmin.ShowBackends, org.objectweb.cjdbc.console.text.commands.dbadmin.ShowBackendState, org.objectweb.cjdbc.console.text.commands.dbadmin.TransferBackend, org.objectweb.cjdbc.console.text.commands.dbadmin.ViewCheckpointNames, org.objectweb.cjdbc.console.text.commands.dbadmin.ViewDumpNames, org.objectweb.cjdbc.console.text.commands.Help, org.objectweb.cjdbc.console.text.commands.History, org.objectweb.cjdbc.console.text.commands.monitor.ChangeTarget, org.objectweb.cjdbc.console.text.commands.monitor.ShowBackends, org.objectweb.cjdbc.console.text.commands.monitor.ShowCache, org.objectweb.cjdbc.console.text.commands.monitor.ShowCacheStats, org.objectweb.cjdbc.console.text.commands.monitor.ShowController, org.objectweb.cjdbc.console.text.commands.monitor.ShowDatabases, org.objectweb.cjdbc.console.text.commands.monitor.ShowRecoveryLog, org.objectweb.cjdbc.console.text.commands.monitor.ShowScheduler, org.objectweb.cjdbc.console.text.commands.monitor.ShowStats, org.objectweb.cjdbc.console.text.commands.Native, and org.objectweb.cjdbc.console.text.commands.Quit.

Referenced by org.objectweb.cjdbc.console.text.commands.ConsoleCommand.compareTo(), org.objectweb.cjdbc.console.text.module.AbstractConsoleModule.getHashCommands(), and org.objectweb.cjdbc.console.text.module.AbstractConsoleModule.help().

String org.objectweb.cjdbc.console.text.commands.ConsoleCommand.getCommandParameters (   ) 
 

Return a String description of the parameters of this command.

Returns:
String like <driverPathName>

Reimplemented in org.objectweb.cjdbc.console.text.commands.controller.AddDriver, org.objectweb.cjdbc.console.text.commands.controller.Admin, org.objectweb.cjdbc.console.text.commands.controller.Connect, org.objectweb.cjdbc.console.text.commands.controller.DropDB, org.objectweb.cjdbc.console.text.commands.controller.Load, org.objectweb.cjdbc.console.text.commands.controller.Monitor, org.objectweb.cjdbc.console.text.commands.controller.Shutdown, org.objectweb.cjdbc.console.text.commands.dbadmin.Backup, org.objectweb.cjdbc.console.text.commands.dbadmin.Disable, org.objectweb.cjdbc.console.text.commands.dbadmin.DisableRead, org.objectweb.cjdbc.console.text.commands.dbadmin.DisableWrite, org.objectweb.cjdbc.console.text.commands.dbadmin.Enable, org.objectweb.cjdbc.console.text.commands.dbadmin.EnableAll, org.objectweb.cjdbc.console.text.commands.dbadmin.EnableRead, org.objectweb.cjdbc.console.text.commands.dbadmin.EnableWrite, org.objectweb.cjdbc.console.text.commands.dbadmin.GetBackendSchema, org.objectweb.cjdbc.console.text.commands.dbadmin.RemoveCheckpoint, org.objectweb.cjdbc.console.text.commands.dbadmin.RemoveDumpFile, org.objectweb.cjdbc.console.text.commands.dbadmin.Replicate, org.objectweb.cjdbc.console.text.commands.dbadmin.Restore, org.objectweb.cjdbc.console.text.commands.dbadmin.SetCheckpoint, org.objectweb.cjdbc.console.text.commands.dbadmin.ShowBackendState, org.objectweb.cjdbc.console.text.commands.dbadmin.TransferBackend, and org.objectweb.cjdbc.console.text.commands.History.

Definition at line 119 of file ConsoleCommand.java.

Referenced by org.objectweb.cjdbc.console.text.module.AbstractConsoleModule.help().

00120   {
00121     return "";
00122   }

abstract void org.objectweb.cjdbc.console.text.commands.ConsoleCommand.parse (  String  commandText  )  throws Exception [pure virtual]
 

Parse the text of the command

Parameters:
commandText the command text
Exceptions:
Exception if connection with the mbean server is lost or command does not have the proper format

Implemented in org.objectweb.cjdbc.console.text.commands.controller.AddDriver, org.objectweb.cjdbc.console.text.commands.controller.Admin, org.objectweb.cjdbc.console.text.commands.controller.Bind, org.objectweb.cjdbc.console.text.commands.controller.Connect, org.objectweb.cjdbc.console.text.commands.controller.DropDB, org.objectweb.cjdbc.console.text.commands.controller.GetInfo, org.objectweb.cjdbc.console.text.commands.controller.GetXml, org.objectweb.cjdbc.console.text.commands.controller.ListDatabases, org.objectweb.cjdbc.console.text.commands.controller.Load, org.objectweb.cjdbc.console.text.commands.controller.Monitor, org.objectweb.cjdbc.console.text.commands.controller.RefreshLogs, org.objectweb.cjdbc.console.text.commands.controller.Report, org.objectweb.cjdbc.console.text.commands.controller.SaveConfiguration, org.objectweb.cjdbc.console.text.commands.controller.Shutdown, org.objectweb.cjdbc.console.text.commands.dbadmin.Backup, org.objectweb.cjdbc.console.text.commands.dbadmin.Disable, org.objectweb.cjdbc.console.text.commands.dbadmin.DisableAll, org.objectweb.cjdbc.console.text.commands.dbadmin.DisableRead, org.objectweb.cjdbc.console.text.commands.dbadmin.DisableWrite, org.objectweb.cjdbc.console.text.commands.dbadmin.Enable, org.objectweb.cjdbc.console.text.commands.dbadmin.EnableAll, org.objectweb.cjdbc.console.text.commands.dbadmin.EnableRead, org.objectweb.cjdbc.console.text.commands.dbadmin.EnableWrite, org.objectweb.cjdbc.console.text.commands.dbadmin.GetBackendSchema, org.objectweb.cjdbc.console.text.commands.dbadmin.RemoveCheckpoint, org.objectweb.cjdbc.console.text.commands.dbadmin.RemoveDumpFile, org.objectweb.cjdbc.console.text.commands.dbadmin.Replicate, org.objectweb.cjdbc.console.text.commands.dbadmin.Restore, org.objectweb.cjdbc.console.text.commands.dbadmin.SetCheckpoint, org.objectweb.cjdbc.console.text.commands.dbadmin.ShowBackends, org.objectweb.cjdbc.console.text.commands.dbadmin.ShowBackendState, org.objectweb.cjdbc.console.text.commands.dbadmin.TransferBackend, org.objectweb.cjdbc.console.text.commands.dbadmin.ViewCheckpointNames, org.objectweb.cjdbc.console.text.commands.dbadmin.ViewDumpNames, org.objectweb.cjdbc.console.text.commands.Help, org.objectweb.cjdbc.console.text.commands.History, org.objectweb.cjdbc.console.text.commands.monitor.ChangeTarget, org.objectweb.cjdbc.console.text.commands.monitor.ShowBackends, org.objectweb.cjdbc.console.text.commands.monitor.ShowCache, org.objectweb.cjdbc.console.text.commands.monitor.ShowCacheStats, org.objectweb.cjdbc.console.text.commands.monitor.ShowController, org.objectweb.cjdbc.console.text.commands.monitor.ShowDatabases, org.objectweb.cjdbc.console.text.commands.monitor.ShowRecoveryLog, org.objectweb.cjdbc.console.text.commands.monitor.ShowScheduler, org.objectweb.cjdbc.console.text.commands.monitor.ShowStats, org.objectweb.cjdbc.console.text.commands.Native, and org.objectweb.cjdbc.console.text.commands.Quit.

Referenced by org.objectweb.cjdbc.console.text.commands.ConsoleCommand.execute().

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