org.awakefw.sql.api.client
Class AwakeDriver

java.lang.Object
  org.awakefw.sql.api.client.AwakeDriver

All Implemented Interfaces:

Driver

public class AwakeDriver
extends Object
implements Driver

The Awake SQL Driver class in order to access remote SQL databases through HTTP. - Note that The preferred way to connect to a remote database is AwakeConnection.

The Driver implementation is provided because it's necessary for usage with third party programs as SQL client front end (SQuirreL, Netbeans IDE, etc.)

user & password are the only required properties.

Properties:

• user: Username to connect to the remote database as.
• password: Password to use when authenticating.
• httpProxyAddress: Http proxy address to use.
• httpProxyPort: Http proxy Port to use.
• httpProxyUsername: Http proxy credential username.
• httpProxyPassword: Http proxy credential password.
• httpProxyWorkstation: For NTLM proxy: the workstation.
• httpProxyDomain: For NTLM proxy: the domain.
• maxLengthForString: Int for the maximum authorized length for a string for upload or download Should be <= 2097152 (2Mb). Defaults to 2097152.
• uploadBufferSize: Int for the buffer size when uploading a Blob/Clob. Defaults to 20480 (20 Kb).
• downloadBufferSize: Int for the buffer size when downloading a Blob/Clob. Defaults to 20480 (20 Kb).
• acceptAllSslCertificates: Boolean to say if client sides allows HTTPS call with all SSL Certificates, including "invalid" or self-signed Certificates.
• encryptionPassword: The password to use to encrypt all request parameter names and values. Defaults to null.
• htmlEncodingOn: Boolean to say if the upload/download of Clob using character stream or ASCII stream must be html encoded.

You may also pass any Jakarta HttpClient parameter as with HttpProtocolParameters:

• The name of the HttpClient parameter must be in the format: 'http-client-<name>'.
• The value of HttpClient parameter:
  • The String value for String parameters
  • The String: '[value.getClass().ClassName(), value.toString()]' for parameters of other Java type.

Examples:

• To pass a 'http.socket.timeout' of 10 seconds, pass the following property:
  • property name: 'http-client-http.socket.timeout'.
  • property value: '[java.lang.Integer, 10000]'.
• To pass a 'http.useragent' of 'www.acme.org User-Agent', pass the following property:
  • property name: 'http-client-http.useragent'.
  • property value: 'www.acme.org User-Agent'.

Since:

1.0

Constructor Summary

AwakeDriver()
Constructor.

Method Summary

boolean	acceptsURL(String url) Retrieves whether the driver thinks that it can open a connection to the given URL.
Connection	connect(String url, Properties info) Attempts to make a database connection to the given URL.
int	getMajorVersion() Retrieves this 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 CompliantTM driver.

Methods inherited from class java.lang.Object

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

Constructor Detail

AwakeDriver

public AwakeDriver()

Constructor.

Method Detail

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.

Awake driver requires an URL which is an http url in the format:
http(s)://<server-name:port>/<Awake SQL Servlet path>

Example:
http://www.acme.com/AwakeSqlManager

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

connect

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

Attempts to make a database connection to the given URL. The Awake driver will return "null" if it realizes it is the wrong kind of driver to connect to the given URL. acceptsURL(java.lang.String) will return null.

The Awake driver will throwSQLException 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. 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. 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

getMajorVersion

public int getMajorVersion()

Retrieves this driver's major version number.

Specified by:

getMajorVersion in interface Driver

Returns:

this driver's major version number

getMinorVersion

public int getMinorVersion()

Gets the driver's minor version number.

Specified by:

getMinorVersion in interface Driver

Returns:

this driver's minor version number

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.

Returns:

the parent Logger for this driver

Throws:

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

Since:

1.7

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.

Throws:

SQLException - if a database access error occurs

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.

Because Awake driver is not a a genuine JDBC Compliant^TM driver, method returns false

Specified by:

jdbcCompliant in interface Driver

Returns:

false