org.codehaus.cargo.container.property

Class DataSource

java.lang.Object

org.codehaus.cargo.container.property.DataSource

public class DataSource
extends Object

A Datasource is a representation of a JDBC datasource. If supported by the container, this property is used to setup a datasource.

Version:

$Id: DataSource.java 1057 2006-06-17 13:06:20Z vmassol $

Constructor Summary

Constructors

Constructor and Description
DataSource(Properties properties) Contruct a DataSource from a list of properties.
DataSource(String datasourceInformation) Contruct a DataSource from a single String.
DataSource(String jndiLocation, String dataSourceType, String driverClass, String url, String username, String password) Contruct a DataSource object.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDataSourceType() The type of the data source (typically javax.sql.XADataSource or javax.sql.DataSource).
String	getDriverClass() The class name of the JDBC driver.
String	getJndiLocation() The JNDI location that this datasource should be bound do (in the config file).
String	getPassword() The password to use when connecting to the database.
String	getStringRepresentation() Get a string representation of this datasource.
String	getUrl() The url to connect to the database.
String	getUsername() The username to use when connecting to the database.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DataSource

public DataSource(String jndiLocation,
          String dataSourceType,
          String driverClass,
          String url,
          String username,
          String password)

Contruct a DataSource object.

Parameters:

jndiLocation - (typically java:comp/env)

dataSourceType - (typically javax.sql.XADataSource or javax.sql.DataSource)

driverClass - The class name of the JDBC driver. Example: org.hsqldb.jdbcDriver

url - The url to connect to the database. Example: jdbc:hsqldb:database/jiradb

username - The username to use when connecting to the database.

password - The password to use when connecting to the database.

DataSource

public DataSource(String datasourceInformation)

Contruct a DataSource from a single String.

Parameters:

datasourceInformation - A string, really a list of properties, representing a datasource

See Also:

PropertyUtils.getDataSourceProperties(String)

DataSource

public DataSource(Properties properties)

Contruct a DataSource from a list of properties.

Parameters:

properties - A list of properties representing this datasource

See Also:

PropertyUtils.getDataSourceProperties(String)

Method Detail

getStringRepresentation

public String getStringRepresentation()

Get a string representation of this datasource.

Returns:

a string representation

See Also:

PropertyUtils.getDataSourceString(java.util.Properties)

getJndiLocation

public String getJndiLocation()

The JNDI location that this datasource should be bound do (in the config file). Note that many application servers may prepend a context (typically java:comp/env) to this context.

Returns:

the JDNI location

getDataSourceType

public String getDataSourceType()

The type of the data source (typically javax.sql.XADataSource or javax.sql.DataSource).

Returns:

the datasource type.

getDriverClass

public String getDriverClass()

The class name of the JDBC driver. Example: org.hsqldb.jdbcDriver.

Returns:

the class name of the JDBC driver

getUrl

public String getUrl()

The url to connect to the database. Example: jdbc:hsqldb:database/jiradb.

Returns:

the url to connect to the database

getUsername

public String getUsername()

The username to use when connecting to the database.

Returns:

the username (eg 'sa')

getPassword

public String getPassword()

The password to use when connecting to the database.

Returns:

the password to use to connect to the database

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()