org.objectweb.cjdbc.controller.core.Controller Class Reference

Collaboration diagram for org.objectweb.cjdbc.controller.core.Controller:

[legend]List of all members.

Public Member Functions
	Controller (String ipAddress, int port, int backlog) throws NotCompliantMBeanException, JmxException
void	addVirtualDatabases (String xml, String vdbName, int autoEnable, String checkpoint) throws ControllerException
void	addVirtualDatabases (String xml) throws ControllerException
void	addVirtualDatabase (VirtualDatabase vdb) throws ControllerException
synchronized void	addVirtualDatabase (VirtualDatabase vdb, int autoLoad, String checkPoint) throws ControllerException
VirtualDatabase	getVirtualDatabase (String virtualDatabaseName)
ArrayList	getVirtualDatabaseNames ()
ArrayList	getVirtualDatabases ()
boolean	hasVirtualDatabase (String name)
String	removeVirtualDatabase (String virtualname) throws ControllerException
void	addDriver (byte[] bytes) throws Exception
String	loadXmlConfiguration (String filename, String virtualName, int autoLoad, String checkPoint) throws Exception
String	loadXml (String filename) throws Exception
String	saveConfiguration () throws VirtualDatabaseException
void	endOfController (Exception fatal)
ControllerServerThread	getConnectionThread ()
boolean	isShuttingDown ()
void	shutdown (int level) throws ControllerException
void	launch ()
String	getControllerName ()
String	getIPAddress ()
void	setIPAddress (String ipAddress)
int	getPortNumber ()
void	setPortNumber (int port)
int	getBacklogSize ()
void	setBacklogSize (int size)
boolean	getJmxEnable ()
String	getJmxName ()
void	setJmxEnable (boolean enable)
Hashtable	getConfiguration ()
boolean	isSecurityEnabled ()
ControllerSecurityManager	getSecurity ()
void	setSecurity (ControllerSecurityManager security)
String	generateReport () throws Exception
void	setConfiguration (Hashtable configuration)
String	getVersionNumber ()
String	getAssociatedString ()
String	getXml ()
String	getXmlController ()
String	getXmlVirtualDatabases ()
String	generateLogReport () throws Exception
void	refreshLogConfiguration () throws ControllerException
void	updateLogConfigurationFile (String newConfiguration) throws IOException, ControllerException
String	viewLogConfigurationFile () throws IOException
ReportManager	getReport ()
void	setReport (ReportManager report)
Static Public Member Functions
void	main (String args[]) throws Exception
String	getVersion ()
Static Package Attributes
Trace	logger

---

Detailed Description

The C-JDBC controller main class. It registers itself in the RMI registry and waits for C-JDBC driver requests.

Author:

Emmanuel Cecchet

Mathieu Peltier

Nicolas Modrzyk

Duncan Smith

Version:

1.0

Definition at line 87 of file Controller.java.

---

Constructor & Destructor Documentation

org.objectweb.cjdbc.controller.core.Controller.Controller (  String  ipAddress, int  port, int  backlog )  throws NotCompliantMBeanException, JmxException

Creates a new Controller instance. Parameters: ipAddress  bind the controller to this ipAddress port  bind the controller to listen to this port backlog  backlog connection size Exceptions: NotCompliantMBeanException  in case the bean does not comply with jmx JmxException  the bean could not be registered Definition at line 137 of file Controller.java. { super(ControllerMBean.class); virtualDatabases = new Hashtable(); this.ipAddress = ipAddress; this.portNumber = port; this.backlogSize = backlog; ObjectName name = JmxConstants.getControllerObjectName(); MBeanServerManager.registerMBean(this, name); }

---

Member Function Documentation

void org.objectweb.cjdbc.controller.core.Controller.addDriver (  byte[]  bytes  )  throws Exception

See also: org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.addDriver(byte[]) Definition at line 392 of file Controller.java. References org.objectweb.cjdbc.controller.core.Controller.logger. { // Try to find drivers directory in the classpath File driversDirectory = null; URL url = Controller.class .getResource(ControllerConstants.C_JDBC_DRIVER_JAR_FILE); boolean error = false; if (url != null) { driversDirectory = (new File(URLDecoder.decode(url.getFile()))) .getParentFile(); error = (driversDirectory == null) || !driversDirectory.exists(); } if (error) { String msg = Translate.get("controller.driver.dir.not.found"); logger.error(msg); throw new ControllerException(msg); } // Read the array of bytes to a file File temp = null; try { temp = File.createTempFile("driver", "zip", driversDirectory); FileOutputStream output = new FileOutputStream(temp); output.write(bytes); output.close(); } catch (IOException e) { String msg = Translate.get("controller.add.jar.read.failed", e); logger.error(msg); throw new ControllerException(msg); } // Unzip the file content try { Enumeration entries; ZipFile zipFile = new ZipFile(temp); // Read the file int lenght; InputStream in; BufferedOutputStream out; byte[] buffer = new byte[1024]; entries = zipFile.entries(); while (entries.hasMoreElements()) { ZipEntry entry = (ZipEntry) entries.nextElement(); if (entry.isDirectory()) { // Create the directory if (logger.isDebugEnabled()) logger.debug(Translate.get("controller.add.jar.extract.dir", entry .getName())); (new File(driversDirectory, entry.getName())).mkdir(); continue; } // Extract the file if (logger.isDebugEnabled()) logger.debug(Translate.get("controller.add.jar.extract.file", entry .getName())); in = zipFile.getInputStream(entry); out = new BufferedOutputStream(new FileOutputStream(driversDirectory + System.getProperty("file.separator") + entry.getName())); while ((lenght = in.read(buffer)) >= 0) out.write(buffer, 0, lenght); in.close(); out.close(); } zipFile.close(); temp.delete(); logger.info(Translate.get("controller.add.jar.to.directory", driversDirectory.toString())); } catch (IOException e) { String msg = Translate.get("controller.driver.extract.failed", e); logger.error(msg); throw new ControllerException(msg); } }

synchronized void org.objectweb.cjdbc.controller.core.Controller.addVirtualDatabase (  VirtualDatabase  vdb, int  autoLoad, String  checkPoint )  throws ControllerException

Add the virtual database with the specified options Parameters: vdb  the VirtualDatabase object to add autoLoad  specified if backends should be enabled checkPoint  specified the checkPoint to recover from, leave null if no recovery speficied Exceptions: ControllerException  if database already exists on the specified Controller object Definition at line 227 of file Controller.java. References org.objectweb.cjdbc.controller.xml.DatabasesParser.error(), org.objectweb.cjdbc.controller.core.Controller.hasVirtualDatabase(), and org.objectweb.cjdbc.controller.core.Controller.logger. { // Add the database or retrieve it if it already exists if (hasVirtualDatabase(vdb.getDatabaseName())) { String msg = Translate.get("controller.database.already.exists", vdb .getDatabaseName()); logger.warn(msg); throw new ControllerException(msg); } else { virtualDatabases.put(vdb.getDatabaseName(), vdb); // Send notification if (MBeanServerManager.isJmxEnabled()) { Hashtable databases = new Hashtable(); try { databases.put("backends", vdb.getAllBackendNames()); } catch (VirtualDatabaseException e) { // ignore } RmiConnector.broadcastNotification(this, CjdbcNotificationList.CONTROLLER_VIRTUALDATABASE_ADDED, CjdbcNotificationList.NOTIFICATION_LEVEL_INFO, Translate.get( "notification.virtualdatabase.added", vdb .getVirtualDatabaseName()), databases); } } // Enable backends with the proper states try { if (logger.isDebugEnabled()) logger.debug(Translate.get("controller.database.autoenable", autoLoad)); switch (autoLoad) { case ControllerConstants.AUTO_ENABLE_TRUE : vdb.enableAllBackendsFromCheckpoint(); break; case ControllerConstants.AUTO_ENABLE_FALSE : break; case ControllerConstants.AUTO_ENABLE_FORCE : logger.warn("Backends enabled in force mode from checkpoint " + checkPoint); vdb.forceEnableAllBackendsFromCheckpoint(checkPoint); break; default : logger .error("Unsupported autoEnabledBackends mode in controller configuration"); break; } } catch (VirtualDatabaseException e) { throw new ControllerException(e); } logger.info(Translate.get("controller.add.virtualdatabase", vdb .getDatabaseName())); }

void org.objectweb.cjdbc.controller.core.Controller.addVirtualDatabase (  VirtualDatabase  vdb  )  throws ControllerException

Registers a new VirtualDatabase in this controller. Parameters: vdb  the VirtualDatabase to register Exceptions: ControllerException  if an error occurs Definition at line 210 of file Controller.java. { this.addVirtualDatabase(vdb, ControllerConstants.AUTO_ENABLE_BACKEND, ControllerConstants.DATABASE_DEFAULT_CHECKPOINT); }

void org.objectweb.cjdbc.controller.core.Controller.addVirtualDatabases (  String  xml  )  throws ControllerException

Register a VirtualDatabase with default options See also: org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.addVirtualDatabases(String) Definition at line 193 of file Controller.java. References org.objectweb.cjdbc.controller.core.Controller.logger. { if (logger.isDebugEnabled()) { logger.debug(Translate.get("controller.loading.virtualdatabase")); } this.addVirtualDatabases(xml, null, ControllerConstants.AUTO_ENABLE_BACKEND, ControllerConstants.DATABASE_DEFAULT_CHECKPOINT); }

void org.objectweb.cjdbc.controller.core.Controller.addVirtualDatabases (  String  xml, String  vdbName, int  autoEnable, String  checkpoint )  throws ControllerException

Adds virtual databases contained in the XML document given as a String. If a virtual database name is provided, only this database is loaded with the provided autoLoad and checkpoint information. Parameters: xml  XML configuration file content vdbName  optional virtual database name to autoload autoEnable  autoenable backend mode for virtual database checkpoint  checkpoint name if autoEnable is set to force Exceptions: ControllerException  if an error occurs Definition at line 164 of file Controller.java. References org.objectweb.cjdbc.controller.core.Controller.logger, and org.objectweb.cjdbc.controller.xml.DatabasesParser.readXML(). Referenced by org.objectweb.cjdbc.controller.core.Controller.loadXmlConfiguration(). { if (logger.isDebugEnabled()) logger.debug(Translate.get("controller.add.virtualdatabase", vdbName)); if (vdbName != null && this.hasVirtualDatabase(vdbName)) { throw new ControllerException(Translate .get("controller.add.virtualdatabase.already.used")); } try { DatabasesParser parser = new DatabasesParser(this, vdbName, autoEnable, checkpoint); parser.readXML(xml, true); } catch (Exception e) { String msg = Translate.get("controller.add.virtualdatabase.failed", e); logger.warn(msg, e); throw new ControllerException(msg); } }

void org.objectweb.cjdbc.controller.core.Controller.endOfController (  Exception  fatal  )

Create report about fatal error Parameters: fatal  the cause of the fatal error Definition at line 597 of file Controller.java. References org.objectweb.cjdbc.controller.core.ReportManager.getReportLocation(), org.objectweb.cjdbc.controller.core.ReportManager.isGenerateOnFatal(), and org.objectweb.cjdbc.controller.core.Controller.logger. Referenced by org.objectweb.cjdbc.controller.core.ControllerServerThread.ControllerServerThread(). { logger.fatal(Translate.get("fatal.error")); if (report.isGenerateOnFatal()) { new ReportManager(this, fatal).generate(); logger.info(Translate.get("fatal.report.generated", report .getReportLocation() + File.separator + ControllerConstants.REPORT_FILE)); } Runtime.getRuntime().exit(1); }

String org.objectweb.cjdbc.controller.core.Controller.generateLogReport (   )  throws Exception

See also: org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.generateLogReport() Definition at line 1040 of file Controller.java. References org.objectweb.cjdbc.controller.core.ReportManager.generateJustLogs(). { ReportManager report = new ReportManager(this, true); return report.generateJustLogs(); }

String org.objectweb.cjdbc.controller.core.Controller.generateReport (   )  throws Exception

See also: org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.generateReport() Definition at line 905 of file Controller.java. References org.objectweb.cjdbc.controller.core.ReportManager.generate(), and org.objectweb.cjdbc.controller.core.ReportManager.startReport(). { report.startReport(); return report.generate(); }

String org.objectweb.cjdbc.controller.core.Controller.getAssociatedString (   )

See also: org.objectweb.cjdbc.controller.jmx.AbstractStandardMBean.getAssociatedString() Definition at line 932 of file Controller.java. { return "controller"; }

int org.objectweb.cjdbc.controller.core.Controller.getBacklogSize (   )

See also: org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.getBacklogSize() Definition at line 806 of file Controller.java. Referenced by org.objectweb.cjdbc.controller.core.ControllerServerThread.ControllerServerThread(). { return backlogSize; }

Hashtable org.objectweb.cjdbc.controller.core.Controller.getConfiguration (   )

Get current configuration options Returns: configure a Hashtable with controller options Definition at line 871 of file Controller.java. Referenced by org.objectweb.cjdbc.controller.core.ReportManager.writeControllerSettings(). { return configuration; }

ControllerServerThread org.objectweb.cjdbc.controller.core.Controller.getConnectionThread (   )

Access the connection thread. Need this for shutting down Returns: connectionThread Definition at line 615 of file Controller.java. Referenced by org.objectweb.cjdbc.controller.core.shutdown.ControllerShutdownThread.shutdownServerConnectionThread(). { return connectionThread; }

String org.objectweb.cjdbc.controller.core.Controller.getControllerName (   )

Returns the controller name. Returns: String Definition at line 758 of file Controller.java. Referenced by org.objectweb.cjdbc.controller.virtualdatabase.DistributedVirtualDatabase.getControllerName(), org.objectweb.cjdbc.controller.core.Controller.getJmxName(), org.objectweb.cjdbc.controller.virtualdatabase.DistributedVirtualDatabase.handleMessageMultiThreaded(), and org.objectweb.cjdbc.controller.core.Controller.launch(). { return ipAddress + ":" + portNumber; }

String org.objectweb.cjdbc.controller.core.Controller.getIPAddress (   )

Get the IP address to bind the controller to Returns: the IP address Definition at line 768 of file Controller.java. Referenced by org.objectweb.cjdbc.controller.core.ControllerServerThread.ControllerServerThread(), and org.objectweb.cjdbc.controller.core.ControllerFactory.setUpJmx(). { return ipAddress; }

boolean org.objectweb.cjdbc.controller.core.Controller.getJmxEnable (   )

Returns jmx enable Returns: jmxEnabled Definition at line 824 of file Controller.java. Referenced by org.objectweb.cjdbc.controller.core.Controller.getJmxName(), org.objectweb.cjdbc.controller.core.Controller.getXmlController(), and org.objectweb.cjdbc.controller.core.shutdown.ControllerShutdownThread.shutdownJmxAgent(). { return MBeanServerManager.isJmxEnabled(); }

String org.objectweb.cjdbc.controller.core.Controller.getJmxName (   )

Return the jmx name of this controller (hostname:rmiport) Returns: jmx name Definition at line 834 of file Controller.java. References org.objectweb.cjdbc.controller.core.Controller.getControllerName(), org.objectweb.cjdbc.controller.jmx.RmiConnector.getHostName(), org.objectweb.cjdbc.controller.core.Controller.getJmxEnable(), and org.objectweb.cjdbc.controller.jmx.RmiConnector.getPort(). Referenced by org.objectweb.cjdbc.controller.virtualdatabase.DistributedVirtualDatabase.handleMessageMultiThreaded(), and org.objectweb.cjdbc.controller.virtualdatabase.DistributedVirtualDatabase.joinGroup(). { if (getJmxEnable()) { RmiConnector connector = ((RmiConnector) RmiConnector.getRmiConnectors() .get(0)); return connector.getHostName() + ":" + connector.getPort(); } else return getControllerName(); }

int org.objectweb.cjdbc.controller.core.Controller.getPortNumber (   )

Get the controller port number Returns: the port number Definition at line 788 of file Controller.java. Referenced by org.objectweb.cjdbc.controller.core.ControllerServerThread.ControllerServerThread(). { return portNumber; }

ReportManager org.objectweb.cjdbc.controller.core.Controller.getReport (   )

Returns the report value. Returns: Returns the report. Definition at line 1105 of file Controller.java. Referenced by org.objectweb.cjdbc.controller.core.shutdown.ControllerShutdownThread.generateReportIfNeeded(). { return report; }

ControllerSecurityManager org.objectweb.cjdbc.controller.core.Controller.getSecurity (   )

Returns: Returns the security. Definition at line 889 of file Controller.java. Referenced by org.objectweb.cjdbc.controller.core.ControllerServerThread.ControllerServerThread(), and org.objectweb.cjdbc.controller.core.Controller.getXmlController(). { return security; }

String org.objectweb.cjdbc.controller.core.Controller.getVersion (   )  [static]

Returns Version as a long String Returns: version Definition at line 861 of file Controller.java. Referenced by org.objectweb.cjdbc.controller.core.Controller.main(). { return Translate.get("controller.info", Constants.VERSION); }

String org.objectweb.cjdbc.controller.core.Controller.getVersionNumber (   )

See also: org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.getVersionNumber() Definition at line 924 of file Controller.java. { return Constants.VERSION; }

VirtualDatabase org.objectweb.cjdbc.controller.core.Controller.getVirtualDatabase (  String  virtualDatabaseName  )

Gets the VirtualDatabase object corresponding to a virtual database name. Parameters: virtualDatabaseName  the virtual database name Returns: a VirtualDatabase object or null if not found Definition at line 302 of file Controller.java. Referenced by org.objectweb.cjdbc.controller.core.ControllerWorkerThread.run(). { return (VirtualDatabase) virtualDatabases.get(virtualDatabaseName); }

ArrayList org.objectweb.cjdbc.controller.core.Controller.getVirtualDatabaseNames (   )

See also: org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.getVirtualDatabaseNames() Definition at line 310 of file Controller.java. { ArrayList result = new ArrayList(); for (Iterator iter = virtualDatabases.values().iterator(); iter.hasNext();) result.add(((VirtualDatabase) iter.next()).getVirtualDatabaseName()); return result; }

ArrayList org.objectweb.cjdbc.controller.core.Controller.getVirtualDatabases (   )

Returns information about the available virtual databases. Returns: ArrayList of information about virtual databases. Definition at line 323 of file Controller.java. Referenced by org.objectweb.cjdbc.controller.core.shutdown.ControllerShutdownThread.shutdownDatabases(). { ArrayList result = new ArrayList(); for (Iterator iter = virtualDatabases.values().iterator(); iter.hasNext();) result.add(iter.next()); return result; }

String org.objectweb.cjdbc.controller.core.Controller.getXml (   )

See also: org.objectweb.cjdbc.common.xml.XmlComponent.getXml() Definition at line 940 of file Controller.java. References org.objectweb.cjdbc.controller.core.Controller.getXmlController(), and org.objectweb.cjdbc.controller.core.Controller.logger. Referenced by org.objectweb.cjdbc.controller.core.Controller.getXmlController(), and org.objectweb.cjdbc.controller.core.ReportManager.writeControllerInfo(). { try { return XmlTools.prettyXml(getXmlController()); } catch (Exception e) { logger.error(Translate.get("controller.xml.transformation.failed", e)); return e.getMessage(); } }

String org.objectweb.cjdbc.controller.core.Controller.getXmlController (   )

Return the xml version of the controller.xml file without doc type declaration, just data. Returns: controller xml data Definition at line 959 of file Controller.java. References org.objectweb.cjdbc.controller.core.Controller.getJmxEnable(), org.objectweb.cjdbc.controller.core.ReportManager.getReportLocation(), org.objectweb.cjdbc.controller.core.Controller.getSecurity(), org.objectweb.cjdbc.controller.core.Controller.getXml(), org.objectweb.cjdbc.controller.core.ReportManager.isEnableFileLogging(), org.objectweb.cjdbc.controller.core.ReportManager.isGenerateOnFatal(), org.objectweb.cjdbc.controller.core.ReportManager.isGenerateOnShutdown(), org.objectweb.cjdbc.controller.core.ReportManager.isHideSensitiveData(), and org.objectweb.cjdbc.controller.core.ReportManager.isReportEnabled(). Referenced by org.objectweb.cjdbc.controller.core.Controller.getXml(). { StringBuffer info = new StringBuffer(); info.append("<C-JDBC-CONTROLLER>"); info.append("<" + ControllerXmlTags.ELT_CONTROLLER + " " + ControllerXmlTags.ATT_CONTROLLER_IP + "=\"" + this.getIPAddress() + "\" " + ControllerXmlTags.ATT_CONTROLLER_PORT + "=\"" + this.getPortNumber() + "\" " + ">"); info.append("<" + ControllerXmlTags.ELT_INTERNATIONALIZATION + " " + ControllerXmlTags.ATT_LANGUAGE + "=\"" + Locale.getDefault().getLanguage() + "\"/>"); if (report.isReportEnabled()) { info.append("<" + ControllerXmlTags.ELT_REPORT + " " + ControllerXmlTags.ATT_REPORT_ENABLE_FILE_LOGGING + "=\"" + report.isEnableFileLogging() + "\" " + ControllerXmlTags.ATT_REPORT_HIDE_SENSITIVE_DATA + "=\"" + report.isHideSensitiveData() + "\" " + ControllerXmlTags.ATT_REPORT_GENERATE_ON_FATAL + "=\"" + report.isGenerateOnFatal() + "\" " + ControllerXmlTags.ATT_REPORT_GENERATE_ON_SHUTDOWN + "=\"" + report.isGenerateOnShutdown() + "\" " + ControllerXmlTags.ATT_REPORT_REPORT_LOCATION + "=\"" + report.getReportLocation() + "\" />"); } if (getJmxEnable()) { info.append("<" + ControllerXmlTags.ELT_JMX + ">"); if (configuration.containsKey(JmxConstants.ADAPTOR_TYPE_HTTP)) { info.append("<" + ControllerXmlTags.ELT_HTTP_JMX_ADAPTOR + " " + ControllerXmlTags.ATT_JMX_ADAPTOR_PORT + "=\"" + configuration.get(JmxConstants.ADAPTOR_TYPE_HTTP) + "\" />"); } if (configuration.containsKey(JmxConstants.ADAPTOR_TYPE_RMI)) { info.append("<" + ControllerXmlTags.ELT_RMI_JMX_ADAPTOR + " " + ControllerXmlTags.ATT_JMX_ADAPTOR_PORT + "=\"" + configuration.get(JmxConstants.ADAPTOR_TYPE_RMI) + "\" />"); } info.append("</" + ControllerXmlTags.ELT_JMX + ">"); } if (this.isSecurityEnabled()) info.append(this.getSecurity().getXml()); info.append("</" + ControllerXmlTags.ELT_CONTROLLER + ">"); info.append("</C-JDBC-CONTROLLER>"); return info.toString(); }

String org.objectweb.cjdbc.controller.core.Controller.getXmlVirtualDatabases (   )

Same as above but for the virtual databases. Returns: xml virtual databases data. Definition at line 1018 of file Controller.java. References org.objectweb.cjdbc.controller.core.Controller.logger. Referenced by org.objectweb.cjdbc.controller.core.Controller.saveConfiguration(), and org.objectweb.cjdbc.controller.core.ReportManager.writeControllerInfo(). { try { StringBuffer info = new StringBuffer(); info.append("<C-JDBC>"); ArrayList virtualDatabases = this.getVirtualDatabases(); for (int i = 0, size = virtualDatabases.size(); i < size; i++) info.append(((VirtualDatabase) virtualDatabases.get(i)).getXml()); info.append("</C-JDBC>"); return info.toString(); } catch (Exception e) { logger.error(e.getMessage(), e); return e.getMessage(); } }

boolean org.objectweb.cjdbc.controller.core.Controller.hasVirtualDatabase (  String  name  )

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 Definition at line 338 of file Controller.java. Referenced by org.objectweb.cjdbc.controller.core.Controller.addVirtualDatabase(), and org.objectweb.cjdbc.controller.core.Controller.removeVirtualDatabase(). { return virtualDatabases.containsKey(name); }

boolean org.objectweb.cjdbc.controller.core.Controller.isSecurityEnabled (   )

Check whether security is enabled or not Returns: true if there is not null controller security manager Definition at line 881 of file Controller.java. Referenced by org.objectweb.cjdbc.controller.core.ControllerServerThread.ControllerServerThread(), and org.objectweb.cjdbc.controller.core.Controller.shutdown(). { return security != null; }

boolean org.objectweb.cjdbc.controller.core.Controller.isShuttingDown (   )

See also: org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.isShuttingDown() Definition at line 623 of file Controller.java. Referenced by org.objectweb.cjdbc.controller.core.Controller.shutdown(). { return isShuttingDown; }

void org.objectweb.cjdbc.controller.core.Controller.launch (   )

Actively launch the controller. Add startup actions here to avoid them in <method>main </method> Definition at line 736 of file Controller.java. References org.objectweb.cjdbc.controller.core.Controller.getControllerName(), and org.objectweb.cjdbc.controller.core.Controller.logger. Referenced by org.objectweb.cjdbc.controller.core.Controller.main(). { connectionThread = new ControllerServerThread(this); connectionThread.start(); SimpleDateFormat formatter = new SimpleDateFormat( "yyyy.MM.dd ww 'at' hh:mm:ss a zzz"); Date day = new Date(); String date = formatter.format(day); logger.info(Translate.get("controller.date", date)); logger.info(Translate.get("controller.ready", getControllerName())); }

String org.objectweb.cjdbc.controller.core.Controller.loadXml (  String  filename  )  throws Exception

Read a XML configuration file for a set of virtual databases Parameters: filename  XML configuration file name Returns: a diagnostic message (success or error) Exceptions: Exception  if an error occurs Definition at line 551 of file Controller.java. { return this.loadXmlConfiguration(filename, null, ControllerConstants.AUTO_ENABLE_BACKEND, ControllerConstants.DATABASE_DEFAULT_CHECKPOINT); }

String org.objectweb.cjdbc.controller.core.Controller.loadXmlConfiguration (  String  filename, String  virtualName, int  autoLoad, String  checkPoint )  throws Exception

Read a XML configuration file and load only the VirtualDatabase specified in the arguments list Parameters: filename  XML configuration file name to take info on VirtualDatabase virtualName  the only database to load, null if should load all autoLoad  specifies if the backends should be enabled automatically after loading checkPoint  checkPoint to recover from when enabling backends. Leave null if no recovery option is needed. Returns: a diagnostic message (success or error) Exceptions: Exception  if an error occurs Definition at line 499 of file Controller.java. References org.objectweb.cjdbc.controller.core.Controller.addVirtualDatabases(), and org.objectweb.cjdbc.controller.core.Controller.logger. { FileReader fileReader = null; try { filename = filename.trim(); try { fileReader = new FileReader(filename); } catch (FileNotFoundException fnf) { return Translate.get("controller.file.not.found", filename); } // Read the file BufferedReader in = new BufferedReader(fileReader); StringBuffer xml = new StringBuffer(); String line; do { line = in.readLine(); if (line != null) xml.append(line); } while (line != null); // Send it to the controller addVirtualDatabases(xml.toString(), virtualName, autoLoad, checkPoint); return Translate.get("controller.file.send", filename); } catch (Exception e) { logger.error(Translate.get("controller.loadXml.failed", e), e); throw new ControllerException(Translate.get("controller.loadXml.failed", e)); } finally { if (fileReader != null) fileReader.close(); } }

void org.objectweb.cjdbc.controller.core.Controller.main (  String  args[]  )  throws Exception [static]

Launches the C-JDBC controller and bind it with RMI registry. The available options are: -h or --help <port>: displays usage informations. -j or --jmx <port>: optinal JMX server HTTP adaptor port number. -n or --name <name>: optional controller name. -i or --ip <ip>: optional IP address to beind the controller to. -r or --rmi <port>: optional RMI registry port number. -v or --version: displays version informations. The controller starts listening for socket connections on the default port. Jmx is configured, and a virtual database can be added. org.objectweb.cjdbc.controller.core.ControllerConstants#DEFAULT_PORT Default Listening port Parameters: args  command line arguments (see above) Exceptions: Exception  when everything goes wrong Definition at line 717 of file Controller.java. References org.objectweb.cjdbc.controller.core.ControllerFactory.getController(), org.objectweb.cjdbc.controller.core.Controller.getVersion(), org.objectweb.cjdbc.controller.core.Controller.launch(), and org.objectweb.cjdbc.controller.core.Controller.logger. { logger.info(getVersion()); System.setProperty("javax.management.builder.initial", org.objectweb.cjdbc.controller.jmx.MBeanServerBuilder.class.getName()); ControllerFactory conf = new ControllerFactory(args); Controller controller = conf.getController(); if (controller != null) controller.launch(); else throw new Exception(Translate.get("controller.configure.failed")); }

void org.objectweb.cjdbc.controller.core.Controller.refreshLogConfiguration (   )  throws ControllerException

See also: org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.refreshLogConfiguration() Definition at line 1053 of file Controller.java. References org.objectweb.cjdbc.controller.core.Controller.logger. Referenced by org.objectweb.cjdbc.controller.core.Controller.updateLogConfigurationFile(). { try { LogManager.configure(URLDecoder.decode(this.getClass().getResource( ControllerConstants.LOG4J_RESOURCE).getFile())); if (logger.isDebugEnabled()) logger.info(Translate.get("controller.refresh.log.success")); } catch (Exception e) { throw new ControllerException(Translate .get("controller.logconfigfile.not.found")); } }

String org.objectweb.cjdbc.controller.core.Controller.removeVirtualDatabase (  String  virtualname  )  throws ControllerException

See also: org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.removeVirtualDatabase(String) Definition at line 346 of file Controller.java. References org.objectweb.cjdbc.controller.virtualdatabase.VirtualDatabase.disableAllBackends(), org.objectweb.cjdbc.controller.virtualdatabase.VirtualDatabase.getAllBackendNames(), org.objectweb.cjdbc.controller.virtualdatabase.VirtualDatabase.getVirtualDatabaseName(), and org.objectweb.cjdbc.controller.core.Controller.hasVirtualDatabase(). { if (hasVirtualDatabase(virtualname)) { VirtualDatabase vdb = (VirtualDatabase) virtualDatabases.get(virtualname); try { vdb.disableAllBackends(); } catch (VirtualDatabaseException e) { throw new ControllerException(e); } this.virtualDatabases.remove(virtualname); // Send notification if (MBeanServerManager.isJmxEnabled()) { Hashtable databases = new Hashtable(); try { databases.put("backends", vdb.getAllBackendNames()); } catch (VirtualDatabaseException e) { // ignore } RmiConnector.broadcastNotification(this, CjdbcNotificationList.CONTROLLER_VIRTUALDATABASE_REMOVED, CjdbcNotificationList.NOTIFICATION_LEVEL_INFO, Translate.get( "notification.virtualdatabase.removed", vdb .getVirtualDatabaseName()), databases); } } return Translate.get("controller.removeVirtualDatabase.success", virtualname); }

String org.objectweb.cjdbc.controller.core.Controller.saveConfiguration (   )  throws VirtualDatabaseException

Save current configuration of the controller to a default file Returns: Status message Exceptions: VirtualDatabaseException  if an error occurs See also: org.objectweb.cjdbc.controller.core.ControllerConstants.getSaveFile Definition at line 565 of file Controller.java. References org.objectweb.cjdbc.controller.core.Controller.getXmlVirtualDatabases(), and org.objectweb.cjdbc.controller.core.Controller.logger. { String msg = Translate.get("controller.save.configuration"); try { String configurationFile = ControllerConstants .getSaveFile(new SimpleDateFormat("EEE, MMM d, yy") .format(new Date())); DataOutputStream dos = new DataOutputStream(new BufferedOutputStream( new FileOutputStream(configurationFile))); StringBuffer xml = new StringBuffer(); xml.append(XmlTools.prettyXml(getXmlVirtualDatabases().toString())); dos.write(xml.toString().getBytes()); dos.close(); } catch (Exception e) { msg = Translate.get("controller.save.configuration.failed", e); logger.error(msg); } return msg; }

void org.objectweb.cjdbc.controller.core.Controller.setBacklogSize (  int  size  )

See also: org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.setBacklogSize(int) Definition at line 814 of file Controller.java. { backlogSize = size; }

void org.objectweb.cjdbc.controller.core.Controller.setConfiguration (  Hashtable  configuration  )

Sets the configuration value. Parameters: configuration  The configuration to set. Definition at line 916 of file Controller.java. { this.configuration = configuration; }

void org.objectweb.cjdbc.controller.core.Controller.setIPAddress (  String  ipAddress  )

Set the IP address to bind the controller to Parameters: ipAddress  the IP address to use Definition at line 778 of file Controller.java. { this.ipAddress = ipAddress; }

void org.objectweb.cjdbc.controller.core.Controller.setJmxEnable (  boolean  enable  )

set enable JMX Parameters: enable  true if jmx should be enable. Definition at line 851 of file Controller.java. { configuration.put(ControllerFactory.JMX_ENABLE, "" + enable); }

void org.objectweb.cjdbc.controller.core.Controller.setPortNumber (  int  port  )

Set the controller backlog size. Parameters: port  the port number to set Definition at line 798 of file Controller.java. { portNumber = port; }

void org.objectweb.cjdbc.controller.core.Controller.setReport (  ReportManager  report  )

Sets the report value. Parameters: report  The report to set. Definition at line 1115 of file Controller.java. { this.report = report; }

void org.objectweb.cjdbc.controller.core.Controller.setSecurity (  ControllerSecurityManager  security  )

Parameters: security  The security to set. Definition at line 897 of file Controller.java. { this.security = security; }

void org.objectweb.cjdbc.controller.core.Controller.shutdown (  int  level  )  throws ControllerException

See also: org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.shutdown(int) Definition at line 631 of file Controller.java. References org.objectweb.cjdbc.controller.core.shutdown.ShutdownThread.getShutdownGroup(), org.objectweb.cjdbc.controller.core.Controller.isSecurityEnabled(), org.objectweb.cjdbc.controller.core.Controller.isShuttingDown(), and org.objectweb.cjdbc.controller.core.Controller.logger. { ControllerShutdownThread shutdownThread = null; synchronized (this) { if (isShuttingDown()) { logger.info(Translate.get("controller.already.shutting.down", this .getControllerName())); return; } if (isSecurityEnabled() && !security.getAllowConsoleShutdown()) throw new ControllerException(Translate .get("controller.shutdown.refused")); switch (level) { case Constants.SHUTDOWN_WAIT : shutdownThread = new ControllerWaitShutdownThread(this); logger.info(Translate.get("controller.shutdown.type.wait", this .getControllerName())); break; case Constants.SHUTDOWN_SAFE : isShuttingDown = true; shutdownThread = new ControllerSafeShutdownThread(this); logger.info(Translate.get("controller.shutdown.type.safe", this .getControllerName())); break; case Constants.SHUTDOWN_FORCE : isShuttingDown = true; shutdownThread = new ControllerForceShutdownThread(this); logger.warn(Translate.get("controller.shutdown.type.force", this .getControllerName())); break; default : String msg = Translate .get("controller.shutdown.unknown.level", level); logger.error(msg); throw new RuntimeException(msg); } } Thread thread = new Thread(shutdownThread.getShutdownGroup(), shutdownThread, "Controller Shutdown Thread"); thread.start(); try { logger.info("Waiting for shutdown"); thread.join(); logger.info("Shutdown over"); } catch (InterruptedException e) { e.printStackTrace(); } }

void org.objectweb.cjdbc.controller.core.Controller.updateLogConfigurationFile (  String  newConfiguration  )  throws IOException, ControllerException

See also: org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.updateLogConfigurationFile(java.lang.String) Definition at line 1072 of file Controller.java. References org.objectweb.cjdbc.controller.core.Controller.refreshLogConfiguration(), and org.objectweb.cjdbc.controller.core.ReportManager.write(). { File logFile = new File(URLDecoder.decode(getClass().getResource( ControllerConstants.LOG4J_RESOURCE).getFile())); BufferedWriter writer = new BufferedWriter(new FileWriter(logFile)); writer.write(newConfiguration); writer.flush(); writer.close(); refreshLogConfiguration(); }

String org.objectweb.cjdbc.controller.core.Controller.viewLogConfigurationFile (   )  throws IOException

See also: org.objectweb.cjdbc.common.jmx.mbeans.ControllerMBean.viewLogConfigurationFile() Definition at line 1087 of file Controller.java. { File logFile = new File(URLDecoder.decode(getClass().getResource( ControllerConstants.LOG4J_RESOURCE).getFile())); BufferedReader reader = new BufferedReader(new FileReader(logFile)); StringBuffer buffer = new StringBuffer(); String line; while ((line = reader.readLine()) != null) buffer.append(line + System.getProperty("line.separator")); reader.close(); return buffer.toString(); }

---

Member Data Documentation

Trace org.objectweb.cjdbc.controller.core.Controller.logger [static, package]

Initial value: Trace .getLogger("org.objectweb.cjdbc.controller.core.Controller") Logger instance. Definition at line 108 of file Controller.java. Referenced by org.objectweb.cjdbc.controller.core.Controller.addDriver(), org.objectweb.cjdbc.controller.core.Controller.addVirtualDatabase(), org.objectweb.cjdbc.controller.core.Controller.addVirtualDatabases(), org.objectweb.cjdbc.controller.core.Controller.endOfController(), org.objectweb.cjdbc.controller.core.Controller.getXml(), org.objectweb.cjdbc.controller.core.Controller.getXmlVirtualDatabases(), org.objectweb.cjdbc.controller.core.Controller.launch(), org.objectweb.cjdbc.controller.core.Controller.loadXmlConfiguration(), org.objectweb.cjdbc.controller.core.Controller.main(), org.objectweb.cjdbc.controller.core.Controller.refreshLogConfiguration(), org.objectweb.cjdbc.controller.core.Controller.saveConfiguration(), and org.objectweb.cjdbc.controller.core.Controller.shutdown().

---

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

• Controller.java

---