AbstractDBDataSource (XDEV Application Framework 6.0.0 API)

java.lang.Object
- xdev.util.AbstractDataSource<T>
- - xdev.db.AbstractDBDataSource<T>

All Implemented Interfaces:

DBDataSource<T>, DataSource<T>

Direct Known Subclasses:

JDBCDataSource, NullDBDataSource, ServletDBDataSource
```
public abstract class AbstractDBDataSource<T extends DBDataSource<T>>
extends AbstractDataSource<T>
implements DBDataSource<T>
```
Abstract base class for all DBDataSources including the handling of common DataSource.Parameters and DBDataSourceListeners.

Author:

XDEV Software

See Also:

DBDataSource, AbstractDataSource

Nested Class Summary
- Nested classes/interfaces inherited from interface xdev.util.DataSource
  DataSource.Parameter<T>

Field Summary

Fields
Modifier and Type	Field and Description
`static DataSource.Parameter<String>`	`AUTH_KEY`
`static DataSource.Parameter<String>`	`CATALOG`
`static DataSource.Parameter<Integer>`	`CONNECTION_POOL_SIZE`
`static DataSource.Parameter<Boolean>`	`EMBEDDED`
`static DataSource.Parameter<String>`	`HOST`
`static DataSource.Parameter<Boolean>`	`IS_SERVER_DATASOURCE`
`static DataSource.Parameter<Boolean>`	`KEEP_CONNECTIONS_ALIVE`
`protected List<DBDataSourceListener>`	`listeners`
`static DataSource.Parameter<Password>`	`PASSWORD`
`static DataSource.Parameter<Integer>`	`PORT`
`static DataSource.Parameter<String>`	`SCHEMA`
`static DataSource.Parameter<String>`	`SERVER_URL`
`static DataSource.Parameter<String>`	`URL_EXTENSION`
`static DataSource.Parameter<String>`	`USERNAME`
`static DataSource.Parameter<Boolean>`	`VERBOSE`

Fields inherited from class xdev.util.AbstractDataSource
connConfig, params

Constructor Summary

Constructors
Constructor and Description

AbstractDBDataSource()

Constructors
Constructor and Description
`AbstractDBDataSource()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDBDataSourceListener(DBDataSourceListener l)` Registers a `DBDataSourceListener` at this data source.
`String`	`getAuthKey()` Returns the authentification key of this `AbstractDBDataSource`.
`String`	`getCatalog()` Returns the catalog of this `AbstractDBDataSource`.
`int`	`getConnectionPoolSize()` Returns the connection pool size of this `AbstractDBDataSource`.
`DBDataSourceListener[]`	`getDBDataSourceListeners()` Retrieves all registered `DBDataSourceListener`s.
`String`	`getHost()` Returns the host of this `AbstractDBDataSource`.
`Password`	`getPassword()` Returns the password of this `AbstractDBDataSource`.
`int`	`getPort()` Returns the port of this `AbstractDBDataSource`.
`String`	`getSchema()` Returns the schema of this `AbstractDBDataSource`.
`String`	`getServerURL()` Returns the password of this `AbstractDBDataSource`.
`String`	`getUrlExtension()`
`String`	`getUserName()` Returns the user name of this `AbstractDBDataSource`.
`boolean`	`isEmbedded()` Returns the value of the `EMBEDDED` parameter.
`boolean`	`isParameterRequired(DataSource.Parameter p)`
`boolean`	`isServerDataSource()` Determines if this data source is a distibuted client-server data source.
`boolean`	`keepConnectionsAlive()` Returns `true` if the connection of this `AbstractDataSource` is alive.
`DBConnection`	`openConnection()` Open the connection for this `DBDataSource`.
`protected abstract DBConnection`	`openConnectionImpl()`
`void`	`removeDBDataSourceListener(DBDataSourceListener l)` Unregisters a `DBDataSourceListener`.
`void`	`setAuthKey(String authKey)` Sets the key which is used to authentificate this client to communicate with the servlet-part of this data source.
`void`	`setUrlExtension(String urlExtension)`

Methods inherited from class xdev.util.AbstractDataSource
getDefaultParameter, getName, getParameter, getParameter, getParameters, getParameterValue, getParameterValue, init, init, putParameter, putParameter, putParameterValue, putParameterValue, rankParams, setName

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface xdev.db.DBDataSource
canExport, closeAllOpenConnections, getMetaData

Methods inherited from interface xdev.util.DataSource
clearCaches, getDefaultParameter, getDefaultParameters, getName, getParameter, getParameters, getParameterValue, getParameterValue, putParameter

- Field Detail
  - EMBEDDED
```
public static final DataSource.Parameter<Boolean> EMBEDDED
```
    Since:
    
    3.1
  - HOST
```
public static final DataSource.Parameter<String> HOST
```
  - PORT
```
public static final DataSource.Parameter<Integer> PORT
```
  - USERNAME
```
public static final DataSource.Parameter<String> USERNAME
```
  - PASSWORD
```
public static final DataSource.Parameter<Password> PASSWORD
```
  - CATALOG
```
public static final DataSource.Parameter<String> CATALOG
```
  - SCHEMA
```
public static final DataSource.Parameter<String> SCHEMA
```
  - URL_EXTENSION
```
public static final DataSource.Parameter<String> URL_EXTENSION
```
    Since:
    
    4.0
  - CONNECTION_POOL_SIZE
```
public static final DataSource.Parameter<Integer> CONNECTION_POOL_SIZE
```
  - KEEP_CONNECTIONS_ALIVE
```
public static final DataSource.Parameter<Boolean> KEEP_CONNECTIONS_ALIVE
```
  - IS_SERVER_DATASOURCE
```
public static final DataSource.Parameter<Boolean> IS_SERVER_DATASOURCE
```
  - SERVER_URL
```
public static final DataSource.Parameter<String> SERVER_URL
```
  - AUTH_KEY
```
public static final DataSource.Parameter<String> AUTH_KEY
```
  - VERBOSE
```
public static final DataSource.Parameter<Boolean> VERBOSE
```
  - listeners
```
protected List<DBDataSourceListener> listeners
```
- Constructor Detail
  - AbstractDBDataSource
```
public AbstractDBDataSource()
```
- Method Detail
  - addDBDataSourceListener
```
public void addDBDataSourceListener(DBDataSourceListener l)
```
    Registers a DBDataSourceListener at this data source.
    
    Specified by:
    
    addDBDataSourceListener in interface DBDataSource<T extends DBDataSource<T>>
    
    Parameters:
    
    l - the listener to register
  - removeDBDataSourceListener
```
public void removeDBDataSourceListener(DBDataSourceListener l)
```
    Unregisters a DBDataSourceListener.
    
    Specified by:
    
    removeDBDataSourceListener in interface DBDataSource<T extends DBDataSource<T>>
    
    Parameters:
    
    l - the listener to unregister
  - getDBDataSourceListeners
```
public DBDataSourceListener[] getDBDataSourceListeners()
```
    Retrieves all registered DBDataSourceListeners.
    
    Specified by:
    
    getDBDataSourceListeners in interface DBDataSource<T extends DBDataSource<T>>
    
    Returns:
    
    a array of DBDataSourceListeners, or a null-length array if no listener is registered
  - isEmbedded
```
public boolean isEmbedded()
```
    Returns the value of the EMBEDDED parameter.
    
    Returns:
    
    true if embedded is set, false otherwise
    
    Since:
    
    3.1
  - getHost
```
public String getHost()
```
    Returns the host of this AbstractDBDataSource.
    
    Returns:
    
    the host of this AbstractDBDataSource
  - getPort
```
public int getPort()
```
    Returns the port of this AbstractDBDataSource.
    
    Returns:
    
    the port of this AbstractDBDataSource
  - getUserName
```
public String getUserName()
```
    Returns the user name of this AbstractDBDataSource.
    
    Returns:
    
    the user name of this AbstractDBDataSource
  - getPassword
```
public Password getPassword()
```
    Returns the password of this AbstractDBDataSource.
    
    Returns:
    
    the password of this AbstractDBDataSource
  - getCatalog
```
public String getCatalog()
```
    Returns the catalog of this AbstractDBDataSource.
    
    Returns:
    
    the catalog of this AbstractDBDataSource
  - getSchema
```
public String getSchema()
```
    Returns the schema of this AbstractDBDataSource.
    
    Returns:
    
    the schema of this AbstractDBDataSource
  - getUrlExtension
```
public String getUrlExtension()
```
  - setUrlExtension
```
public void setUrlExtension(String urlExtension)
```
  - getConnectionPoolSize
```
public int getConnectionPoolSize()
```
    Returns the connection pool size of this AbstractDBDataSource.
    
    Returns:
    
    the connection pool size of this AbstractDBDataSource
  - keepConnectionsAlive
```
public boolean keepConnectionsAlive()
```
    Returns true if the connection of this AbstractDataSource is alive.
    
    Returns:
    
    true if the connection of this AbstractDataSource is alive, otherwise false .
  - isServerDataSource
```
public boolean isServerDataSource()
```
    Determines if this data source is a distibuted client-server data source.
    
    Returns:
    
    true if this data source is a distibuted client-server data source, false otherwise
  - getServerURL
```
public String getServerURL()
```
    Returns the password of this AbstractDBDataSource.
    
    Returns:
    
    the password of this AbstractDBDataSource
  - getAuthKey
```
public String getAuthKey()
```
    Returns the authentification key of this AbstractDBDataSource.
    
    Returns:
    
    the authentification key of this AbstractDBDataSource
  - setAuthKey
```
public void setAuthKey(String authKey)
```
    Sets the key which is used to authentificate this client to communicate with the servlet-part of this data source.
    
    Parameters:
    
    authKey - the new authorization key
  - isParameterRequired
```
public boolean isParameterRequired(DataSource.Parameter p)
```
    Specified by:
    
    isParameterRequired in interface DataSource<T extends DBDataSource<T>>
    
    Overrides:
    
    isParameterRequired in class AbstractDataSource<T extends DBDataSource<T>>
    
    Returns:
    
    true if the parameter p is required, depending on the other parameters' values, false otherwise
  - openConnection
```
public final DBConnection openConnection()
                                  throws DBException
```
    Description copied from interface: DBDataSource
    
    Open the connection for this DBDataSource.
    
    Specified by:
    
    openConnection in interface DBDataSource<T extends DBDataSource<T>>
    
    Returns:
    
    the open DBConnection
    
    Throws:
    
    DBException - if a database access error occurs
  - openConnectionImpl
```
protected abstract DBConnection openConnectionImpl()
                                            throws DBException
```
    Throws:
    
    DBException

Class AbstractDBDataSource<T extends DBDataSource<T>>

Nested Class Summary

Nested classes/interfaces inherited from interface xdev.util.DataSource

Field Summary

Fields inherited from class xdev.util.AbstractDataSource

Constructor Summary

Method Summary

Methods inherited from class xdev.util.AbstractDataSource

Methods inherited from class java.lang.Object

Methods inherited from interface xdev.db.DBDataSource

Methods inherited from interface xdev.util.DataSource

Field Detail

EMBEDDED

HOST

PORT

USERNAME

PASSWORD

CATALOG

SCHEMA

URL_EXTENSION

CONNECTION_POOL_SIZE

KEEP_CONNECTIONS_ALIVE

IS_SERVER_DATASOURCE

SERVER_URL

AUTH_KEY

VERBOSE

listeners

Constructor Detail

AbstractDBDataSource

Method Detail

addDBDataSourceListener

removeDBDataSourceListener

getDBDataSourceListeners

isEmbedded

getHost

getPort

getUserName

getPassword

getCatalog

getSchema

getUrlExtension

setUrlExtension

getConnectionPoolSize

keepConnectionsAlive

isServerDataSource

getServerURL

getAuthKey

setAuthKey

isParameterRequired

openConnection

openConnectionImpl