Apache Derby Database Engine and Embedded JDBC Driver 10.17.1.0 · org.apache.derby.iapi.jdbc.InternalDriver

Modifier and Type	Class and Description
private static class	InternalDriver.DaemonThreadFactory Thread factory to produce daemon threads which don't block VM shutdown.
public static class	InternalDriver.LoginCallable This code is called in a thread which puts time limits on it.

Modifier and Type	Field and Description
private static final ExecutorService	_executorPool An executor service used for executing connection attempts when a login timeout has been specified.
protected boolean	active
private static InternalDriver	activeDriver
private AuthenticationService	authenticationService
private static final String[]	BOOLEAN_CHOICES
private ContextService	contextServiceFactory
private static boolean	deregister Tells whether or not `AutoloadedDriver` should deregister itself on shutdown.
private Object	mbean
private static final Object	syncMe

Access	Constructor and Description
public	InternalDriver()

Method Summary

Modifier and Type	Method and Description
public boolean	acceptsURL(String the URL of the database url) Implements java.sql.Driver.acceptsURL. Retrieves whether the driver thinks that it can open a connection to the given URL.
public static final InternalDriver	activeDriver()
public void	boot(boolean True if the database should be created create, Properties Configuration properties properties) Implements org.apache.derby.iapi.services.monitor.ModuleControl.boot. Boot this module with the given properties.
private static void	checkBoolean(Properties set, String attribute)
private static void	checkEnumeration(Properties set, String attribute, String[] choices)
private void	checkShutdownPrivileges(String The user to be checked for shutdown privileges user) Checks for shutdown System Privileges.
public void	checkSystemPrivileges(String The user to be checked for having the permission user, Permission The permission to be checked perm) Checks for System Privileges.
public Connection	connect(String url, Properties info, int loginTimeoutSeconds)
public Connection	connect(String the URL of the database to which to connect url, Properties a list of arbitrary string tag/value pairs as connection arguments. Normally at least a "user" and "password" property should be included. info) Implements java.sql.Driver.connect. Attempts to make a database connection to the given URL.
public static boolean	embeddedDriverAcceptsURL(String url)
private static Object	findService(final String factoryInterface, final String serviceName) Must be private so that user code can't call this entry point.
protected FormatableProperties	Returns: a Derby properties object getAttributes(String The properties-bearing URL url, Properties Existing properties info) Convert all the attributes in the url into properties and combine them with the set provided.
public AuthenticationService	getAuthenticationService()
private ConnectionContext	getConnectionContext()
private static ContextService	getContextService() Must be private so that user code can't call this entry point.
public final ContextService	getContextServiceFactory()
private ContextManager	getCurrentContextManager()
public static String	Returns: a String containing the database name or an empty string ("") if no database name is present in the URL. getDatabaseName(String The url being used for the connection url, Properties The properties set being used for the connection, must include the properties derived from the attributes in the url info) Get the database name from the url.
public static boolean	Returns: the deregister value getDeregister() Check whether `AutoloadedDriver` should deregister itself on shutdown.
public int	getMajorVersion() Implements java.sql.Driver.getMajorVersion. Retrieves the driver's major version number.
public int	getMinorVersion() Implements java.sql.Driver.getMinorVersion. Gets the driver's minor version number.
private static ModuleFactory	getMonitor() Must be private so that user code can't call this entry point.
pack-priv EmbedConnection	getNewEmbedConnection(final String url, final Properties info)
public Connection	Returns: A nested connection object. getNewNestedConnection(EmbedConnection The EmbedConnection. conn) Get a new nested connection.
public Logger	getParentLogger() Implements java.sql.Driver.getParentLogger. Return the parent Logger of all the Loggers used by this driver.
public DriverPropertyInfo[]	Returns: An array of DriverPropertyInfo objects describing possible properties. This array may be an empty array if no properties are required. getPropertyInfo(String The URL of the database to connect to. url, Properties A proposed list of tag/value pairs that will be sent on connect open. info) Implements java.sql.Driver.getPropertyInfo. 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.
private static Object	getSystemModule(final String factoryInterface) Must be private so that user code can't call this entry point.
public boolean	Returns: true if this driver is active isActive() Return true if this driver is active.
public boolean	jdbcCompliant() Implements java.sql.Driver.jdbcCompliant. Reports whether this driver is a genuine JDBC Compliant driver.
public BrokeredConnection	Returns: a brokered connection newBrokeredConnection(BrokeredConnectionControl Control variable control) Return a new BrokeredConnection for this implementation.
public CallableStatement	Returns: a CallableStatement newEmbedCallableStatement(EmbedConnection Derby connection conn, String Statement text stmt, int Type of ResultSet resultSetType, int Concurrency setting resultSetConcurrency, int Holdability setting resultSetHoldability)
public DatabaseMetaData	Returns: a new java.sql.DatabaseMetaData instance for this implementation newEmbedDatabaseMetaData(EmbedConnection Derby connection conn, String Database name dbname) Return a new java.sql.DatabaseMetaData instance for this implementation.
public PreparedStatement	Returns: a PreparedStatement newEmbedPreparedStatement(EmbedConnection Derby connection conn, String Statement text stmt, boolean True if this is for metadata forMetaData, int Type of ResultSet resultSetType, int Concurrency setting resultSetConcurrency, int Holdability setting resultSetHoldability, int The autogenerated keys autoGeneratedKeys, int[] Column positions columnIndexes, String[] The column names columnNames)
public EmbedResultSet	Returns: a new java.sql.ResultSet newEmbedResultSet(EmbedConnection Owning connection conn, ResultSet Top level of language result set tree results, boolean Is this for meta-data forMetaData, EmbedStatement The statement that is creating the SQL ResultSet statement, boolean True if the ResultSet is atomic isAtomic) Return a new java.sql.ResultSet instance for this implementation.
public EmbedResultSetMetaData	Returns: ResultSet metadata newEmbedResultSetMetaData(ResultColumnDescriptor[] a ResultColumnDescriptor that stores information about the columns in a ResultSet columnInfo) Returns a new java.sql.ResultSetMetaData for this implementation
public Statement	newEmbedStatement(EmbedConnection conn, boolean forMetaData, int resultSetType, int resultSetConcurrency, int resultSetHoldability)
private SQLException	processException(Throwable t) Process exceptions raised while running a timed login.
public static void	setDeregister(boolean whether or not `AutoloadedDriver` should deregister itself deregister) Indicate to `AutoloadedDriver` whether it should deregister itself on shutdown.
public void	stop() Implements org.apache.derby.iapi.services.monitor.ModuleControl.stop. Stop the module.
private EmbedConnection	timeLogin(String url, Properties info, int loginTimeoutSeconds) Enforce the login timeout.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

_executorPool	back to summary
private static final ExecutorService _executorPool An executor service used for executing connection attempts when a login timeout has been specified. DERBY-6107: Core pool size and keep alive timeout should be zero so that no threads are cached. By creating a fresh thread each time a task is submitted, we make sure that the task will run in a thread with the same context class loader as the thread that submitted the task. This is important for example when connecting to a database using the classpath subsubprotocol, and the database lives in the context class loader. If threads are cached, a task may execute in a thread that has a different context class loader.

active	back to summary
protected boolean active

activeDriver	back to summary
private static InternalDriver activeDriver

authenticationService	back to summary
private AuthenticationService authenticationService

BOOLEAN_CHOICES	back to summary
private static final String[] BOOLEAN_CHOICES

contextServiceFactory	back to summary
private ContextService contextServiceFactory

deregister	back to summary
private static boolean deregister Tells whether or not `AutoloadedDriver` should deregister itself on shutdown. This flag is true unless the deregister attribute has been set to false by the user (DERBY-2905).

mbean	back to summary
private Object mbean

syncMe	back to summary
private static final Object syncMe

InternalDriver	back to summary
public InternalDriver()

Method Detail

acceptsURL back to summary

acceptsURL	back to summary
public boolean acceptsURL(String url) throws SQLException Implements java.sql.Driver.acceptsURL. Doc from java.sql.Driver.acceptsURL. Retrieves whether the driver thinks that it can open a connection to the given URL. Typically drivers will return `true` if they understand the sub-protocol specified in the URL and `false` if they do not. Parameters url:String the URL of the database Returns:boolean `true` if this driver understands the given URL; `false` otherwise Exceptions SQLException: if a database access error occurs or the url is `null`

public boolean acceptsURL(String url) throws SQLException

Implements java.sql.Driver.acceptsURL.

Doc from java.sql.Driver.acceptsURL.

Retrieves whether the driver thinks that it can open a connection to the given URL. Typically drivers will return true if they understand the sub-protocol specified in the URL and false if they do not.

Parameters

url:String: the URL of the database

Returns:boolean

true if this driver understands the given URL; false otherwise

Exceptions

SQLException:: if a database access error occurs or the url is null

activeDriver	back to summary
public static final InternalDriver activeDriver()

boot	back to summary
public void boot(boolean create, Properties properties) throws StandardException Implements org.apache.derby.iapi.services.monitor.ModuleControl.boot. Doc from org.apache.derby.iapi.services.monitor.ModuleControl.boot. 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. Parameters create:boolean True if the database should be created properties:Properties Configuration properties Exceptions StandardException: Module cannot be started.

boot

back to summary

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

Implements org.apache.derby.iapi.services.monitor.ModuleControl.boot.

Doc from org.apache.derby.iapi.services.monitor.ModuleControl.boot.

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.

Parameters

create:boolean: True if the database should be created
properties:Properties: Configuration properties

Exceptions

StandardException:: Module cannot be started.

checkBoolean	back to summary
private static void checkBoolean(Properties set, String attribute) throws SQLException

checkEnumeration	back to summary
private static void checkEnumeration(Properties set, String attribute, String[] choices) throws SQLException

checkShutdownPrivileges	back to summary
private void checkShutdownPrivileges(String user) throws SQLException Checks for shutdown System Privileges. This is a NOP now because we have removed support for the SecurityManager. To perform this check the following policy grant is required to run the encapsulated test: permission javax.security.auth.AuthPermission "doAsPrivileged"; or a SQLException will be raised detailing the cause. In addition, for the test to succeed the given user needs to be covered by a grant: principal org.apache.derby.authentication.SystemPrincipal "..." {} that lists a shutdown permission: permission org.apache.derby.shared.common.security.SystemPermission "shutdown"; or it will fail with a SQLException detailing the cause. Parameters user:String The user to be checked for shutdown privileges Exceptions SQLException: if the privileges check fails

checkShutdownPrivileges

back to summary

private void checkShutdownPrivileges(String user) throws SQLException

Checks for shutdown System Privileges. This is a NOP now because we have removed support for the SecurityManager. To perform this check the following policy grant is required

to run the encapsulated test: permission javax.security.auth.AuthPermission "doAsPrivileged";

or a SQLException will be raised detailing the cause.

In addition, for the test to succeed

the given user needs to be covered by a grant: principal org.apache.derby.authentication.SystemPrincipal "..." {}
that lists a shutdown permission: permission org.apache.derby.shared.common.security.SystemPermission "shutdown";

or it will fail with a SQLException detailing the cause.

Parameters

user:String: The user to be checked for shutdown privileges

Exceptions

SQLException:: if the privileges check fails

checkSystemPrivileges	back to summary
public void checkSystemPrivileges(String user, Permission perm) Checks for System Privileges. Parameters user:String The user to be checked for having the permission perm:Permission The permission to be checked

checkSystemPrivileges

back to summary

public void checkSystemPrivileges(String user, Permission perm)

Checks for System Privileges.

Parameters

user:String: The user to be checked for having the permission
perm:Permission: The permission to be checked

connect	back to summary
public Connection connect(String url, Properties info, int loginTimeoutSeconds) throws SQLException

connect back to summary

connect	back to summary
public Connection connect(String url, Properties info) throws SQLException Implements java.sql.Driver.connect. Doc from java.sql.Driver.connect. Attempts to make a database connection to the given URL. The driver should return "null" if it realizes it is the wrong kind of driver to connect to the given URL. This will be common, as when the JDBC driver manager is asked to connect to a given URL it passes the URL to each loaded driver in turn. The driver should throw an `SQLException` if it is the right driver to connect to the given URL but has trouble connecting to the database. The `Properties` argument can be used to pass arbitrary string tag/value pairs as connection arguments. Normally at least "user" and "password" properties should be included in the `Properties` object. Note If a property is specified as part of the `url` and is also specified in the `Properties` object, it is implementation-defined as to which value will take precedence. For maximum portability, an application should only specify a property once. Parameters url:String the URL of the database to which to connect info:Properties a list of arbitrary string tag/value pairs as connection arguments. Normally at least a "user" and "password" property should be included. Returns:Connection a `Connection` object that represents a connection to the URL Exceptions SQLException: if a database access error occurs or the url is `null`

public Connection connect(String url, Properties info) throws SQLException

Implements java.sql.Driver.connect.

Doc from java.sql.Driver.connect.

Attempts to make a database connection to the given URL. The driver should return "null" if it realizes it is the wrong kind of driver to connect to the given URL. This will be common, as when the JDBC driver manager is asked to connect to a given URL it passes the URL to each loaded driver in turn.

The driver should throw an SQLException if it is the right driver to connect to the given URL but has trouble connecting to the database.

The Properties argument can be used to pass arbitrary string tag/value pairs as connection arguments. Normally at least "user" and "password" properties should be included in the Properties object.

Note

If a property is specified as part of the url and is also specified in the Properties object, it is implementation-defined as to which value will take precedence. For maximum portability, an application should only specify a property once.

Parameters

url:String: the URL of the database to which to connect
info:Properties: a list of arbitrary string tag/value pairs as connection arguments. Normally at least a "user" and "password" property should be included.

Returns:Connection

a Connection object that represents a connection to the URL

Exceptions

SQLException:: if a database access error occurs or the url is null

embeddedDriverAcceptsURL	back to summary
public static boolean embeddedDriverAcceptsURL(String url) throws SQLException

findService	back to summary
private static Object findService(final String factoryInterface, final String serviceName) Must be private so that user code can't call this entry point.

getAttributes	back to summary
protected FormatableProperties getAttributes(String url, Properties info) throws SQLException Convert all the attributes in the url into properties and combine them with the set provided. If the caller passed in a set of attributes (info != null) then we set that up as the default of the returned property set as the user's set. This means we can easily break the link with the user's set, ensuring that we don't hang onto the users object. It also means that we don't add our attributes into the user's own property object. Parameters url:String The properties-bearing URL info:Properties Existing properties Returns:FormatableProperties a Derby properties object Exceptions SQLException: thrown if URL form bad

getAttributes

back to summary

protected FormatableProperties getAttributes(String url, Properties info) throws SQLException

Convert all the attributes in the url into properties and combine them with the set provided.
If the caller passed in a set of attributes (info != null) then we set that up as the default of the returned property set as the user's set. This means we can easily break the link with the user's set, ensuring that we don't hang onto the users object. It also means that we don't add our attributes into the user's own property object.

Parameters

url:String: The properties-bearing URL
info:Properties: Existing properties

Returns:FormatableProperties

a Derby properties object

Exceptions

SQLException:: thrown if URL form bad

getAuthenticationService	back to summary
public AuthenticationService getAuthenticationService()

getConnectionContext	back to summary
private ConnectionContext getConnectionContext()

getContextService	back to summary
private static ContextService getContextService() Must be private so that user code can't call this entry point.

getContextServiceFactory	back to summary
public final ContextService getContextServiceFactory()

getCurrentContextManager	back to summary
private ContextManager getCurrentContextManager()

getDatabaseName	back to summary
public static String getDatabaseName(String url, Properties info) Get the database name from the url. Copes with three forms jdbc:derby:dbname jdbc:derby:dbname;... jdbc:derby:;subname=dbname Parameters url:String The url being used for the connection info:Properties The properties set being used for the connection, must include the properties derived from the attributes in the url Returns:String a String containing the database name or an empty string ("") if no database name is present in the URL.

getDatabaseName

back to summary

public static String getDatabaseName(String url, Properties info)

Get the database name from the url. Copes with three forms jdbc:derby:dbname jdbc:derby:dbname;... jdbc:derby:;subname=dbname

Parameters

url:String: The url being used for the connection
info:Properties: The properties set being used for the connection, must include the properties derived from the attributes in the url

Returns:String

a String containing the database name or an empty string ("") if no database name is present in the URL.

getDeregister back to summary

getDeregister	back to summary
public static boolean getDeregister() Check whether `AutoloadedDriver` should deregister itself on shutdown. Returns:boolean the deregister value

public static boolean getDeregister()

Check whether AutoloadedDriver should deregister itself on shutdown.

Returns:boolean: the deregister value

getMajorVersion	back to summary
public int getMajorVersion() Implements java.sql.Driver.getMajorVersion. Doc from java.sql.Driver.getMajorVersion. Retrieves the driver's major version number. Initially this should be 1. Returns:int this driver's major version number

getMajorVersion

back to summary

public int getMajorVersion()

Implements java.sql.Driver.getMajorVersion.

Doc from java.sql.Driver.getMajorVersion.

Retrieves the driver's major version number. Initially this should be 1.

Returns:int: this driver's major version number

getMinorVersion	back to summary
public int getMinorVersion() Implements java.sql.Driver.getMinorVersion. Doc from java.sql.Driver.getMinorVersion. Gets the driver's minor version number. Initially this should be 0. Returns:int this driver's minor version number

getMinorVersion

back to summary

public int getMinorVersion()

Implements java.sql.Driver.getMinorVersion.

Doc from java.sql.Driver.getMinorVersion.

Gets the driver's minor version number. Initially this should be 0.

Returns:int: this driver's minor version number

getMonitor	back to summary
private static ModuleFactory getMonitor() Must be private so that user code can't call this entry point.

getNewEmbedConnection	back to summary
pack-priv EmbedConnection getNewEmbedConnection(final String url, final Properties info) throws SQLException

getNewNestedConnection	back to summary
public Connection getNewNestedConnection(EmbedConnection conn) Get a new nested connection. Parameters conn:EmbedConnection The EmbedConnection. Returns:Connection A nested connection object.

getNewNestedConnection

back to summary

public Connection getNewNestedConnection(EmbedConnection conn)

Get a new nested connection.

Parameters

conn:EmbedConnection: The EmbedConnection.

Returns:Connection

A nested connection object.

getParentLogger back to summary

getParentLogger	back to summary
public Logger getParentLogger() throws SQLFeatureNotSupportedException Implements java.sql.Driver.getParentLogger. Doc from java.sql.Driver.getParentLogger. Return the parent Logger of all the Loggers used by this driver. This should be the Logger farthest from the root Logger that is still an ancestor of all of the Loggers used by this driver. Configuring this Logger will affect all of the log messages generated by the driver. In the worst case, this may be the root Logger. Returns:Logger the parent Logger for this driver Exceptions SQLFeatureNotSupportedException: if the driver does not use `java.util.logging`.

public Logger getParentLogger() throws SQLFeatureNotSupportedException

Implements java.sql.Driver.getParentLogger.

Doc from java.sql.Driver.getParentLogger.

Return the parent Logger of all the Loggers used by this driver. This should be the Logger farthest from the root Logger that is still an ancestor of all of the Loggers used by this driver. Configuring this Logger will affect all of the log messages generated by the driver. In the worst case, this may be the root Logger.

Returns:Logger

the parent Logger for this driver

Exceptions

SQLFeatureNotSupportedException:: if the driver does not use java.util.logging.

getPropertyInfo	back to summary
public DriverPropertyInfo[] getPropertyInfo(String url, Properties info) throws SQLException Implements java.sql.Driver.getPropertyInfo. 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. Parameters url:String The URL of the database to connect to. info:Properties A proposed list of tag/value pairs that will be sent on connect open. Returns:DriverPropertyInfo[] An array of DriverPropertyInfo objects describing possible properties. This array may be an empty array if no properties are required. Exceptions SQLException: if a database-access error occurs.

getPropertyInfo

back to summary

public DriverPropertyInfo[] getPropertyInfo(String url, Properties info) throws SQLException

Implements java.sql.Driver.getPropertyInfo.

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.

Parameters

url:String: The URL of the database to connect to.
info:Properties: A proposed list of tag/value pairs that will be sent on connect open.

Returns:DriverPropertyInfo[]

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

Exceptions

SQLException:: if a database-access error occurs.

getSystemModule	back to summary
private static Object getSystemModule(final String factoryInterface) Must be private so that user code can't call this entry point.

isActive	back to summary
public boolean isActive() Return true if this driver is active. Package private method. Returns:boolean true if this driver is active

isActive

back to summary

public boolean isActive()

Return true if this driver is active. Package private method.

Returns:boolean: true if this driver is active

jdbcCompliant back to summary

jdbcCompliant	back to summary
public boolean jdbcCompliant() Implements java.sql.Driver.jdbcCompliant. Doc from java.sql.Driver.jdbcCompliant. Reports whether this driver is a genuine JDBC Compliant driver. A driver may only report `true` here if it passes the JDBC compliance tests; otherwise it is required to return `false`. JDBC compliance requires full support for the JDBC API and full support for SQL 92 Entry Level. It is expected that JDBC compliant drivers will be available for all the major commercial databases. This method is not intended to encourage the development of non-JDBC compliant drivers, but is a recognition of the fact that some vendors are interested in using the JDBC API and framework for lightweight databases that do not support full database functionality, or for special databases such as document information retrieval where a SQL implementation may not be feasible. Returns:boolean `true` if this driver is JDBC Compliant; `false` otherwise

public boolean jdbcCompliant()

Implements java.sql.Driver.jdbcCompliant.

Doc from java.sql.Driver.jdbcCompliant.

Reports whether this driver is a genuine JDBC Compliant driver. A driver may only report true here if it passes the JDBC compliance tests; otherwise it is required to return false.

JDBC compliance requires full support for the JDBC API and full support for SQL 92 Entry Level. It is expected that JDBC compliant drivers will be available for all the major commercial databases.

This method is not intended to encourage the development of non-JDBC compliant drivers, but is a recognition of the fact that some vendors are interested in using the JDBC API and framework for lightweight databases that do not support full database functionality, or for special databases such as document information retrieval where a SQL implementation may not be feasible.

Returns:boolean: true if this driver is JDBC Compliant; false otherwise

newBrokeredConnection	back to summary
public BrokeredConnection newBrokeredConnection(BrokeredConnectionControl control) throws SQLException Return a new BrokeredConnection for this implementation. Parameters control:BrokeredConnectionControl Control variable Returns:BrokeredConnection a brokered connection Exceptions SQLException: on error

newBrokeredConnection

back to summary

public BrokeredConnection newBrokeredConnection(BrokeredConnectionControl control) throws SQLException

Return a new BrokeredConnection for this implementation.

Parameters

control:BrokeredConnectionControl: Control variable

Returns:BrokeredConnection

a brokered connection

Exceptions

SQLException:: on error

newEmbedCallableStatement	back to summary
public CallableStatement newEmbedCallableStatement(EmbedConnection conn, String stmt, int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws SQLException Parameters conn:EmbedConnection Derby connection stmt:String Statement text resultSetType:int Type of ResultSet resultSetConcurrency:int Concurrency setting resultSetHoldability:int Holdability setting Returns:CallableStatement a CallableStatement Exceptions SQLException: if fails to create statement

newEmbedCallableStatement

back to summary

public CallableStatement newEmbedCallableStatement(EmbedConnection conn, String stmt, int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws SQLException

Parameters

conn:EmbedConnection: Derby connection
stmt:String: Statement text
resultSetType:int: Type of ResultSet
resultSetConcurrency:int: Concurrency setting
resultSetHoldability:int: Holdability setting

Returns:CallableStatement

a CallableStatement

Exceptions

SQLException:: if fails to create statement

newEmbedDatabaseMetaData

back to summary

public DatabaseMetaData newEmbedDatabaseMetaData(EmbedConnection conn, String dbname) throws SQLException

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

Parameters

conn:EmbedConnection: Derby connection
dbname:String: Database name

Returns:DatabaseMetaData

a new java.sql.DatabaseMetaData instance for this implementation

Exceptions

SQLException:: on failure to create.

newEmbedPreparedStatement	back to summary
public PreparedStatement newEmbedPreparedStatement(EmbedConnection conn, String stmt, boolean forMetaData, int resultSetType, int resultSetConcurrency, int resultSetHoldability, int autoGeneratedKeys, int[] columnIndexes, String[] columnNames) throws SQLException Parameters conn:EmbedConnection Derby connection stmt:String Statement text forMetaData:boolean True if this is for metadata resultSetType:int Type of ResultSet resultSetConcurrency:int Concurrency setting resultSetHoldability:int Holdability setting autoGeneratedKeys:int The autogenerated keys columnIndexes:int[] Column positions columnNames:String[] The column names Returns:PreparedStatement a PreparedStatement Exceptions SQLException: if fails to create statement

newEmbedPreparedStatement

back to summary

public PreparedStatement newEmbedPreparedStatement(EmbedConnection conn, String stmt, boolean forMetaData, int resultSetType, int resultSetConcurrency, int resultSetHoldability, int autoGeneratedKeys, int[] columnIndexes, String[] columnNames) throws SQLException

Parameters

conn:EmbedConnection: Derby connection
stmt:String: Statement text
forMetaData:boolean: True if this is for metadata
resultSetType:int: Type of ResultSet
resultSetConcurrency:int: Concurrency setting
resultSetHoldability:int: Holdability setting
autoGeneratedKeys:int: The autogenerated keys
columnIndexes:int[]: Column positions
columnNames:String[]: The column names

Returns:PreparedStatement

a PreparedStatement

Exceptions

SQLException:: if fails to create statement

newEmbedResultSet	back to summary
public EmbedResultSet newEmbedResultSet(EmbedConnection conn, ResultSet results, boolean forMetaData, EmbedStatement statement, boolean isAtomic) throws SQLException Return a new java.sql.ResultSet instance for this implementation. Parameters conn:EmbedConnection Owning connection results:ResultSet Top level of language result set tree forMetaData:boolean Is this for meta-data statement:EmbedStatement The statement that is creating the SQL ResultSet isAtomic:boolean True if the ResultSet is atomic Returns:EmbedResultSet a new java.sql.ResultSet Exceptions SQLException: on error

newEmbedResultSet

back to summary

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

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

Parameters

conn:EmbedConnection: Owning connection
results:ResultSet: Top level of language result set tree
forMetaData:boolean: Is this for meta-data
statement:EmbedStatement: The statement that is creating the SQL ResultSet
isAtomic:boolean: True if the ResultSet is atomic

Returns:EmbedResultSet

a new java.sql.ResultSet

Exceptions

SQLException:: on error

newEmbedResultSetMetaData

back to summary

public EmbedResultSetMetaData newEmbedResultSetMetaData(ResultColumnDescriptor[] columnInfo)

Returns a new java.sql.ResultSetMetaData for this implementation

Parameters

columnInfo:ResultColumnDescriptor[]: a ResultColumnDescriptor that stores information about the columns in a ResultSet

Returns:EmbedResultSetMetaData

ResultSet metadata

newEmbedStatement	back to summary
public Statement newEmbedStatement(EmbedConnection conn, boolean forMetaData, int resultSetType, int resultSetConcurrency, int resultSetHoldability)

processException	back to summary
private SQLException processException(Throwable t) Process exceptions raised while running a timed login.

setDeregister back to summary

public static void setDeregister(boolean deregister)

Indicate to AutoloadedDriver whether it should deregister itself on shutdown.

Parameters

deregister:boolean: whether or not AutoloadedDriver should deregister itself

stop

back to summary

public void stop()

Implements org.apache.derby.iapi.services.monitor.ModuleControl.stop.

Doc from org.apache.derby.iapi.services.monitor.ModuleControl.stop.

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.

timeLogin	back to summary
private EmbedConnection timeLogin(String url, Properties info, int loginTimeoutSeconds) throws SQLException Enforce the login timeout.

Modifier and Type	Field and Description
private InternalDriver	_driver
private Properties	_info
private String	_url

public Class InternalDriver

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class InternalDriver.DaemonThreadFactory

Constructor Summary

Method Summary

Constructor Detail

Method Detail

public final Class InternalDriver.LoginCallable

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail