org.objectweb.cjdbc.console.text.module
Class VirtualDatabaseAdmin

java.lang.Object
  org.objectweb.cjdbc.console.text.module.AbstractConsoleModule
      org.objectweb.cjdbc.console.text.module.VirtualDatabaseAdmin

public class VirtualDatabaseAdmin

extends AbstractConsoleModule

This is the C-JDBC controller console virtual database administration module.

Version:

1.0

Author:

Emmanuel Cecchet , Mathieu Peltier , Nicolas Modrzyk

Nested Class Summary

Nested classes inherited from class org.objectweb.cjdbc.console.text.module.AbstractConsoleModule

AbstractConsoleModule.CommandDelimiter

Field Summary

private java.lang.String	login
private java.lang.String	password
private java.lang.String	virtualDbName

Fields inherited from class org.objectweb.cjdbc.console.text.module.AbstractConsoleModule

commands, console, consoleCompletor, history, quit

Constructor Summary

VirtualDatabaseAdmin(Console console)
Creates a new VirtualDatabaseAdmin instance.

Method Summary

void	addExpertCommands() Add the expert commands to the list of admin commands.
private java.util.Set	expertCommandsSet() Create a Set of expert commands.
java.lang.String	getDescriptionString() Text description of this module
java.lang.String	getLogin() Returns the login value.
java.lang.String	getPassword() Returns the password value.
java.lang.String	getPromptString() Get the prompt string for this module
java.lang.String	getVirtualDbName() Returns the virtualDbName value.
protected void	loadCommands() Loads the commands for this module
void	login(java.lang.String[] params) Handles login in this module
void	removeExpertCommands() Revmoe the expert commands from the list of admin commands.

Methods inherited from class org.objectweb.cjdbc.console.text.module.AbstractConsoleModule

findConsoleCommand, getCommands, getCompletor, getConsole, getHashCommands, getHistory, handleCommandLine, handlePrompt, help, loadCompletor, loadHistory, manageHistory, quit, reloadCompletor, storeHistory

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

virtualDbName

private java.lang.String virtualDbName

login

private java.lang.String login

password

private java.lang.String password

Constructor Detail

VirtualDatabaseAdmin

public VirtualDatabaseAdmin(Console console)

Creates a new VirtualDatabaseAdmin instance.

Parameters:

console - console console

Method Detail

getLogin

public java.lang.String getLogin()

Returns the login value.

Returns:

Returns the login.

getPassword

public java.lang.String getPassword()

Returns the password value.

Returns:

Returns the password.

getVirtualDbName

public java.lang.String getVirtualDbName()

Returns the virtualDbName value.

Returns:

Returns the virtualDbName.

login

public void login(java.lang.String[] params)

Description copied from class: AbstractConsoleModule

Handles login in this module

Specified by:

login in class AbstractConsoleModule

Parameters:

params - parameters to use to login in this module

See Also:

AbstractConsoleModule.login(java.lang.String[])

getDescriptionString

public java.lang.String getDescriptionString()

Description copied from class: AbstractConsoleModule

Text description of this module

Specified by:

getDescriptionString in class AbstractConsoleModule

Returns:

String description to display

See Also:

AbstractConsoleModule.getDescriptionString()

getPromptString

public java.lang.String getPromptString()

Description copied from class: AbstractConsoleModule

Get the prompt string for this module

Specified by:

getPromptString in class AbstractConsoleModule

Returns:

String to place before prompt

See Also:

AbstractConsoleModule.getPromptString()

loadCommands

protected void loadCommands()

Description copied from class: AbstractConsoleModule

Loads the commands for this module

Specified by:

loadCommands in class AbstractConsoleModule

See Also:

AbstractConsoleModule.loadCommands()

expertCommandsSet

private java.util.Set expertCommandsSet()

Create a Set of expert commands. This Set of commands can be added/removed dynamically to the list of admin commands with the methods addExpertCommands() and removeExpertCommands()

Returns:

addExpertCommands

public void addExpertCommands()

Add the expert commands to the list of admin commands.

removeExpertCommands

public void removeExpertCommands()

Revmoe the expert commands from the list of admin commands.