org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean Interface Reference

List of all members.

Public Member Functions
void	addVirtualDatabases (String xml) throws ControllerException
ArrayList	getVirtualDatabaseNames ()
Package Functions
boolean	hasVirtualDatabase (String name)
String	removeVirtualDatabase (String virtualname) throws Exception
void	addDriver (byte[] bytes) throws Exception
String	generateLogReport () throws Exception
String	generateReport () throws Exception
String	loadXml (String filename) throws Exception
String	saveConfiguration () throws Exception
void	shutdown (int level) throws ControllerException
int	getBacklogSize ()
String	getControllerName ()
String	getJmxName ()
int	getPortNumber ()
String	getVersionNumber () throws RemoteException
String	getXml ()
boolean	isShuttingDown ()
void	setBacklogSize (int size)
void	refreshLogConfiguration () throws ControllerException
void	updateLogConfigurationFile (String newConfiguration) throws IOException, ControllerException
String	viewLogConfigurationFile () throws IOException

---

Detailed Description

JMX Interface of the C-JDBC Controller.

Author:

Emmanuel Cecchet

Mathieu Peltier

Version:

1.0

Definition at line 40 of file ControllerMBean.java.

---

Member Function Documentation

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

Adds a driver jar file sent in its binary form in the drivers directory of the controller. Parameters: bytes  the data in a byte array Exceptions: Exception  if fails

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

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. Parameters: xml  XML code to parse Exceptions: ControllerException  if an error occurs while interpreting XML Referenced by 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 Returns: the content of the logreport Exceptions: Exception  if fails Referenced by 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 Returns: the content of the report Exceptions: Exception  if fails Referenced by org.objectweb.cjdbc.console.gui.CjdbcGui.publicActionControllerReport().

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

Get the controller socket backlog size. Returns: the backlog size

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

Gets the controller name. Returns: a String value containing the controller name.

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

Gets the JMX name of the controller. Returns: a String value containing the jmx name of the controller

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

Return this controller port number Returns: a int containing the port code number

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

Gets the controller version. Returns: a String value containing the version number Exceptions: RemoteException  if an error occurs

ArrayList org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.getVirtualDatabaseNames (   )

Returns the names of currently available virtual databases. Returns: ArrayList of String objects. Referenced by org.objectweb.cjdbc.console.gui.CjdbcGui.publicActionShutdownController().

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

Return the xml version of the controller.xml file without doc type declaration, just data. The content is formatted using the controller xsl stylesheet. Returns: controller xml data Referenced by org.objectweb.cjdbc.console.gui.CjdbcGui.publicActionGetControllerInfo(), and org.objectweb.cjdbc.console.gui.CjdbcGui.publicActionLoadXmlController().

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

Tests if a VirtualDatabase of a given name exists in this controller. Parameters: name  the virtual database name Returns: true if the virtual database exists Referenced by org.objectweb.cjdbc.console.text.module.VirtualDatabaseAdmin.login().

boolean org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.isShuttingDown (   )  [package]

Is the controller shutting down ? Returns: true if the controller is no more accepting connection

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

Reads a XML configuration file. Parameters: filename  XML configuration file name Returns: a diagnostic message Exceptions: 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. Exceptions: ControllerException  if the log4j.properties file cannot be found in classpath

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

Prevent the controller from accessing a virtual database thereafter Parameters: virtualname  the virtual database name to remove Returns: description message Exceptions: 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. Returns: status message Exceptions: Exception  if fails

void org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.setBacklogSize (  int  size  )  [package]

Set the controller socket backlog size. Parameters: size  backlog size

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

Turns the controller down by using default shutdown level Parameters: level  Smart,Fast or Immediate. Exceptions: ControllerException  if unknown level or other error occurs. Referenced by org.objectweb.cjdbc.console.gui.CjdbcGui.publicActionShutdownController().

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 Parameters: newConfiguration  the content of the new log4j configuration Exceptions: IOException  if cannot access the log4j file ControllerException  if could not refresh the logs Referenced by org.objectweb.cjdbc.console.gui.CjdbcGui.publicActionUpdateControllerLogConfiguration().

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

Retrieve the content of the log4j configuration file Returns: String Exceptions: IOException  if IO problems Referenced by org.objectweb.cjdbc.console.gui.CjdbcGui.publicActionControllerLogConfiguration().

---

The documentation for this interface was generated from the following file:

• ControllerMBean.java

---