ServletDBDataSource (XDEV Application Framework 5.0.2 API)

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

All Implemented Interfaces:

DBDataSource<ServletDBDataSource>, DataSource<ServletDBDataSource>
```
public class ServletDBDataSource
extends AbstractDBDataSource<ServletDBDataSource>
```

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 byte[]`	`HANDSHAKE`
`static String`	`KEY_EXCHANGE_ALGORITHM`
`static String`	`KEY_FROM_CERT`
`static String`	`KEY_PARAM`
`static String`	`MAC_ALGORITHM`
`static byte`	`REQUEST_BEGIN_TRANSACTION`
`static byte`	`REQUEST_COMMIT`
`static byte`	`REQUEST_GET_QUERY_ROW_COUNT`
`static byte`	`REQUEST_METADATA`
`static byte`	`REQUEST_METADATA_ERS`
`static byte`	`REQUEST_METADATA_STORED_PROCEDURES`
`static byte`	`REQUEST_METADATA_SYNC`
`static byte`	`REQUEST_METADATA_TABLE_INFOS`
`static byte`	`REQUEST_METADATA_TABLE_METADATA`
`static byte`	`REQUEST_PAGING_CLOSE`
`static byte`	`REQUEST_PAGING_RESULT`
`static byte`	`REQUEST_PAGING_START`
`static byte`	`REQUEST_QUERY_SQL`
`static byte`	`REQUEST_RELEASE_SAVEPOINT`
`static byte`	`REQUEST_ROLLBACK`
`static byte`	`REQUEST_ROLLBACK_SAVEPOINT`
`static byte`	`REQUEST_SET_SAVEPOINT`
`static byte`	`REQUEST_SET_SAVEPOINT_NAME`
`static byte`	`REQUEST_STORED_PROCEDURE`
`static byte`	`REQUEST_TEST_CONNECTION`
`static byte`	`REQUEST_WRITE_SQL`
`static byte`	`REQUEST_WRITE_SQL_COLS`
`static byte`	`REQUEST_WRITE_SQL_RGK`
`static byte`	`RESPONSE_EXCEPTION`
`static byte`	`RESPONSE_OK`
`static byte`	`RESPONSE_STORED_PROCEDURE_OBJECT`
`static byte`	`RESPONSE_STORED_PROCEDURE_RESULT`
`static byte`	`RESPONSE_STORED_PROCEDURE_VOID`
`static byte`	`RESPONSE_TYPE_0`
`static byte`	`RESPONSE_TYPE_1`
`static String`	`SECRET_KEY_ALGORITHM`
`static String`	`SESSIONID_PARAM`

Fields inherited from class xdev.db.AbstractDBDataSource
AUTH_KEY, CATALOG, CONNECTION_POOL_SIZE, EMBEDDED, HOST, IS_SERVER_DATASOURCE, KEEP_CONNECTIONS_ALIVE, listeners, PASSWORD, PORT, SCHEMA, SERVER_URL, URL_EXTENSION, USERNAME, VERBOSE

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

Constructor Summary

Constructors
Constructor and Description

ServletDBDataSource(JDBCDataSource original)

Constructors
Constructor and Description
`ServletDBDataSource(JDBCDataSource original)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canExport()` Determines if this data source is able to create or alter tables in the database.
`void`	`clearCaches()` Clears all caches of this data source.
`void`	`closeAllOpenConnections()` Close all open connections.
`protected xdev.db.servlet.SessionInfo`	`createSessionInfo(String url)`
`DataSource.Parameter[]`	`getDefaultParameters()`
`DBMetaData`	`getMetaData()`
`ServletDBConnection`	`openConnectionImpl()`
`void`	`setAuthKey(String authKey)` Sets the key which is used to authentificate this client to communicate with the servlet-part of this data source.

Methods inherited from class xdev.db.AbstractDBDataSource
addDBDataSourceListener, getAuthKey, getCatalog, getConnectionPoolSize, getDBDataSourceListeners, getHost, getPassword, getPort, getSchema, getServerURL, getUrlExtension, getUserName, isEmbedded, isParameterRequired, isServerDataSource, keepConnectionsAlive, openConnection, removeDBDataSourceListener, setUrlExtension

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.util.DataSource
getDefaultParameter, getName, getParameter, getParameters, getParameterValue, getParameterValue, putParameter

- Field Detail
  - HANDSHAKE
```
public static final byte[] HANDSHAKE
```
  - SESSIONID_PARAM
```
public static final String SESSIONID_PARAM
```
    See Also:
    
    Constant Field Values
  - KEY_PARAM
```
public static final String KEY_PARAM
```
    See Also:
    
    Constant Field Values
  - KEY_FROM_CERT
```
public static final String KEY_FROM_CERT
```
    See Also:
    
    Constant Field Values
  - SECRET_KEY_ALGORITHM
```
public static final String SECRET_KEY_ALGORITHM
```
    See Also:
    
    Constant Field Values
  - KEY_EXCHANGE_ALGORITHM
```
public static final String KEY_EXCHANGE_ALGORITHM
```
    See Also:
    
    Constant Field Values
  - MAC_ALGORITHM
```
public static final String MAC_ALGORITHM
```
    See Also:
    
    Constant Field Values
  - REQUEST_TEST_CONNECTION
```
public static final byte REQUEST_TEST_CONNECTION
```
    See Also:
    
    Constant Field Values
  - REQUEST_METADATA
```
public static final byte REQUEST_METADATA
```
    See Also:
    
    Constant Field Values
  - REQUEST_METADATA_TABLE_INFOS
```
public static final byte REQUEST_METADATA_TABLE_INFOS
```
    See Also:
    
    Constant Field Values
  - REQUEST_METADATA_TABLE_METADATA
```
public static final byte REQUEST_METADATA_TABLE_METADATA
```
    See Also:
    
    Constant Field Values
  - REQUEST_METADATA_STORED_PROCEDURES
```
public static final byte REQUEST_METADATA_STORED_PROCEDURES
```
    See Also:
    
    Constant Field Values
  - REQUEST_METADATA_ERS
```
public static final byte REQUEST_METADATA_ERS
```
    See Also:
    
    Constant Field Values
  - REQUEST_METADATA_SYNC
```
public static final byte REQUEST_METADATA_SYNC
```
    See Also:
    
    Constant Field Values
  - REQUEST_QUERY_SQL
```
public static final byte REQUEST_QUERY_SQL
```
    See Also:
    
    Constant Field Values
  - REQUEST_GET_QUERY_ROW_COUNT
```
public static final byte REQUEST_GET_QUERY_ROW_COUNT
```
    See Also:
    
    Constant Field Values
  - REQUEST_WRITE_SQL_RGK
```
public static final byte REQUEST_WRITE_SQL_RGK
```
    See Also:
    
    Constant Field Values
  - REQUEST_WRITE_SQL_COLS
```
public static final byte REQUEST_WRITE_SQL_COLS
```
    See Also:
    
    Constant Field Values
  - REQUEST_WRITE_SQL
```
public static final byte REQUEST_WRITE_SQL
```
    See Also:
    
    Constant Field Values
  - REQUEST_STORED_PROCEDURE
```
public static final byte REQUEST_STORED_PROCEDURE
```
    See Also:
    
    Constant Field Values
  - REQUEST_BEGIN_TRANSACTION
```
public static final byte REQUEST_BEGIN_TRANSACTION
```
    See Also:
    
    Constant Field Values
  - REQUEST_SET_SAVEPOINT
```
public static final byte REQUEST_SET_SAVEPOINT
```
    See Also:
    
    Constant Field Values
  - REQUEST_SET_SAVEPOINT_NAME
```
public static final byte REQUEST_SET_SAVEPOINT_NAME
```
    See Also:
    
    Constant Field Values
  - REQUEST_RELEASE_SAVEPOINT
```
public static final byte REQUEST_RELEASE_SAVEPOINT
```
    See Also:
    
    Constant Field Values
  - REQUEST_COMMIT
```
public static final byte REQUEST_COMMIT
```
    See Also:
    
    Constant Field Values
  - REQUEST_ROLLBACK
```
public static final byte REQUEST_ROLLBACK
```
    See Also:
    
    Constant Field Values
  - REQUEST_ROLLBACK_SAVEPOINT
```
public static final byte REQUEST_ROLLBACK_SAVEPOINT
```
    See Also:
    
    Constant Field Values
  - REQUEST_PAGING_START
```
public static final byte REQUEST_PAGING_START
```
    See Also:
    
    Constant Field Values
  - REQUEST_PAGING_RESULT
```
public static final byte REQUEST_PAGING_RESULT
```
    See Also:
    
    Constant Field Values
  - REQUEST_PAGING_CLOSE
```
public static final byte REQUEST_PAGING_CLOSE
```
    See Also:
    
    Constant Field Values
  - RESPONSE_TYPE_0
```
public static final byte RESPONSE_TYPE_0
```
    See Also:
    
    Constant Field Values
  - RESPONSE_TYPE_1
```
public static final byte RESPONSE_TYPE_1
```
    See Also:
    
    Constant Field Values
  - RESPONSE_OK
```
public static final byte RESPONSE_OK
```
    See Also:
    
    Constant Field Values
  - RESPONSE_EXCEPTION
```
public static final byte RESPONSE_EXCEPTION
```
    See Also:
    
    Constant Field Values
  - RESPONSE_STORED_PROCEDURE_VOID
```
public static final byte RESPONSE_STORED_PROCEDURE_VOID
```
    See Also:
    
    Constant Field Values
  - RESPONSE_STORED_PROCEDURE_RESULT
```
public static final byte RESPONSE_STORED_PROCEDURE_RESULT
```
    See Also:
    
    Constant Field Values
  - RESPONSE_STORED_PROCEDURE_OBJECT
```
public static final byte RESPONSE_STORED_PROCEDURE_OBJECT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ServletDBDataSource
```
public ServletDBDataSource(JDBCDataSource original)
```
- Method Detail
  - setAuthKey
```
public void setAuthKey(String authKey)
```
    Description copied from class: AbstractDBDataSource
    
    Sets the key which is used to authentificate this client to communicate with the servlet-part of this data source.
    
    Overrides:
    
    setAuthKey in class AbstractDBDataSource<ServletDBDataSource>
    
    Parameters:
    
    authKey - the new authorization key
  - openConnectionImpl
```
public ServletDBConnection openConnectionImpl()
                                       throws DBException
```
    Specified by:
    
    openConnectionImpl in class AbstractDBDataSource<ServletDBDataSource>
    
    Throws:
    
    DBException
  - createSessionInfo
```
protected xdev.db.servlet.SessionInfo createSessionInfo(String url)
                                                 throws Exception
```
    Throws:
    
    Exception
  - closeAllOpenConnections
```
public void closeAllOpenConnections()
                             throws DBException
```
    Description copied from interface: DBDataSource
    
    Close all open connections.
    
    Specified by:
    
    closeAllOpenConnections in interface DBDataSource<ServletDBDataSource>
    
    Throws:
    
    DBException - if a database access error occurs
  - clearCaches
```
public void clearCaches()
```
    Description copied from interface: DataSource
    
    Clears all caches of this data source.
    This method should be called after a parameter's value is changed if the data source has been used before.
    
    Specified by:
    
    clearCaches in interface DataSource<ServletDBDataSource>
  - getDefaultParameters
```
public DataSource.Parameter[] getDefaultParameters()
```
    Specified by:
    
    getDefaultParameters in interface DataSource<ServletDBDataSource>
  - getMetaData
```
public DBMetaData getMetaData()
                       throws DBException
```
    Description copied from interface: DBDataSource
    
    Specified by:
    
    getMetaData in interface DBDataSource<ServletDBDataSource>
    
    Specified by:
    
    getMetaData in interface DataSource<ServletDBDataSource>
    
    Throws:
    
    DBException
  - canExport
```
public boolean canExport()
```
    Description copied from interface: DBDataSource
    
    Determines if this data source is able to create or alter tables in the database.
    
    Specified by:
    
    canExport in interface DBDataSource<ServletDBDataSource>

Class ServletDBDataSource

Nested Class Summary

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

Field Summary

Fields inherited from class xdev.db.AbstractDBDataSource

Fields inherited from class xdev.util.AbstractDataSource

Constructor Summary

Method Summary

Methods inherited from class xdev.db.AbstractDBDataSource

Methods inherited from class xdev.util.AbstractDataSource

Methods inherited from class java.lang.Object

Methods inherited from interface xdev.util.DataSource

Field Detail

HANDSHAKE

SESSIONID_PARAM

KEY_PARAM

KEY_FROM_CERT

SECRET_KEY_ALGORITHM

KEY_EXCHANGE_ALGORITHM

MAC_ALGORITHM

REQUEST_TEST_CONNECTION

REQUEST_METADATA

REQUEST_METADATA_TABLE_INFOS

REQUEST_METADATA_TABLE_METADATA

REQUEST_METADATA_STORED_PROCEDURES

REQUEST_METADATA_ERS

REQUEST_METADATA_SYNC

REQUEST_QUERY_SQL

REQUEST_GET_QUERY_ROW_COUNT

REQUEST_WRITE_SQL_RGK

REQUEST_WRITE_SQL_COLS

REQUEST_WRITE_SQL

REQUEST_STORED_PROCEDURE

REQUEST_BEGIN_TRANSACTION

REQUEST_SET_SAVEPOINT

REQUEST_SET_SAVEPOINT_NAME

REQUEST_RELEASE_SAVEPOINT

REQUEST_COMMIT

REQUEST_ROLLBACK

REQUEST_ROLLBACK_SAVEPOINT

REQUEST_PAGING_START

REQUEST_PAGING_RESULT

REQUEST_PAGING_CLOSE

RESPONSE_TYPE_0

RESPONSE_TYPE_1

RESPONSE_OK

RESPONSE_EXCEPTION

RESPONSE_STORED_PROCEDURE_VOID

RESPONSE_STORED_PROCEDURE_RESULT

RESPONSE_STORED_PROCEDURE_OBJECT

Constructor Detail

ServletDBDataSource

Method Detail

setAuthKey

openConnectionImpl

createSessionInfo

closeAllOpenConnections

clearCaches

getDefaultParameters

getMetaData

canExport