com.couchbase

Class CBDriver

java.lang.Object

com.couchbase.CBDriver

All Implemented Interfaces:

Driver

public class CBDriver
extends Object
implements Driver

Field Summary

Fields

Modifier and Type	Field and Description
static String	DRIVER_NAME
static org.slf4j.Logger	logger
static int	MAJOR_VERSION
static int	MINOR_VERSION

Constructor Summary

Constructors

Constructor and Description
CBDriver()

Method Summary

Modifier and Type	Method and Description
boolean	acceptsURL(String url) Retrieves whether the driver thinks that it can open a connection to the given URL.
static void	cleanup()
void	cleanup(CBConnection con)
Connection	connect(String url, Properties info) Attempts to make a database connection to the given URL.
static ch.qos.logback.classic.Level	getLogLevel()
int	getMajorVersion() Retrieves the driver's major version number.
int	getMinorVersion() Gets the driver's minor version number.
Logger	getParentLogger() Return the parent Logger of all the Loggers used by this driver.
DriverPropertyInfo[]	getPropertyInfo(String url, Properties info) Gets information about the possible properties for this driver.
boolean	jdbcCompliant() Reports whether this driver is a genuine JDBC Compliant(TM) driver.
static SQLFeatureNotSupportedException	notImplemented(Class callClass, String functionName)
static void	setLogLevel(ch.qos.logback.classic.Level logLevel)

Methods inherited from class java.lang.Object

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

Field Detail

logger

public static final org.slf4j.Logger logger

MAJOR_VERSION

public static final int MAJOR_VERSION

See Also:

Constant Field Values

MINOR_VERSION

public static final int MINOR_VERSION

See Also:

Constant Field Values

DRIVER_NAME

public static final String DRIVER_NAME

See Also:

Constant Field Values

Constructor Detail

CBDriver

public CBDriver()
         throws SQLException

Throws:

SQLException

Method Detail

connect

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

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 java.util.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.

Specified by:

connect in interface Driver

Parameters:

url - the URL of the database to which to connect

info - a list of arbitrary string tag/value pairs as connection arguments. Normally at least a "user" and "password" property should be included.

Returns:

a Connection object that represents a connection to the URL

Throws:

SQLException - if a database access error occurs

acceptsURL

public boolean acceptsURL(String url)
                   throws SQLException

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

Specified by:

acceptsURL in interface Driver

Parameters:

url - the URL of the database

Returns:

true if this driver understands the given URL; false otherwise

Throws:

SQLException - if a database access error occurs

getPropertyInfo

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

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.

Specified by:

getPropertyInfo in interface Driver

Parameters:

url - the URL of the database to which to connect

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:

SQLException - if a database access error occurs

getMajorVersion

public int getMajorVersion()

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

Specified by:

getMajorVersion in interface Driver

Returns:

this driver's major version number

getMinorVersion

public int getMinorVersion()

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

Specified by:

getMinorVersion in interface Driver

Returns:

this driver's minor version number

jdbcCompliant

public boolean jdbcCompliant()

Reports whether this driver is a genuine JDBC Compliant(TM) 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.

Specified by:

jdbcCompliant in interface Driver

Returns:

true if this driver is JDBC Compliant; false otherwise

notImplemented

public static SQLFeatureNotSupportedException notImplemented(Class callClass,
                                                             String functionName)

setLogLevel

public static void setLogLevel(ch.qos.logback.classic.Level logLevel)

getLogLevel

public static ch.qos.logback.classic.Level getLogLevel()

getParentLogger

public Logger getParentLogger()
                       throws SQLFeatureNotSupportedException

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.

Specified by:

getParentLogger in interface Driver

Returns:

the parent Logger for this driver

Throws:

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

Since:

1.7

cleanup

public static void cleanup()

cleanup

public void cleanup(CBConnection con)