com.aspc.remote.database

Class DataBase

java.lang.Object

com.aspc.remote.database.DataBase

public class DataBase
extends java.lang.Object

DataBase is the holder of the database connection.
THREAD MODE: MULTI-THREADED

Since:

19 May 1997

Author:

Nigel Leck

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataBase.Protection Protection modes.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROPERTY_DRIVER the raw driver class name
DataBase.Protection	protection Protection mode
static java.lang.String	SQL_READ_TIMEOUT SQL read timeout
static java.lang.String	TYPE_DERBY Derby database
static java.lang.String	TYPE_HSQLDB HSQLDB database
static java.lang.String	TYPE_MSSQL Microsoft SQL Server
static java.lang.String	TYPE_MSSQL_NATIVE Microsoft SQL Server using the Microsoft JDBC Driver
static java.lang.String	TYPE_MYSQL MySQL database
static java.lang.String	TYPE_ORACLE Oracle database.
static java.lang.String	TYPE_POSTGRESQL Postgres database
static java.lang.String	TYPE_SYBASE Sybase database

Constructor Summary

Constructors

Constructor and Description
DataBase(java.lang.String userId, java.lang.String password, java.lang.String inType, java.lang.String inUrl) Deprecated. specify the protection constructor.
DataBase(java.lang.String userId, java.lang.String password, java.lang.String inType, java.lang.String inUrl, DataBase.Protection protection) create a new database

Method Summary

Modifier and Type	Method and Description
java.lang.StringBuilder	appendSQLString(java.lang.StringBuilder buffer, long l) Returns the native expression of a long value for this database type.
void	checkInConnection(java.sql.Connection connection)
java.sql.Connection	checkOutConnection() Synchronized so that it puts a limit onto the number of connections Hopefully if two threads require a connection by the time one has connected another connection may be freed.
boolean	checkVersion(int major, int minor) Version supported
void	close() close the database connections
void	connect() make a new connection.
java.lang.String	displayDriverInfo() Display the driver info ( class name and jar file).
java.lang.String	encodeString(java.lang.String javaString) SQL encoding for a string
static void	exponentialBackOff(int attempt) Sleep for a increasing amount of time as each attempt fails.
java.lang.String	getBatchSeperator() Returns which separator should be used for this database.
java.lang.String	getCreateIndexSuffix() get the create index suffix
java.lang.String	getCreateTableSuffix() get the create table suffix
static DataBase	getCurrent()
int	getMajorVersion() Retrieves the major version of the database
static java.lang.String	getMasterDBName(java.lang.String inType)
int	getMaxPreparedStatements()
int	getMaxStatementLength() The maximum statement length
int	getMinorVersion() Retrieves the minor version of the database
java.lang.String	getPassword()
java.lang.String	getShortUrl()
boolean	getSupportsBatchInsertValues()
boolean	getSupportsBatchStatements() Returns which separator should be used for this database.
boolean	getSupportsIndexRenames() does this database support renaming of indexes ?
boolean	getSupportsTableRenames() does this database support renaming of tables ?
java.lang.String	getType()
java.lang.String	getTypeKey()
java.lang.String	getUrl()
java.lang.String	getUser()
boolean	hasSQLEscape() The escape string.
boolean	isCommentsSupported()
boolean	isConnected()
boolean	isShuttingDown() Is the database shutting down ?
DataBase	setCreateIndexSuffix(java.lang.String suffix) set the create index suffix
DataBase	setCreateTableSuffix(java.lang.String suffix) set the create table suffix
DataBase	setCurrent()
DataBase	setVisible(boolean visible)
void	shutDown()
boolean	supportsMultipleJVMs() Some databases can not be shared by multiple JVM.
java.lang.String	toString() to string

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_DRIVER

public static final java.lang.String PROPERTY_DRIVER

the raw driver class name

See Also:

Constant Field Values

SQL_READ_TIMEOUT

public static final java.lang.String SQL_READ_TIMEOUT

SQL read timeout

See Also:

Constant Field Values

TYPE_DERBY

public static final java.lang.String TYPE_DERBY

Derby database

See Also:

Constant Field Values

TYPE_SYBASE

public static final java.lang.String TYPE_SYBASE

Sybase database

See Also:

Constant Field Values

TYPE_HSQLDB

public static final java.lang.String TYPE_HSQLDB

HSQLDB database

See Also:

Constant Field Values

TYPE_POSTGRESQL

public static final java.lang.String TYPE_POSTGRESQL

Postgres database

See Also:

Constant Field Values

TYPE_ORACLE

public static final java.lang.String TYPE_ORACLE

Oracle database.

See Also:

Constant Field Values

TYPE_MYSQL

public static final java.lang.String TYPE_MYSQL

MySQL database

See Also:

Constant Field Values

TYPE_MSSQL

public static final java.lang.String TYPE_MSSQL

Microsoft SQL Server

See Also:

Constant Field Values

TYPE_MSSQL_NATIVE

public static final java.lang.String TYPE_MSSQL_NATIVE

Microsoft SQL Server using the Microsoft JDBC Driver

See Also:

Constant Field Values

protection

public final DataBase.Protection protection

Protection mode

Constructor Detail

DataBase

public DataBase(java.lang.String userId,
                java.lang.String password,
                java.lang.String inType,
                java.lang.String inUrl)
         throws java.lang.Exception

Deprecated. specify the protection constructor.

create a new database

Parameters:

userId - the user id

password - the password to use when connecting.

inType - the database type

inUrl - the connection URL

Throws:

java.lang.Exception - a serious problem

DataBase

public DataBase(java.lang.String userId,
                java.lang.String password,
                @Nonnull
                java.lang.String inType,
                @Nonnull
                java.lang.String inUrl,
                @Nonnull
                DataBase.Protection protection)
         throws java.lang.Exception

create a new database

Parameters:

userId - the user id

password - the password to use when connecting.

inType - the database type

inUrl - the connection URL

protection - the protection mode.

Throws:

java.lang.Exception - a serious problem

Method Detail

getMaxPreparedStatements

@CheckReturnValue
public int getMaxPreparedStatements()

setCreateTableSuffix

@Nonnull
public DataBase setCreateTableSuffix(@Nullable
                                              java.lang.String suffix)

set the create table suffix

Parameters:

suffix - the suffix

Returns:

this

getCreateTableSuffix

@CheckReturnValue
 @Nullable
public java.lang.String getCreateTableSuffix()

get the create table suffix

Returns:

the suffix

setCreateIndexSuffix

@Nonnull
public DataBase setCreateIndexSuffix(@Nullable
                                              java.lang.String suffix)

set the create index suffix

Parameters:

suffix - the suffix

Returns:

this

isShuttingDown

public boolean isShuttingDown()

Is the database shutting down ?

Returns:

true if shutting down.

getCreateIndexSuffix

@CheckReturnValue
 @Nullable
public java.lang.String getCreateIndexSuffix()

get the create index suffix

Returns:

the suffix

checkVersion

@CheckReturnValue
public boolean checkVersion(int major,
                                              int minor)

Version supported

Parameters:

major - the major data base version

minor - the minor data base version

Returns:

true if a supported version.

toString

@CheckReturnValue
 @Nonnull
public java.lang.String toString()

to string

Overrides:

toString in class java.lang.Object

Returns:

the string

close

public void close()

close the database connections

appendSQLString

@Nonnull
public java.lang.StringBuilder appendSQLString(@Nonnull
                                                        java.lang.StringBuilder buffer,
                                                        long l)

Returns the native expression of a long value for this database type. Note: This is very important for POSTGRES as it will not use the indexes for a long unless you cast it.

Parameters:

buffer - the buffer of the SQL statement

l - the long value

Returns:

the appended long

isCommentsSupported

@CheckReturnValue
public boolean isCommentsSupported()

Returns:

true if this database supports comments

getUrl

@CheckReturnValue
 @Nonnull
public java.lang.String getUrl()

Returns:

the URL

getShortUrl

@CheckReturnValue
 @Nonnull
public java.lang.String getShortUrl()

Returns:

the short URL

getType

@CheckReturnValue
 @Nonnull
public java.lang.String getType()

Returns:

the database Type

isConnected

@CheckReturnValue
public boolean isConnected()

Returns:

true if connected

supportsMultipleJVMs

@CheckReturnValue
public boolean supportsMultipleJVMs()

Some databases can not be shared by multiple JVM.

Returns:

false if the database can only be accessed by one process.

getMasterDBName

@CheckReturnValue
 @Nonnull
public static java.lang.String getMasterDBName(@Nullable
                                                                           java.lang.String inType)
                                                                    throws java.lang.Exception

Parameters:

inType - the database type

Returns:

the default database name

Throws:

java.lang.Exception - a serious problem

getUser

@CheckReturnValue
 @Nonnull
public java.lang.String getUser()

Returns:

the user

getPassword

@CheckReturnValue
 @Nonnull
public java.lang.String getPassword()

Returns:

the password

setVisible

@Nonnull
public DataBase setVisible(boolean visible)

Parameters:

visible - true if visible

Returns:

this

setCurrent

@Nonnull
public DataBase setCurrent()

Returns:

this

getTypeKey

@CheckReturnValue
 @Nonnull
public java.lang.String getTypeKey()

Returns:

the KEY

getMaxStatementLength

@CheckReturnValue
public int getMaxStatementLength()

The maximum statement length

Returns:

the length

connect

public void connect()
             throws java.lang.Exception

make a new connection.

Throws:

java.lang.Exception - a serious problem

exponentialBackOff

public static void exponentialBackOff(int attempt)

Sleep for a increasing amount of time as each attempt fails.

Parameters:

attempt - the attempt counter.

displayDriverInfo

@CheckReturnValue
 @Nonnull
public java.lang.String displayDriverInfo()

Display the driver info ( class name and jar file).

Returns:

the information.

getBatchSeperator

@CheckReturnValue
 @Nonnull
public java.lang.String getBatchSeperator()

Returns which separator should be used for this database. eg, SYABSE is blank but others are ;

Returns:

the separator for the statements

hasSQLEscape

@CheckReturnValue
public boolean hasSQLEscape()

The escape string.

Returns:

true if we need to escape sqls.

encodeString

@CheckReturnValue
 @Nonnull
public java.lang.String encodeString(@Nonnull
                                                                 java.lang.String javaString)

SQL encoding for a string

Parameters:

javaString - the required encoding

Returns:

the SQL value

getCurrent

@CheckReturnValue
 @Nullable
public static DataBase getCurrent()

Returns:

the current database.

getSupportsBatchStatements

@CheckReturnValue
public boolean getSupportsBatchStatements()

Returns which separator should be used for this database. eg, SYABSE is blank but others are ;

Returns:

true if this database supports batch statements

getSupportsBatchInsertValues

@CheckReturnValue
public boolean getSupportsBatchInsertValues()

Returns:

true if this database supports batch inserts

getSupportsTableRenames

@CheckReturnValue
public boolean getSupportsTableRenames()

does this database support renaming of tables ?

Returns:

true if we can rename tables.

getSupportsIndexRenames

@CheckReturnValue
public boolean getSupportsIndexRenames()

does this database support renaming of indexes ?

Returns:

true if we can rename indexes.

checkInConnection

public void checkInConnection(@Nullable
                              java.sql.Connection connection)

Parameters:

connection - the connection to check in

checkOutConnection

@CheckReturnValue
 @Nonnull
public java.sql.Connection checkOutConnection()
                                                                   throws java.lang.Exception

Synchronized so that it puts a limit onto the number of connections Hopefully if two threads require a connection by the time one has connected another connection may be freed. The procedure loops until it finds a live connection. If the connection is not valid then remove it from the LinkManager.

Returns:

the connection

Throws:

java.lang.Exception - a serious problem

getMajorVersion

@CheckReturnValue
public int getMajorVersion()
                                      throws java.lang.Exception

Retrieves the major version of the database

Returns:

version

Throws:

java.lang.Exception - a serious problem

getMinorVersion

@CheckReturnValue
public int getMinorVersion()
                                      throws java.lang.Exception

Retrieves the minor version of the database

Returns:

version

Throws:

java.lang.Exception - a serious problem

shutDown

public void shutDown()