org.apache.derby.jdbc
Class Driver20

java.lang.Object
  org.apache.derby.jdbc.InternalDriver
      org.apache.derby.jdbc.Driver20

All Implemented Interfaces:

java.sql.Driver, ModuleControl

Direct Known Subclasses:

Driver30

public abstract class Driver20
extends InternalDriver
implements java.sql.Driver

This class extends the local JDBC driver in order to determine at JBMS boot-up if the JVM that runs us does support JDBC 2.0. If it is the case then we will load the appropriate class(es) that have JDBC 2.0 new public methods and sql types.

Nested Class Summary

private static class	Driver20.DaemonThreadFactory Thread factory to produce daemon threads which don't block VM shutdown
static class	Driver20.LoginCallable This code is called in a thread which puts time limits on it.

Field Summary

private static java.util.concurrent.ThreadPoolExecutor	_executorPool
private java.lang.Class	antiGCDriverManager
private static java.lang.String[]	BOOLEAN_CHOICES
private static java.lang.String	driver20

Fields inherited from class org.apache.derby.jdbc.InternalDriver

active

Constructor Summary

Driver20()

Method Summary

void	boot(boolean create, java.util.Properties properties) Boot this module with the given properties.
void	checkSystemPrivileges(java.lang.String user, java.security.Permission perm) Checks for System Privileges.
java.sql.Connection	connect(java.lang.String url, java.util.Properties info)
java.sql.DriverPropertyInfo[]	getPropertyInfo(java.lang.String url, java.util.Properties info) The getPropertyInfo method is intended to allow a generic GUI tool to discover what properties it should prompt a human for in order to get enough information to connect to a database.
abstract BrokeredConnection	newBrokeredConnection(BrokeredConnectionControl control)
EmbedResultSet	newEmbedResultSet(EmbedConnection conn, ResultSet results, boolean forMetaData, EmbedStatement statement, boolean isAtomic) Return a new java.sql.ResultSet instance for this implementation.
private java.sql.SQLException	processException(java.lang.Throwable t) Process exceptions raised while running a timed login
void	stop() Stop the module.
protected EmbedConnection	timeLogin(java.lang.String url, java.util.Properties info, int loginTimeoutSeconds) Use java.util.concurrent package to enforce login timeouts.

Methods inherited from class org.apache.derby.jdbc.InternalDriver

acceptsURL, activeDriver, connect, embeddedDriverAcceptsURL, getAttributes, getAuthenticationService, getContextServiceFactory, getDatabaseName, getDeregister, getMajorVersion, getMinorVersion, getNewEmbedConnection, getNewNestedConnection, isActive, jdbcCompliant, newEmbedCallableStatement, newEmbedDatabaseMetaData, newEmbedPreparedStatement, newEmbedResultSetMetaData, newEmbedStatement, setDeregister

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.sql.Driver

acceptsURL, getMajorVersion, getMinorVersion, jdbcCompliant

Field Detail

_executorPool

private static java.util.concurrent.ThreadPoolExecutor _executorPool

BOOLEAN_CHOICES

private static final java.lang.String[] BOOLEAN_CHOICES

antiGCDriverManager

private java.lang.Class antiGCDriverManager

driver20

private static final java.lang.String driver20

See Also:

Constant Field Values

Constructor Detail

Driver20

public Driver20()

Method Detail

boot

public void boot(boolean create,
                 java.util.Properties properties)
          throws StandardException

Description copied from interface: ModuleControl

Boot this module with the given properties. Creates a module instance that can be found using the findModule() methods of Monitor. The module can only be found using one of these findModule() methods once this method has returned.

An implementation's boot method can throw StandardException. If it is thrown the module is not registered by the monitor and therefore cannot be found through a findModule(). In this case the module's stop() method is not called, thus throwing this exception must free up any resources.

When create is true the contents of the properties object will be written to the service.properties of the persistent service. Thus any code that requires an entry in service.properties must explicitly place the value in this properties set using the put method.
Typically the properties object contains one or more default properties sets, which are not written out to service.properties. These default sets are how callers modify the create process. In a JDBC connection database create the first set of defaults is a properties object that contains the attributes that were set on the jdbc:derby: URL. This attributes properties set has the second default properties set as its default. This set (which could be null) contains the properties that the user set on their DriverManager.getConnection() call, and are thus not owned by Derby code, and thus must not be modified by Derby code.

When create is false the properties object contains all the properties set in the service.properties file plus a limited number of attributes from the JDBC URL attributes or connection properties set. This avoids properties set by the user compromising the boot process. An example of a property passed in from the JDBC world is the bootPassword for encrypted databases.

Code should not hold onto the passed in properties reference after boot time as its contents may change underneath it. At least after the complete boot is completed, the links to all the default sets will be removed.

Specified by:

boot in interface ModuleControl

Overrides:

boot in class InternalDriver

Throws:

StandardException - Module cannot be started.

See Also:

Monitor, ModuleFactory

stop

public void stop()

Description copied from interface: ModuleControl

Stop the module. The module may be found via a findModule() method until some time after this method returns. Therefore the factory must be prepared to reject requests to it once it has been stopped. In addition other modules may cache a reference to the module and make requests of it after it has been stopped, these requests should be rejected as well.

Specified by:

stop in interface ModuleControl

Overrides:

stop in class InternalDriver

See Also:

Monitor, ModuleFactory

newEmbedResultSet

public EmbedResultSet newEmbedResultSet(EmbedConnection conn,
                                        ResultSet results,
                                        boolean forMetaData,
                                        EmbedStatement statement,
                                        boolean isAtomic)
                                 throws java.sql.SQLException

Description copied from class: InternalDriver

Return a new java.sql.ResultSet instance for this implementation.

Specified by:

newEmbedResultSet in class InternalDriver

Parameters:

conn - Owning connection

results - Top level of language result set tree

forMetaData - Is this for meta-data

statement - The statement that is creating the SQL ResultSet

Returns:

a new java.sql.ResultSet

Throws:

java.sql.SQLException

newBrokeredConnection

public abstract BrokeredConnection newBrokeredConnection(BrokeredConnectionControl control)
                                                  throws java.sql.SQLException

Throws:

java.sql.SQLException

getPropertyInfo

public java.sql.DriverPropertyInfo[] getPropertyInfo(java.lang.String url,
                                                     java.util.Properties info)
                                              throws java.sql.SQLException

The getPropertyInfo method is intended to allow a generic GUI tool to discover what properties it should prompt a human for in order to get enough information to connect to a database. Note that depending on the values the human has supplied so far, additional values may become necessary, so it may be necessary to iterate though several calls to getPropertyInfo.

Specified by:

getPropertyInfo in interface java.sql.Driver

Parameters:

url - The URL of the database to connect to.

info - A proposed list of tag/value pairs that will be sent on connect open.

Returns:

An array of DriverPropertyInfo objects describing possible properties. This array may be an empty array if no properties are required.

Throws:

java.sql.SQLException - if a database-access error occurs.

checkSystemPrivileges

public void checkSystemPrivileges(java.lang.String user,
                                  java.security.Permission perm)
                           throws java.lang.Exception

Checks for System Privileges.

Specified by:

checkSystemPrivileges in class InternalDriver

Parameters:

user - The user to be checked for having the permission

perm - The permission to be checked

Throws:

java.security.AccessControlException - if permissions are missing

java.lang.Exception - if the privileges check fails for some other reason

connect

public java.sql.Connection connect(java.lang.String url,
                                   java.util.Properties info)
                            throws java.sql.SQLException

Specified by:

connect in interface java.sql.Driver

Throws:

java.sql.SQLException

timeLogin

protected EmbedConnection timeLogin(java.lang.String url,
                                    java.util.Properties info,
                                    int loginTimeoutSeconds)
                             throws java.sql.SQLException

Use java.util.concurrent package to enforce login timeouts.

Specified by:

timeLogin in class InternalDriver

Throws:

java.sql.SQLException

processException

private java.sql.SQLException processException(java.lang.Throwable t)

Process exceptions raised while running a timed login