Apache Derby Client JDBC Driver 10.17.1.0 · org.apache.derby.client.ClientAutoloadedDriver

Modifier and Type	Field and Description
private static final int	DERBY_REMOTE_PROTOCOL
private static SQLException	exceptionsOnLoadDriver__
private static ClientJDBCObjectFactory	factoryObject
private static ClientAutoloadedDriver	registeredDriver__
private transient int	traceFileSuffixIndex_

Access	Constructor and Description
public	ClientAutoloadedDriver()

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.
private String	Returns: databaseName + attributes (e.g. mydb;create=true) appendDatabaseAttributes(String - Short database name database, Properties - Set of properties to append as attributes augmentedProperties) Append attributes to the database name except for user/password which are sent as part of the protocol, and SSL which is used locally in the client.
private void	checkURLNotNull(String url)
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. properties) Implements java.sql.Driver.connect. Attempts to make a database connection to the given URL.
private static ClientJDBCObjectFactory	createDefaultFactoryImpl() Returns an instance of the ClientJDBCObjectFactoryImpl class
private static ClientJDBCObjectFactory	createJDBC40FactoryImpl() Returns an instance of the ClientJDBCObjectFactoryImpl40 class If a ClassNotFoundException occurs then it returns an instance of ClientJDBCObjectFactoryImpl If a future version of JDBC comes then a similar method would be added say createJDBCXXFactoryImpl in which if the class is not found then it would return the lower version thus having a sort of cascading effect until it gets a valid instance
private static ClientJDBCObjectFactory	createJDBC42FactoryImpl() Returns an instance of the ClientJDBCObjectFactoryImpl42 class If a ClassNotFoundException occurs then it returns an instance of the most refined ClientJDBCObjectFactoryImpl possible If a future version of JDBC comes then a similar method would be added say createJDBCXXFactoryImpl in which if the class is not found then it would return the lower version thus having a sort of cascading effect until it gets a valid instance
public static ClientJDBCObjectFactory	Returns: the client-side object factory getFactory() This method returns an Implementation of ClientJDBCObjectFactory depending on VM under use Currently it returns either ClientJDBCObjectFactoryImpl (or) ClientJDBCObjectFactoryImpl42
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.
public Logger	getParentLogger() Implements java.sql.Driver.getParentLogger. Return the parent Logger of all the Loggers used by this driver.
public DriverPropertyInfo[]	getPropertyInfo(String the URL of the database to which to connect url, Properties a proposed list of tag/value pairs that will be sent on connect open properties) Implements java.sql.Driver.getPropertyInfo. Gets information about the possible properties for this driver.
public boolean	jdbcCompliant() Implements java.sql.Driver.jdbcCompliant. Reports whether this driver is a genuine JDBC Compliant driver.
protected static void	registerMe(ClientAutoloadedDriver me)
private static String	tokenizeDatabase(StringTokenizer urlTokenizer, String url)
private static int	tokenizeOptionalPortNumber(StringTokenizer urlTokenizer, String url)
private static int	tokenizeProtocol(String url, StringTokenizer urlTokenizer)
private static String	tokenizeServerName(StringTokenizer urlTokenizer, String url)
private static Properties	tokenizeURLProperties(String url, Properties properties)

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

DERBY_REMOTE_PROTOCOL	back to summary
private static final int DERBY_REMOTE_PROTOCOL

exceptionsOnLoadDriver__	back to summary
private static SQLException exceptionsOnLoadDriver__

factoryObject	back to summary
private static ClientJDBCObjectFactory factoryObject

registeredDriver__	back to summary
private static ClientAutoloadedDriver registeredDriver__

traceFileSuffixIndex_	back to summary
private transient int traceFileSuffixIndex_

ClientAutoloadedDriver	back to summary
public ClientAutoloadedDriver()

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

appendDatabaseAttributes	back to summary
private String appendDatabaseAttributes(String database, Properties augmentedProperties) Append attributes to the database name except for user/password which are sent as part of the protocol, and SSL which is used locally in the client. Other attributes will be sent to the server with the database name Assumes augmentedProperties is not null Parameters database:String - Short database name augmentedProperties:Properties - Set of properties to append as attributes Returns:String databaseName + attributes (e.g. mydb;create=true)

appendDatabaseAttributes

back to summary

private String appendDatabaseAttributes(String database, Properties augmentedProperties)

Append attributes to the database name except for user/password which are sent as part of the protocol, and SSL which is used locally in the client. Other attributes will be sent to the server with the database name Assumes augmentedProperties is not null

Parameters

database:String: - Short database name
augmentedProperties:Properties: - Set of properties to append as attributes

Returns:String

databaseName + attributes (e.g. mydb;create=true)

checkURLNotNull	back to summary
private void checkURLNotNull(String url) throws SQLException

connect back to summary

connect	back to summary
public Connection connect(String url, Properties properties) 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 properties: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 properties) 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
properties: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

createDefaultFactoryImpl	back to summary
private static ClientJDBCObjectFactory createDefaultFactoryImpl() Returns an instance of the ClientJDBCObjectFactoryImpl class

createJDBC40FactoryImpl	back to summary
private static ClientJDBCObjectFactory createJDBC40FactoryImpl() Returns an instance of the ClientJDBCObjectFactoryImpl40 class If a ClassNotFoundException occurs then it returns an instance of ClientJDBCObjectFactoryImpl If a future version of JDBC comes then a similar method would be added say createJDBCXXFactoryImpl in which if the class is not found then it would return the lower version thus having a sort of cascading effect until it gets a valid instance

createJDBC40FactoryImpl

back to summary

private static ClientJDBCObjectFactory createJDBC40FactoryImpl()

Returns an instance of the ClientJDBCObjectFactoryImpl40 class If a ClassNotFoundException occurs then it returns an instance of ClientJDBCObjectFactoryImpl If a future version of JDBC comes then a similar method would be added say createJDBCXXFactoryImpl in which if the class is not found then it would return the lower version thus having a sort of cascading effect until it gets a valid instance

createJDBC42FactoryImpl	back to summary
private static ClientJDBCObjectFactory createJDBC42FactoryImpl() Returns an instance of the ClientJDBCObjectFactoryImpl42 class If a ClassNotFoundException occurs then it returns an instance of the most refined ClientJDBCObjectFactoryImpl possible If a future version of JDBC comes then a similar method would be added say createJDBCXXFactoryImpl in which if the class is not found then it would return the lower version thus having a sort of cascading effect until it gets a valid instance

createJDBC42FactoryImpl

back to summary

private static ClientJDBCObjectFactory createJDBC42FactoryImpl()

Returns an instance of the ClientJDBCObjectFactoryImpl42 class If a ClassNotFoundException occurs then it returns an instance of the most refined ClientJDBCObjectFactoryImpl possible If a future version of JDBC comes then a similar method would be added say createJDBCXXFactoryImpl in which if the class is not found then it would return the lower version thus having a sort of cascading effect until it gets a valid instance

getFactory	back to summary
public static ClientJDBCObjectFactory getFactory() This method returns an Implementation of ClientJDBCObjectFactory depending on VM under use Currently it returns either ClientJDBCObjectFactoryImpl (or) ClientJDBCObjectFactoryImpl42 Returns:ClientJDBCObjectFactory the client-side object factory

getFactory

back to summary

public static ClientJDBCObjectFactory getFactory()

This method returns an Implementation of ClientJDBCObjectFactory depending on VM under use Currently it returns either ClientJDBCObjectFactoryImpl (or) ClientJDBCObjectFactoryImpl42

Returns:ClientJDBCObjectFactory: the client-side object factory

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

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

getPropertyInfo	back to summary
public DriverPropertyInfo[] getPropertyInfo(String url, Properties properties) throws SQLException Implements java.sql.Driver.getPropertyInfo. Doc from java.sql.Driver.getPropertyInfo. Gets information about the possible properties for this driver. 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 the `getPropertyInfo` method. Parameters url:String the URL of the database to which to connect properties: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

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

Implements java.sql.Driver.getPropertyInfo.

Doc from java.sql.Driver.getPropertyInfo.

Gets information about the possible properties for this driver.

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 the getPropertyInfo method.

Parameters

url:String: the URL of the database to which to connect
properties: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

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

registerMe	back to summary
protected static void registerMe(ClientAutoloadedDriver me)

tokenizeDatabase	back to summary
private static String tokenizeDatabase(StringTokenizer urlTokenizer, String url) throws SqlException

tokenizeOptionalPortNumber	back to summary
private static int tokenizeOptionalPortNumber(StringTokenizer urlTokenizer, String url) throws SqlException

tokenizeProtocol	back to summary
private static int tokenizeProtocol(String url, StringTokenizer urlTokenizer) throws SqlException

tokenizeServerName	back to summary
private static String tokenizeServerName(StringTokenizer urlTokenizer, String url) throws SqlException

tokenizeURLProperties	back to summary
private static Properties tokenizeURLProperties(String url, Properties properties) throws SqlException

public Class ClientAutoloadedDriver

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail