net.sf.btb

Class ConnectionManager

java.lang.Object

net.sf.btb.ConnectionManager

public class ConnectionManager
extends Object

Manages database URLs contained in the database.properties file. It's possible to define more than one database URL in the file or to load connection attributes from another file.

• database.url=connection string Defines the default connection string. The attribute is required for the connection manager to work properly.
• database.url.{name}=connection string It's possible to define as many connection strings as you want provided that you specify a different name for each.
• database.default={name} If you want another connection string to be used by default, specify it's name with this attribute. Note that the database.url. part is omitted.

You can change the path of the database.properties file by setting the system property attribute "databases.properties.path" to the desired file path.

Author:

Jean-Philippe Gravel

Constructor Summary

Constructors

Constructor and Description
ConnectionManager()

Method Summary

Methods

Modifier and Type	Method and Description
Connection	createConnection() Creates a connection using the default connection string.
Connection	createConnection(String name) Creates a connection using the specified connection name.
String	getDefault() Gets the default database.url name.
String	getFilePath() Get the file path to the actual database property file.
String	getUrl() Gets the default database URL (the database.url.
String	getUrl(String name) Get the specified connection string.
boolean	isSplit()
boolean	isSplit(String name)
void	loadAttributes() Loads the default attribute file as defined by the system property "databases.properties.path".
void	loadAttributes(String filePath) Load the specified attribute file.
void	saveAttributes() Saves the default attribute file as defined by ConnectionManager.FILE_PATH.
void	saveAttributes(String filePath) Saves the changes to the attribute file specified.
void	setDefault(String name) Sets the default database url name.
void	setSplit(boolean value)
void	setSplit(String name, boolean value)
void	setUrl(String url) Sets the default database URL.
void	setUrl(String name, String url) Sets the url value to the database.url.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConnectionManager

public ConnectionManager()

Method Detail

loadAttributes

public void loadAttributes()
                    throws IOException

Loads the default attribute file as defined by the system property "databases.properties.path". If not defined, uses the default value "databases.xml";

Throws:

IOException - if the file does not exist.

loadAttributes

public void loadAttributes(String filePath)
                    throws IOException

Load the specified attribute file. Can read both XML and former attribute files. Note that a XML file must have the extension ".xml" or ".properties" to be recognized.

Parameters:

filePath - Path to the file to load.

Throws:

IOException - if the file does not exist.

saveAttributes

public void saveAttributes()
                    throws IOException

Saves the default attribute file as defined by ConnectionManager.FILE_PATH.

Throws:

IOException - if there is a problem during the save operation.

saveAttributes

public void saveAttributes(String filePath)
                    throws IOException

Saves the changes to the attribute file specified. Note that a XML file must have the extension ".xml" or ".properties" to be recognized.

Parameters:

filePath - The path to the file to be saved.

Throws:

IOException - if there is a problem during the save operation.

createConnection

public Connection createConnection()
                            throws SQLException

Creates a connection using the default connection string.

Returns:

a new connection.

Throws:

SQLException - if there is a problem connecting to the database or if the connection string is invalid.

createConnection

public Connection createConnection(String name)
                            throws SQLException

Creates a connection using the specified connection name.

Parameters:

name - The name of the connection to create.

Returns:

a new connection.

Throws:

SQLException - if there is a problem connecting to the database or if the connection string is invalid.

getFilePath

public String getFilePath()

Get the file path to the actual database property file.

Returns:

the file path to the actual database property file.

getUrl

public String getUrl(String name)

Get the specified connection string.

Parameters:

name - The name of the connection string to get.

Returns:

a String containing the connection information, including the protocol.

setUrl

public void setUrl(String name,
          String url)

Sets the url value to the database.url.{name} attribute.

Parameters:

name - The name of the connection.url to set.

url - the url value.

getUrl

public String getUrl()

Gets the default database URL (the database.url.{name} value).

Returns:

a String containing the database URL.

setUrl

public void setUrl(String url)

Sets the default database URL.

Parameters:

url - The url to set to the default database.url attribute.

isSplit

public boolean isSplit()

setSplit

public void setSplit(boolean value)

isSplit

public boolean isSplit(String name)

setSplit

public void setSplit(String name,
            boolean value)

getDefault

public String getDefault()

Gets the default database.url name.

Returns:

the database.url name.

setDefault

public void setDefault(String name)

Sets the default database url name.

Parameters:

name - The name of the default database.url to use.