メインページ | パッケージ | クラス階層 | 構成 | ファイル一覧 | 構成メンバ | 関連ページ | 検索 

インタフェース org.objectweb.cjdbc.common.jmx.mbeans.VirtualDatabaseMBean

すべてのメンバ一覧

説明

JMX Interface to remotely manage a Virtual Databases.

作者:
Emmanuel Cecchet

Nicolas Modrzyk

バージョン:
1.0

VirtualDatabaseMBean.java の 43 行で定義されています。

Public メソッド

void backupBackendWithCheckpoint (String backendName, String checkpointName, ArrayList tables) throws VirtualDatabaseException

関数

String getBackendInformation (String backendName) throws VirtualDatabaseException
boolean hasRecoveryLog ()
String[] viewBackendInformation (String backendName) throws VirtualDatabaseException
void enableBackend (String databaseBackendName) throws VirtualDatabaseException
void enableBackendFromLastCheckpoint (String backendName) throws VirtualDatabaseException
void enableBackendFromCheckpoint (String databaseBackendName, String checkpointName) throws VirtualDatabaseException
void disableBackend (String databaseBackendName) throws VirtualDatabaseException
void restoreBackendFromBackupCheckpoint (String databaseBackendName, String checkpointName) throws VirtualDatabaseException, BackupException, OctopusException
void disableBackendForCheckpoint (String databaseBackendName, String checkpointName) throws VirtualDatabaseException
String getName ()
ArrayList viewCheckpointNames ()
String getBackendState (String backendName) throws VirtualDatabaseException
ArrayList viewAllBackendNames () throws VirtualDatabaseException
Hashtable viewGroupBackends () throws VirtualDatabaseException
void enableAllBackend () throws VirtualDatabaseException
void enableAllBackend (String checkpoint) throws VirtualDatabaseException
void enableAllBackendsFromRecovery (String checkpoint) throws VirtualDatabaseException
void disableAllBackend () throws VirtualDatabaseException
void disableAllBackendForCheckpoint (String checkpoint) throws VirtualDatabaseException
void removeCheckpoint (String checkpoint) throws VirtualDatabaseException
boolean checkAdminAuthentication (String adminLogin, String adminPassword) throws VirtualDatabaseException
void shutdown () throws VirtualDatabaseException
void setBackendLastKnownCheckpoint (String backendName, String checkpoint) throws VirtualDatabaseException
String viewOwningController ()
boolean isDistributed ()
void replicateBackend (String backendName, String newBackendName, Map parameters) throws VirtualDatabaseException
String[][] retrieveBackendsData () throws Exception
String[] viewControllerList ()
void removeBackend (String backend) throws VirtualDatabaseException
void transferBackend (String backend, String controllerDestination) throws VirtualDatabaseException
void callBackupManager (boolean backup, String backendName, String checkpoint, ArrayList tables, boolean enableAfter, BackupListener listener) throws VirtualDatabaseException

メソッド

void org.objectweb.cjdbc.common.jmx.mbeans.VirtualDatabaseMBean.backupBackendWithCheckpoint (  String  backendName,
String  checkpointName,
ArrayList  tables
)  throws VirtualDatabaseException
 

Create a back up of a specific backend Note the backend will be disabled during backup, and will be put back to its previous state after backup.

引数:
backendName to backup
checkpointName to associate this backup with
tables to copy or null if copy all
例外:
VirtualDatabaseException if fails

void org.objectweb.cjdbc.common.jmx.mbeans.VirtualDatabaseMBean.callBackupManager (  boolean  backup,
String  backendName,
String  checkpoint,
ArrayList  tables,
boolean  enableAfter,
BackupListener  listener
)  throws VirtualDatabaseException [package]
 

Call the backup manager on the given backend. Start a fire and forget thread for backup or recovery. The only two ways to get the results is to wait for jmx notifications, or the listener given as a parameter.

引数:
backup true if this is a backup, false if this is a restore process
backendName the name of the backend
checkpoint the name of the checkpoint associated with the process
tables the tables to consider while performing the copy
enableAfter should be enable the backend automatically after
listener callback object to notify of the end of the process
例外:
VirtualDatabaseException if fails

boolean org.objectweb.cjdbc.common.jmx.mbeans.VirtualDatabaseMBean.checkAdminAuthentication (  String  adminLogin,
String  adminPassword
)  throws VirtualDatabaseException [package]
 

Authenticate a user for a given virtual database

引数:
adminLogin username
adminPassword password
戻り値:
true if authentication is a success, false otherwise
例外:
VirtualDatabaseException if database does not exists

参照元 org.objectweb.cjdbc.console.text.module.VirtualDatabaseAdmin.login(), と org.objectweb.cjdbc.console.gui.CjdbcGui.publicActionLoadAuthenticatedDatabase().

void org.objectweb.cjdbc.common.jmx.mbeans.VirtualDatabaseMBean.disableAllBackend (   )  throws VirtualDatabaseException [package]
 

Disable all backends for this virtual database

例外:
VirtualDatabaseException if fails

参照元 org.objectweb.cjdbc.console.text.commands.dbadmin.DisableAll.parse().

void org.objectweb.cjdbc.common.jmx.mbeans.VirtualDatabaseMBean.disableAllBackendForCheckpoint (  String  checkpoint  )  throws VirtualDatabaseException [package]
 

Disable all backends and store a checkpoint

引数:
checkpoint the name of the checkpoitn
例外:
VirtualDatabaseException if fails

参照元 org.objectweb.cjdbc.console.text.commands.dbadmin.DisableAll.parse().

void org.objectweb.cjdbc.common.jmx.mbeans.VirtualDatabaseMBean.disableBackend (  String  databaseBackendName  )  throws VirtualDatabaseException [package]
 

Disables a backend that is currently enabled on this virtual database (without further check).

引数:
databaseBackendName The database backend logical name to enable
例外:
VirtualDatabaseException in case of communication-related error

参照元 org.objectweb.cjdbc.console.text.commands.dbadmin.Disable.parse(), と org.objectweb.cjdbc.console.gui.CjdbcGui.publicActionExecuteBackendDrop().

void org.objectweb.cjdbc.common.jmx.mbeans.VirtualDatabaseMBean.disableBackendForCheckpoint (  String  databaseBackendName,
String  checkpointName
)  throws VirtualDatabaseException [package]
 

Disables a backend once all the pending write queries are executed. A checkpoint is inserted in the recovery log. The backend must belong to this virtual database and be in the enabled state.

引数:
databaseBackendName The database backend logical name to disable
checkpointName the checkpoint name to store
例外:
VirtualDatabaseException in case of communication-related error

参照元 org.objectweb.cjdbc.console.text.commands.dbadmin.Disable.parse(), と org.objectweb.cjdbc.console.gui.CjdbcGui.publicActionExecuteBackendDrop().

void org.objectweb.cjdbc.common.jmx.mbeans.VirtualDatabaseMBean.enableAllBackend (  String  checkpoint  )  throws VirtualDatabaseException [package]
 

Prepare this virtual database for startup. This turns on all the backends

引数:
checkpoint the checkpoint for the recovery log
例外:
VirtualDatabaseException if fails

void org.objectweb.cjdbc.common.jmx.mbeans.VirtualDatabaseMBean.enableAllBackend (   )  throws VirtualDatabaseException [package]
 

Prepare this virtual database for startup. This turns on all the backends

例外:
VirtualDatabaseException if fails

参照元 org.objectweb.cjdbc.console.text.commands.dbadmin.EnableAll.parse().

void org.objectweb.cjdbc.common.jmx.mbeans.VirtualDatabaseMBean.enableAllBackendsFromRecovery (  String  checkpoint  )  throws VirtualDatabaseException [package]
 

This emulates the method enableAllBackend() except it tries to get previous backend states from the recovery log, and enable only the backends with a recorded state of enable.

引数:
checkpoint the checkpoint for the recovery log
例外:
VirtualDatabaseException if fails

void org.objectweb.cjdbc.common.jmx.mbeans.VirtualDatabaseMBean.enableBackend (  String  databaseBackendName  )  throws VirtualDatabaseException [package]
 

Enables a backend that has been previously added to this virtual database and that is in the disabled state. The backend is enabled without further check.

引数:
databaseBackendName The database backend logical name to enable
例外:
VirtualDatabaseException in case of communication-related error

参照元 org.objectweb.cjdbc.console.text.commands.dbadmin.Enable.parse(), と org.objectweb.cjdbc.console.gui.CjdbcGui.publicActionExecuteBackendDrop().

void org.objectweb.cjdbc.common.jmx.mbeans.VirtualDatabaseMBean.enableBackendFromCheckpoint (  String  databaseBackendName,
String  checkpointName
)  throws VirtualDatabaseException [package]
 

Plays all the queries since the given checkpoint and enables the backend when it is completely synchronized. The backend must have been previously added to this virtual database and be in the disabled state

引数:
databaseBackendName The database backend logical name to enable
checkpointName the checkpoint name to restart from
例外:
VirtualDatabaseException in case of communication-related error

参照元 org.objectweb.cjdbc.console.text.commands.dbadmin.Enable.parse(), と org.objectweb.cjdbc.console.gui.CjdbcGui.publicActionExecuteBackendDrop().

void org.objectweb.cjdbc.common.jmx.mbeans.VirtualDatabaseMBean.enableBackendFromLastCheckpoint (  String  backendName  )  throws VirtualDatabaseException [package]
 

Enable the given backend from its last known checkpoint

引数:
backendName the name of the backend to enable
例外:
VirtualDatabaseException if enable failed, or if there is no last known checkpoint

参照元 org.objectweb.cjdbc.console.text.commands.dbadmin.EnableWrite.parse().

String org.objectweb.cjdbc.common.jmx.mbeans.VirtualDatabaseMBean.getBackendInformation (  String  backendName  )  throws VirtualDatabaseException [package]
 

Return information about the specified backend.

引数:
backendName the backend logical name
戻り値:
String the backend information
例外:
VirtualDatabaseException if an error occurs

String org.objectweb.cjdbc.common.jmx.mbeans.VirtualDatabaseMBean.getBackendState (  String  backendName  )  throws VirtualDatabaseException [package]
 

Return the state of a given database backend

引数:
backendName the name of the backend
戻り値:
String description of the database backend
例外:
VirtualDatabaseException if fails

String org.objectweb.cjdbc.common.jmx.mbeans.VirtualDatabaseMBean.getName (   )  [package]
 

Gets the virtual database name to be used by the client (C-JDBC driver)

戻り値:
the virtual database name

boolean org.objectweb.cjdbc.common.jmx.mbeans.VirtualDatabaseMBean.hasRecoveryLog (   )  [package]
 

Indicate whether there is a recovery log defined for this virtual database

戻り値:
true if the recovery log is defined and can be accessed, false otherwise

参照元 org.objectweb.cjdbc.console.text.commands.dbadmin.EnableWrite.parse(), と org.objectweb.cjdbc.console.gui.CjdbcGui.publicActionLoadAuthenticatedDatabase().

boolean org.objectweb.cjdbc.common.jmx.mbeans.VirtualDatabaseMBean.isDistributed (   )  [package]
 

Tells whether this database is distributed or not

戻り値:
true if the database is distributed among multiple controllers false if it exists on a single controller only

参照元 org.objectweb.cjdbc.console.gui.CjdbcGui.publicActionLoadBackendsList().

void org.objectweb.cjdbc.common.jmx.mbeans.VirtualDatabaseMBean.removeBackend (  String  backend  )  throws VirtualDatabaseException [package]
 

Remove a backend from the virtual database list. Do not check whether it is enabled or not, and do not perform backup operation

引数:
backend the name of the backend to remove
例外:
VirtualDatabaseException if the backend does not exist

参照元 org.objectweb.cjdbc.console.gui.CjdbcGui.publicActionRemoveBackend().

void org.objectweb.cjdbc.common.jmx.mbeans.VirtualDatabaseMBean.removeCheckpoint (  String  checkpoint  )  throws VirtualDatabaseException [package]
 

Disable all backends and store a checkpoint

引数:
checkpoint the name of the checkpoitn
例外:
VirtualDatabaseException if fails

参照元 org.objectweb.cjdbc.console.text.commands.dbadmin.RemoveCheckpoint.parse().

void org.objectweb.cjdbc.common.jmx.mbeans.VirtualDatabaseMBean.replicateBackend (  String  backendName,
String  newBackendName,
Map  parameters
)  throws VirtualDatabaseException [package]
 

Add an additionnal backend to the virtual database with connection managers identical to the backend replicated.

引数:
backendName the backend to replicate and to use parameters from.
newBackendName the new backend name.
parameters parameters to override or modify when replicating to the new backend
例外:
VirtualDatabaseException if cannot replicate backend

参照元 org.objectweb.cjdbc.console.gui.CjdbcGui.publicActionCreateBackendExecute().

void org.objectweb.cjdbc.common.jmx.mbeans.VirtualDatabaseMBean.restoreBackendFromBackupCheckpoint (  String  databaseBackendName,
String  checkpointName
)  throws VirtualDatabaseException, BackupException, OctopusException [package]
 

Recopy all the data of a previous dump recorded by octopus into the named backend. This disables the backend and leave it disable after recovery process. The user has to call the enableBackendFromCheckpoint after this.

引数:
databaseBackendName the name of the backend to restore
checkpointName the name of the checkpoint that has a dump
例外:
VirtualDatabaseException if cannot access the backend from its name
OctopusException if backup failed while in octopus mode
BackupException if backup failed for other reasons

参照元 org.objectweb.cjdbc.console.text.commands.dbadmin.Restore.parse().

String [][] org.objectweb.cjdbc.common.jmx.mbeans.VirtualDatabaseMBean.retrieveBackendsData (   )  throws Exception [package]
 

Retrieves an array of data on the backends for this virtual database

戻り値:
String[][] of formatted data for all backends
例外:
Exception if fails

参照元 org.objectweb.cjdbc.console.text.commands.dbadmin.ShowBackends.parse().

void org.objectweb.cjdbc.common.jmx.mbeans.VirtualDatabaseMBean.setBackendLastKnownCheckpoint (  String  backendName,
String  checkpoint
)  throws VirtualDatabaseException [package]
 

Sets the last known checkpoint of a backend. This will also update the value in the recovery log

引数:
backendName backend
checkpoint checkpoint
例外:
VirtualDatabaseException if fails

void org.objectweb.cjdbc.common.jmx.mbeans.VirtualDatabaseMBean.shutdown (   )  throws VirtualDatabaseException [package]
 

Shutdown a virtual database in fast mode, disconnect clients

例外:
VirtualDatabaseException if fails

void org.objectweb.cjdbc.common.jmx.mbeans.VirtualDatabaseMBean.transferBackend (  String  backend,
String  controllerDestination
)  throws VirtualDatabaseException [package]
 

Transfer the backend to the destinated controller. Note that this does nothing in a non-distributed environment

引数:
backend the backend to transfer
controllerDestination the controller to copy the backend to
例外:
VirtualDatabaseException if transfer failed

参照元 org.objectweb.cjdbc.console.text.commands.dbadmin.TransferBackend.parse(), と org.objectweb.cjdbc.console.gui.CjdbcGui.publicActionExecuteTransfer().

ArrayList org.objectweb.cjdbc.common.jmx.mbeans.VirtualDatabaseMBean.viewAllBackendNames (   )  throws VirtualDatabaseException [package]
 

Get the name of all DatabaseBackend names.

戻り値:
ArrayList ArrayList of String representing database backend names
例外:
VirtualDatabaseException if an error occurs

参照元 org.objectweb.cjdbc.console.gui.CjdbcGui.publicActionLoadBackendsList().

String [] org.objectweb.cjdbc.common.jmx.mbeans.VirtualDatabaseMBean.viewBackendInformation (  String  backendName  )  throws VirtualDatabaseException [package]
 

Returns an array of information on this backend The method above is not used at the moment ... This one is by the GUI.

引数:
backendName the name of the backend
戻り値:
String[]
例外:
VirtualDatabaseException if an error occurs

参照元 org.objectweb.cjdbc.console.gui.CjdbcGui.actionSetBackendState().

ArrayList org.objectweb.cjdbc.common.jmx.mbeans.VirtualDatabaseMBean.viewCheckpointNames (   )  [package]
 

Returns an array of names of all the checkpoint available in the recovery log of this virtual dabase.

戻り値:
ArrayList of checkpoint names. Can be empty

参照元 org.objectweb.cjdbc.console.gui.CjdbcGui.actionDisplaySelectCheckpointFrame(), と org.objectweb.cjdbc.console.text.commands.dbadmin.ViewCheckpointNames.parse().

String [] org.objectweb.cjdbc.common.jmx.mbeans.VirtualDatabaseMBean.viewControllerList (   )  [package]
 

Return the list of controllers defining this virtual database. If the database is not distributed this returns the same as viewOwningController otherwise returns an array of controller configuring this DistributedVirtualDatabase

戻り値:
String[] of controller names.

参照元 org.objectweb.cjdbc.console.gui.CjdbcGui.publicActionLoadAuthenticatedDatabase(), と org.objectweb.cjdbc.console.gui.CjdbcGui.publicActionSelectNewDatabase().

Hashtable org.objectweb.cjdbc.common.jmx.mbeans.VirtualDatabaseMBean.viewGroupBackends (   )  throws VirtualDatabaseException [package]
 

Returns a mapping of controller jmx names with their backends Note the method is only useful in distributed environment

戻り値:
Hashtable of controllerName --> ArrayList of backend names
例外:
VirtualDatabaseException if cannot return the result

参照元 org.objectweb.cjdbc.console.gui.CjdbcGui.publicActionLoadBackendsList().

String org.objectweb.cjdbc.common.jmx.mbeans.VirtualDatabaseMBean.viewOwningController (   )  [package]
 

Name of the controller owning this virtual database

戻り値:
url of the controller

このインタフェースの説明は次のファイルから生成されました:
CJDBCversion1.0.4に対してTue Oct 12 15:16:10 2004に生成されました。 doxygen 1.3.8