com.ergotech.vib.historical

Class DatabaseConnectionManager

java.lang.Object

com.ergotech.vib.servers.DataSource

com.ergotech.vib.servers.SimpleDataSource

com.ergotech.vib.historical.DatabaseConnectionManager

Direct Known Subclasses:

HSQLDBConnectionManager, MySQLConnectionManager, SQLiteConnectionManager

public class DatabaseConnectionManager
extends SimpleDataSource

This component maintains a database connection. It is intended that it can be placed on a screen so that it can be configured and also modified at runtime, also that an editor can be used when the object is a constant.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DatabaseConnectionManager.DatabaseConnectionManagerWrapper This class provides sufficient information to discover or create a DatabaseConnectionManager.

Nested classes/interfaces inherited from class com.ergotech.vib.servers.SimpleDataSource

SimpleDataSource.NameEditorData

Nested classes/interfaces inherited from class com.ergotech.vib.servers.DataSource

DataSource.Writable

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Vector<DatabaseConnectionManager>	databaseConnectionManagers We maintain a list of all instances of DatabaseConnectionManagers which can be readily accessed when creating a list for the editor.

Fields inherited from class com.ergotech.vib.servers.SimpleDataSource

customTimer, EXPORT_READ_ONLY, EXPORT_READ_WRITE, NO_EXPORT, requiresSyncWrite, sharedTimer, syncWriteTimeout, timebase

Fields inherited from class com.ergotech.vib.servers.DataSource

autoSuspend, AUTOSUSPEND_DEFAULT, AUTOSUSPEND_NEVER, AUTOSUSPEND_NO_LISTENERS, AUTOSUSPEND_NO_LISTENERS_AND_NO_SOURCES, colorHi, colorHiHi, colorLo, colorLoLo, colorNormal, connectors, consoleLogger, currentColor, currentValue, debugLevel, DEFAULT_AUTOSUSPEND, dontConnect, gwtLog, hardSuspended, popupLogger, PRIMARYOUTPORTNAME, sendColors, stopped, suspended, timedPopupLogger, traceLogger, valueHi, valueHiHi, valueLo, valueLoLo

Constructor Summary

Constructors

Constructor and Description
DatabaseConnectionManager() The constructor stores the values for the connection.

Method Summary

Modifier and Type	Method and Description
boolean	checkForValidEntries() this checks for null or empty strings in the key elements needed to try a SQL connection
void	closeConnection(ConnectionClosedListener source) Close the database connection.
void	destroy() Overridden to remove the instance from the databaseConnectionManagers Vector.
int	getAsyncConnectionTimeout()
java.sql.Connection	getConnection(ConnectionClosedListener source) This method returns a connection object for the provided parameters.
static java.util.Vector<DatabaseConnectionManager>	getDatabaseConnectionManagers()
java.lang.String	getDriverClassName()
java.lang.String	getPassword()
java.lang.String	getUrl()
java.lang.String	getUrlInternal() This returns the url string after any occurrence of "applethost" has been replaced with the real host information.
java.lang.String	getUsername()
boolean	isAsyncConnect()
void	removeListener(ConnectionClosedListener listener) This removes a listener.
void	setAsyncConnect(boolean asyncConnect)
void	setAsyncConnectionTimeout(int asyncConnectionTimeout)
void	setDriverClassName(java.lang.String driverClassName)
void	setName(java.lang.String name) Adds the component to the list of connection managers and calls the superclass method to set the name.
void	setPassword(java.lang.String password)
void	setUrl(java.lang.String url) Sets the hostname of the Database.
void	setUsername(java.lang.String username)
void	VIBEvent(VIBEvent vibEvent) Resets "applethost".

Methods inherited from class com.ergotech.vib.servers.SimpleDataSource

addConnector, addConnector, addDataSource, addPropertyChangeListener, addValueChangedListener, addVetoableChangeListener, authenticatedClientRequest, clientRequest, clientResponse, determineSuspendedStatus, getClassLicenseManager, getContainer, getCustomTimer, getDataSource, getDataSources, getDisplayName, getExportCriteria, getExposeComponentConnections, getName, getOutPortNames, getPullFromServers, getPushData, getPushName, getPushToServers, getServerListData, getTimebase, getTrace, isActive, isScreenLocal, refreshCurrentValue, removeConnector, removeDataSource, removePropertyChangeListener, removeValueChangedListener, removeVetoableChangeListener, requestSyncWrite, setAutoSuspend, setClassLicenseManager, setContainer, setCustomTimer, setDataSourceName, setExportCriteria, setExposeComponentConnections, setPullFromServers, setPushData, setPushName, setPushToServers, setScreenLocal, setServerListData, setTimebase, setTrace, setValueObject, start, stop, tick, toString

Methods inherited from class com.ergotech.vib.servers.DataSource

addVIBEventListener, checkScript, executeInScriptInternal, executeScript, executeScriptInternal, executeScriptInternal, getAutoSuspend, getBooleanValue, getBoolValue, getColorHi, getColorHiHi, getColorLo, getColorLoLo, getColorNormal, getConnectors, getConsoleLogger, getCurrentColor, getDataSourceName, getDoubleValue, getFloatValue, getGWTLogger, getIncomingValueObject, getInScript, getIntValue, getLongValue, getParent, getPopupLogger, getScript, getScriptEngine, getSendColors, getSources, getStringValue, getSyncWriteTimeout, getTimedPopupLogger, getTraceLogger, getValueHi, getValueHiHi, getValueLo, getValueLoLo, getValueObject, init, isHardSuspended, isRunning, isSendOnlyChangedValuesDefault, isSuspended, logException, logGWT, logGWT, logMessage, logTrace, n2sortConnectors, performScriptSubstitutions, popupMessage, post, removeConnector, removeVIBEventListener, replaceConnectors, scriptExtensionSubstition, setColorHi, setColorHiHi, setColorLo, setColorLoLo, setColorNormal, setConsoleLogger, setGWTLogger, setHardSuspended, setInScript, setParent, setPopupLogger, setScript, setSendColors, setSendOnlyChangedValuesDefault, setSyncWriteTimeout, setTimedPopupLogger, setTraceLogger, setValueHi, setValueHiHi, setValueLo, setValueLoLo, updateColor, updateListeners, updateListeners, updateListeners, whoAmI

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

databaseConnectionManagers

public static java.util.Vector<DatabaseConnectionManager> databaseConnectionManagers

We maintain a list of all instances of DatabaseConnectionManagers which can be readily accessed when creating a list for the editor.

Constructor Detail

DatabaseConnectionManager

public DatabaseConnectionManager()

The constructor stores the values for the connection.

Method Detail

checkForValidEntries

public boolean checkForValidEntries()

this checks for null or empty strings in the key elements needed to try a SQL connection

closeConnection

public void closeConnection(ConnectionClosedListener source)

Close the database connection. This will also notify all listeners that the connection has been closed. This can be called by any component that detects a failure of the database connection and so provides a way for all users to reconnect.

destroy

public void destroy()
             throws BadParameterException

Overridden to remove the instance from the databaseConnectionManagers Vector.

Overrides:

destroy in class SimpleDataSource

Throws:

BadParameterException

See Also:

DataSource.destroy()

getAsyncConnectionTimeout

public int getAsyncConnectionTimeout()

Returns:

the asyncConnectionTimeout

getConnection

public java.sql.Connection getConnection(ConnectionClosedListener source)
                                  throws java.sql.SQLException

This method returns a connection object for the provided parameters. This method will call the DriverManager to create a connection is one is not currently in the pool.

Parameters:

ConnectionClosedListener - the bean which will listen for the connection to close.

Throws:

if - an exception occurs.

java.sql.SQLException

getDatabaseConnectionManagers

public static java.util.Vector<DatabaseConnectionManager> getDatabaseConnectionManagers()

Returns:

getDriverClassName

public java.lang.String getDriverClassName()

Returns:

Returns the driverClassName.

getPassword

public java.lang.String getPassword()

Returns:

Returns the password.

getUrl

public java.lang.String getUrl()

Returns:

Returns the url.

getUrlInternal

public java.lang.String getUrlInternal()

This returns the url string after any occurrence of "applethost" has been replaced with the real host information.

getUsername

public java.lang.String getUsername()

Returns:

Returns the username.

isAsyncConnect

public boolean isAsyncConnect()

Returns:

Returns the asyncConnect.

removeListener

public void removeListener(ConnectionClosedListener listener)

This removes a listener. If this is the last listener, then the connection will be closed.

Parameters:

listener - the listener to remove

setAsyncConnect

public void setAsyncConnect(boolean asyncConnect)

Parameters:

asyncConnect - The asyncConnect to set.

setAsyncConnectionTimeout

public void setAsyncConnectionTimeout(int asyncConnectionTimeout)

Parameters:

asyncConnectionTimeout - the asyncConnectionTimeout to set

setDriverClassName

public void setDriverClassName(java.lang.String driverClassName)

Parameters:

driverClassName - The driverClassName to set.

setName

public void setName(java.lang.String name)
             throws BadParameterException

Adds the component to the list of connection managers and calls the superclass method to set the name. If the name is null or an empty string then the component will be removed from the list of available connections.

Overrides:

setName in class SimpleDataSource

Throws:

BadParameterException

See Also:

SimpleDataSource.setName(java.lang.String)

setPassword

public void setPassword(java.lang.String password)

Parameters:

password - The password to set.

setUrl

public void setUrl(java.lang.String url)

Sets the hostname of the Database.

Parameters:

newValue - The new value.

setUsername

public void setUsername(java.lang.String username)

Parameters:

username - The username to set.

VIBEvent

public void VIBEvent(VIBEvent vibEvent)
              throws BadParameterException

Resets "applethost".

Overrides:

VIBEvent in class SimpleDataSource

Throws:

BadParameterException

See Also:

com.ergotech.vib.servers.SimpleDataSource#VIBEvent(com.ergotech.vib.utils.VIBEvent)