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

すべてのメンバ一覧

---

説明

JMX Interface of the C-JDBC Controller.

作者:

Emmanuel Cecchet

Mathieu Peltier

バージョン:

1.0

ControllerMBean.java の 41 行で定義されています。

Public メソッド
String	getName ()
関数
String	getJmxName ()
int	getPortNumber ()
boolean	hasVirtualDatabase (String name)
String	getVersionNumber () throws RemoteException
ArrayList	listVirtualDatabases () throws Exception
ArrayList	listBackends (String virtualDbName) throws Exception
ArrayList	listDatabaseClients (String virtualDbName) throws Exception
boolean	isCacheEnableForDatabase (String virtualDbNAme) throws Exception
void	addVirtualDatabases (String xml) throws ControllerException
void	addVirtualDatabases (String xml, String virtualName, int autoEnable, String checkPoint) throws ControllerException
void	refreshLogConfiguration () throws ControllerException
String	loadXML (String filename) throws Exception
String	loadXmlConfiguration (String filename, String virtualName, int autoEnable, String checkPoint) throws Exception
void	shutdown (int level) throws ControllerException
String	addDriver (String filename) throws Exception
void	addDriver (byte[] bytes) throws Exception
String	removeVirtualDatabase (String virtualname) throws Exception
String	viewInfo () throws Exception
String	viewConfiguration () throws Exception
String	viewDatabases () throws Exception
String	saveConfiguration () throws Exception
String	viewDatabasesXml () throws Exception
String	viewDatabaseXml (String databaseName) throws Exception
String	generateReport () throws Exception
String	generateLogReport () throws Exception
void	shutdownDatabase (String databaseName, int level) throws ControllerException
File[]	listAvailableDumpFiles ()
boolean	removeDumpFile (File dumpFile)
String	viewLogConfigurationFile () throws IOException
void	updateLogConfigurationFile (String newConfiguration) throws IOException, ControllerException
boolean	isDistributedVirtualDatabase (String databaseName)

---

メソッド

void org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.addDriver (  byte[]  bytes  )  throws Exception [package]

Reads a driver binary data 引数: bytes  the data in a byte array 例外: Exception  if fails

String org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.addDriver (  String  filename  )  throws Exception [package]

Reads a driver JAR file. 引数: filename  name of the file 戻り値: a diagnostic message 例外: Exception  if an error occurs

void org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.addVirtualDatabases (  String  xml, String  virtualName, int  autoEnable, String  checkPoint )  throws ControllerException [package]

Registers one or several virtual databases in the controller. The description of each Virtual Database must contain the definition of the backends and components (cache, scheduler, load balancer) to use. This function expects the content of an XML file conforming to the C-JDBC DTD to be given as a single String object. 引数: xml  XML code to parse virtualName  name of the virtual database autoEnable  specify if should be enabled as soon as it is added checkPoint  the checkpoint to use to enable the database 例外: ControllerException  if an error occurs while interpreting XML

void org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.addVirtualDatabases (  String  xml  )  throws ControllerException [package]

Registers one or several virtual databases in the controller. The description of each Virtual Database must contain the definition of the backends and components (cache, scheduler, load balancer) to use. This function expects the content of an XML file conforming to the C-JDBC DTD to be given as a single String object. 引数: xml  XML code to parse 例外: ControllerException  if an error occurs while interpreting XML 参照元 org.objectweb.cjdbc.console.gui.CjdbcGui.publicActionExecuteControllerDrop().

String org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.generateLogReport (   )  throws Exception [package]

Generate a log report on the controller now 戻り値: the content of the logreport 例外: Exception  if fails 参照元 org.objectweb.cjdbc.console.gui.CjdbcGui.publicActionRefreshLogs().

String org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.generateReport (   )  throws Exception [package]

Generate a report on the controller now 戻り値: the content of the report 例外: Exception  if fails 参照元 org.objectweb.cjdbc.console.gui.CjdbcGui.publicActionControllerReport().

String org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.getJmxName (   )  [package]

Gets the jmx name of the controller. 戻り値: a String value containing the jmx name of the controller 参照元 org.objectweb.cjdbc.console.gui.CjdbcGui.actionLoadController().

String org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.getName (   )

Gets the controller name. 戻り値: a String value containing the controller name.

int org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.getPortNumber (   )  [package]

Return this controller port number 戻り値: a int containing the port code number

String org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.getVersionNumber (   )  throws RemoteException [package]

Gets the controller version. 戻り値: a String value containing the version number 例外: RemoteException  if an error occurs

boolean org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.hasVirtualDatabase (  String  name  )  [package]

Tests if a VirtualDatabase of a given name exists in this controller. 引数: name  the virtual database name 戻り値: true if the virtual database exists 参照元 org.objectweb.cjdbc.console.text.module.VirtualDatabaseAdmin.login().

boolean org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.isCacheEnableForDatabase (  String  virtualDbNAme  )  throws Exception [package]

Tell whether the database has some cache enabled 引数: virtualDbNAme  name of the VirtualDatabase 戻り値: true if cache is enabled 例外: Exception  if database does not exists

boolean org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.isDistributedVirtualDatabase (  String  databaseName  )  [package]

参照: org.objectweb.cjdbc.common.jmx.mbeans.VirtualDatabaseMBean.isDistributed() 参照元 org.objectweb.cjdbc.console.gui.CjdbcGui.actionLoadDatabase().

File [] org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.listAvailableDumpFiles (   )  [package]

List all the available dump files on this controller 戻り値: an array of File denoting the available files. Cannot be null but can be empty. 参照元 org.objectweb.cjdbc.console.gui.CjdbcGui.publicActionLoadDumpList().

ArrayList org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.listBackends (  String  virtualDbName  )  throws Exception [package]

Returns the list of backends for a given database name 引数: virtualDbName  name of the virtual database 戻り値: ArrayList of String of the names of the backends 例外: Exception  if fails to access the backends

ArrayList org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.listDatabaseClients (  String  virtualDbName  )  throws Exception [package]

Get the VirtualDatabaseWorkerThread clients of the given database 引数: virtualDbName  the name of the virtual database 戻り値: ArrayList of 例外: Exception  if fails

ArrayList org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.listVirtualDatabases (   )  throws Exception [package]

Gets the name of the available virtual databases. 戻り値: ArrayList containing information 例外: Exception  if an error occurs 参照元 org.objectweb.cjdbc.console.gui.CjdbcGui.actionLoadDatabaseList().

String org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.loadXML (  String  filename  )  throws Exception [package]

Reads a XML configuration file. 引数: filename  XML configuration file name 戻り値: a diagnostic message 例外: Exception  if an error occurs

String org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.loadXmlConfiguration (  String  filename, String  virtualName, int  autoEnable, String  checkPoint )  throws Exception [package]

Reads an xml configuration file and search information to load the specified database 引数: filename  the path to the xml file virtualName  the virtual database we want to load autoEnable  Specifiy whether the backends should be enabled checkPoint  Recover from specified checkpoint if needed 戻り値: a diagnostic message 例外: Exception  if an error occurs

void org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.refreshLogConfiguration (   )  throws ControllerException [package]

Refreshs the logging system configuration by re-reading the log4j.properties file. 例外: ControllerException  if the log4j.properties file cannot be found in classpath

boolean org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.removeDumpFile (  File  dumpFile  )  [package]

Delete a dump file from the controller repository 引数: dumpFile  the file reference of the dumpFile 戻り値: true deletion was completed, false otherwise 参照元 org.objectweb.cjdbc.console.gui.CjdbcGui.publicActionDeleteDump().

String org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.removeVirtualDatabase (  String  virtualname  )  throws Exception [package]

Prevent the controller from accessing a virtual database thereafter 引数: virtualname  the virtual database name to remove 戻り値: description message 例外: Exception  if fails

String org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.saveConfiguration (   )  throws Exception [package]

Save current configuration of the controller to a default file location. 戻り値: status message 例外: Exception  if fails

void org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.shutdown (  int  level  )  throws ControllerException [package]

Turns the controller down by using default shutdown level 引数: level  Smart,Fast or Immediate. 例外: ControllerException  if unknown level or other error occurs. 参照元 org.objectweb.cjdbc.console.gui.CjdbcGui.publicActionShutdownController().

void org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.shutdownDatabase (  String  databaseName, int  level )  throws ControllerException [package]

Shutdown a database in the given mode. This shuts down the backends and make backups depending on the shutdown level 引数: databaseName  the database to shut down level  the level of shutdown define in ControllerConstants 例外: ControllerException  if fails 参照元 org.objectweb.cjdbc.console.gui.CjdbcGui.publicActionShutdownDatabase().

void org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.updateLogConfigurationFile (  String  newConfiguration  )  throws IOException, ControllerException [package]

Update the log4j configuration file with the given content Also call refreshLogConfiguration method 引数: newConfiguration  the content of the new log4j configuration 例外: IOException  if cannot access the log4j file ControllerException  if could not refresh the logs 参照元 org.objectweb.cjdbc.console.gui.CjdbcGui.publicActionUpdateControllerLogConfiguration().

String org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.viewConfiguration (   )  throws Exception [package]

Retrieve the configuration about this controller in text format. 戻り値: the complete xml formatted description of this controller 例外: Exception  if fails

String org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.viewDatabases (   )  throws Exception [package]

Make a separation between the configuration of the controller and the virtual databases 戻り値: databases info in text format 例外: Exception  if fails

String org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.viewDatabasesXml (   )  throws Exception [package]

View xml configuration of the databases without transformation 戻り値: xml formatted text 例外: Exception  if an error occurs

String org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.viewDatabaseXml (  String  databaseName  )  throws Exception [package]

View the xml configuration of the given database 引数: databaseName  name of the database 戻り値: xml formatted text 例外: Exception  if fails 参照元 org.objectweb.cjdbc.console.gui.CjdbcGui.publicActionLoadXmlDatabase().

String org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.viewInfo (   )  throws Exception [package]

Retrieve the information about this controller in xml format. 戻り値: the complete xml formatted description of this controller 例外: Exception  if fails 参照元 org.objectweb.cjdbc.console.gui.CjdbcGui.publicActionGetControllerInfo(), と org.objectweb.cjdbc.console.gui.CjdbcGui.publicActionLoadXmlController().

String org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.viewLogConfigurationFile (   )  throws IOException [package]

Retrieve the content of the log4j configuration file 戻り値: String 例外: IOException  if IO problems 参照元 org.objectweb.cjdbc.console.gui.CjdbcGui.publicActionControllerLogConfiguration().

---

このインタフェースの説明は次のファイルから生成されました:

• src/org/objectweb/cjdbc/common/jmx/mbeans/ControllerMBean.java

---