com.couchbase.jdbc.CBConnection Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jdbc-n1ql Show documentation
Show all versions of jdbc-n1ql Show documentation
A JDBC driver for the Couchbase database, based on the N1QL query language.
/*
* // Copyright (c) 2015 Couchbase, Inc.
* // Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
* // except in compliance with the License. You may obtain a copy of the License at
* // http://www.apache.org/licenses/LICENSE-2.0
* // Unless required by applicable law or agreed to in writing, software distributed under the
* // License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
* // either express or implied. See the License for the specific language governing permissions
* // and limitations under the License.
*/
package com.couchbase.jdbc;
import com.couchbase.jdbc.connect.Protocol;
import com.couchbase.jdbc.core.ProtocolImpl;
import com.couchbase.jdbc.core.SqlJsonImplementation;
import com.couchbase.json.SQLJSON;
import org.apache.http.NameValuePair;
import org.apache.http.client.utils.URLEncodedUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.net.URI;
import java.sql.*;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import java.util.concurrent.Executor;
import java.util.concurrent.atomic.AtomicBoolean;
/**
* Created by davec on 2015-02-20.
*/
public class CBConnection implements java.sql.Connection
{
private static final Logger logger = LoggerFactory.getLogger(CBConnection.class);
private AtomicBoolean connected = new AtomicBoolean(false);
Protocol protocol;
private static final String HTTP = "http";
private static final String HTTPS = "https";
boolean readOnly=false;
public CBConnection(String url, Properties props) throws SQLException
{
try
{
String connectionURL;
if (props.containsKey(ConnectionParameters.ENABLE_SSL) && props.getProperty(ConnectionParameters.ENABLE_SSL).equals("true"))
{
logger.trace("Enabling SSL connection");
connectionURL = HTTPS + url.substring(14) ;
}
else
{
logger.trace("Normal http connection");
connectionURL = HTTP + url.substring(14);
}
List parameters = URLEncodedUtils.parse(new URI(connectionURL),"UTF-8");
for(NameValuePair param:parameters)
{
props.put(param.getName(),param.getValue());
}
protocol = new ProtocolImpl(connectionURL, props);
protocol.connect();
connected.set(true);
}
catch (Exception ex)
{
logger.error("Error opening connection for {} exception {}", url, ex.getMessage());
throw new SQLException("Error opening connection", ex.getCause());
}
}
public String getURL() throws SQLException
{
checkClosed();
return protocol.getURL();
}
public String getUserName() throws SQLException
{
checkClosed();
return protocol.getUserName();
}
public String getPassword() throws SQLException
{
checkClosed();
return protocol.getPassword();
}
/**
* Creates a Statement object for sending
* SQL statements to the database.
* SQL statements without parameters are normally
* executed using Statement objects. If the same SQL statement
* is executed many times, it may be more efficient to use a
* PreparedStatement object.
*
* Result sets created using the returned Statement
* object will by default be type TYPE_FORWARD_ONLY
* and have a concurrency level of CONCUR_READ_ONLY.
* The holdability of the created result sets can be determined by
* calling {@link #getHoldability}.
*
* @return a new default Statement object
* @throws java.sql.SQLException if a database access error occurs
* or this method is called on a closed connection
*/
@Override
public Statement createStatement() throws SQLException
{
checkClosed();
return new CBStatement(this, protocol);
}
/**
* Creates a PreparedStatement object for sending
* parameterized SQL statements to the database.
*
* A SQL statement with or without IN parameters can be
* pre-compiled and stored in a PreparedStatement object. This
* object can then be used to efficiently execute this statement
* multiple times.
*
* Note: This method is optimized for handling
* parametric SQL statements that benefit from precompilation. If
* the driver supports precompilation,
* the method prepareStatement will send
* the statement to the database for precompilation. Some drivers
* may not support precompilation. In this case, the statement may
* not be sent to the database until the PreparedStatement
* object is executed. This has no direct effect on users; however, it does
* affect which methods throw certain SQLException objects.
*
* Result sets created using the returned PreparedStatement
* object will by default be type TYPE_FORWARD_ONLY
* and have a concurrency level of CONCUR_READ_ONLY.
* The holdability of the created result sets can be determined by
* calling {@link #getHoldability}.
*
* @param sql an SQL statement that may contain one or more '?' IN
* parameter placeholders
* @return a new default PreparedStatement object containing the
* pre-compiled SQL statement
* @throws java.sql.SQLException if a database access error occurs
* or this method is called on a closed connection
*/
@Override
public PreparedStatement prepareStatement(String sql) throws SQLException
{
checkClosed();
return new CBPreparedStatement(this, protocol, sql);
}
/**
* Creates a CallableStatement object for calling
* database stored procedures.
* The CallableStatement object provides
* methods for setting up its IN and OUT parameters, and
* methods for executing the call to a stored procedure.
*
* Note: This method is optimized for handling stored
* procedure call statements. Some drivers may send the call
* statement to the database when the method prepareCall
* is done; others
* may wait until the CallableStatement object
* is executed. This has no
* direct effect on users; however, it does affect which method
* throws certain SQLExceptions.
*
* Result sets created using the returned CallableStatement
* object will by default be type TYPE_FORWARD_ONLY
* and have a concurrency level of CONCUR_READ_ONLY.
* The holdability of the created result sets can be determined by
* calling {@link #getHoldability}.
*
* @param sql an SQL statement that may contain one or more '?'
* parameter placeholders. Typically this statement is specified using JDBC
* call escape syntax.
* @return a new default CallableStatement object containing the
* pre-compiled SQL statement
* @throws java.sql.SQLException if a database access error occurs
* or this method is called on a closed connection
*/
@Override
public CallableStatement prepareCall(String sql) throws SQLException
{
checkClosed();
throw CBDriver.notImplemented(CBConnection.class, "prepreCall");
}
/**
* Converts the given SQL statement into the system's native SQL grammar.
* A driver may convert the JDBC SQL grammar into its system's
* native SQL grammar prior to sending it. This method returns the
* native form of the statement that the driver would have sent.
*
* @param sql an SQL statement that may contain one or more '?'
* parameter placeholders
* @return the native form of this statement
* @throws java.sql.SQLException if a database access error occurs
* or this method is called on a closed connection
*/
@Override
public String nativeSQL(String sql) throws SQLException
{
checkClosed();
//todo after we implement escape we should escape this
return sql;
}
/**
* Sets this connection's auto-commit mode to the given state.
* If a connection is in auto-commit mode, then all its SQL
* statements will be executed and committed as individual
* transactions. Otherwise, its SQL statements are grouped into
* transactions that are terminated by a call to either
* the method commit or the method rollback.
* By default, new connections are in auto-commit
* mode.
*
* The commit occurs when the statement completes. The time when the statement
* completes depends on the type of SQL Statement:
*
* - For DML statements, such as Insert, Update or Delete, and DDL statements,
* the statement is complete as soon as it has finished executing.
*
- For Select statements, the statement is complete when the associated result
* set is closed.
*
- For
CallableStatement objects or for statements that return
* multiple results, the statement is complete
* when all of the associated result sets have been closed, and all update
* counts and output parameters have been retrieved.
*
*
* NOTE: If this method is called during a transaction and the
* auto-commit mode is changed, the transaction is committed. If
* setAutoCommit is called and the auto-commit mode is
* not changed, the call is a no-op.
*
* @param autoCommit true to enable auto-commit mode;
* false to disable it
* @throws java.sql.SQLException if a database access error occurs,
* setAutoCommit(true) is called while participating in a distributed transaction,
* or this method is called on a closed connection
* @see #getAutoCommit
*/
@Override
public void setAutoCommit(boolean autoCommit) throws SQLException
{
checkClosed();
// this is a no-op
}
/**
* Retrieves the current auto-commit mode for this Connection
* object.
*
* @return the current state of this Connection object's
* auto-commit mode
* @throws java.sql.SQLException if a database access error occurs
* or this method is called on a closed connection
* @see #setAutoCommit
*/
@Override
public boolean getAutoCommit() throws SQLException
{
checkClosed();
return false;
}
/**
* Makes all changes made since the previous
* commit/rollback permanent and releases any database locks
* currently held by this Connection object.
* This method should be
* used only when auto-commit mode has been disabled.
*
* @throws java.sql.SQLException if a database access error occurs,
* this method is called while participating in a distributed transaction,
* if this method is called on a closed conection or this
* Connection object is in auto-commit mode
* @see #setAutoCommit
*/
@Override
public void commit() throws SQLException
{
checkClosed();
}
/**
* Undoes all changes made in the current transaction
* and releases any database locks currently held
* by this Connection object. This method should be
* used only when auto-commit mode has been disabled.
*
* @throws java.sql.SQLException if a database access error occurs,
* this method is called while participating in a distributed transaction,
* this method is called on a closed connection or this
* Connection object is in auto-commit mode
* @see #setAutoCommit
*/
@Override
public void rollback() throws SQLException
{
checkClosed();
}
/**
* Releases this Connection object's database and JDBC resources
* immediately instead of waiting for them to be automatically released.
*
* Calling the method close on a Connection
* object that is already closed is a no-op.
*
* It is strongly recommended that an application explicitly
* commits or rolls back an active transaction prior to calling the
* close method. If the close method is called
* and there is an active transaction, the results are implementation-defined.
*
*
* @throws java.sql.SQLException SQLException if a database access error occurs
*/
@Override
public void close() throws SQLException
{
if (!isClosed())
{
try
{
protocol.close();
connected.set(false);
CBDriver.registered.cleanup(this);
}
catch (Exception ex)
{
logger.debug( "Error closing connection", ex);
throw new SQLException(ex.getCause());
}
}
}
/**
* Retrieves whether this Connection object has been
* closed. A connection is closed if the method close
* has been called on it or if certain fatal errors have occurred.
* This method is guaranteed to return true only when
* it is called after the method Connection.close has
* been called.
*
* This method generally cannot be called to determine whether a
* connection to a database is valid or invalid. A typical client
* can determine that a connection is invalid by catching any
* exceptions that might be thrown when an operation is attempted.
*
* @return true if this Connection object
* is closed; false if it is still open
* @throws java.sql.SQLException if a database access error occurs
*/
@Override
public boolean isClosed() throws SQLException
{
return !connected.get();
}
/**
* Retrieves a DatabaseMetaData object that contains
* metadata about the database to which this
* Connection object represents a connection.
* The metadata includes information about the database's
* tables, its supported SQL grammar, its stored
* procedures, the capabilities of this connection, and so on.
*
* @return a DatabaseMetaData object for this
* Connection object
* @throws java.sql.SQLException if a database access error occurs
* or this method is called on a closed connection
*/
@Override
public DatabaseMetaData getMetaData() throws SQLException
{
checkClosed();
return new CBDatabaseMetaData(this);
}
/**
* Puts this connection in read-only mode as a hint to the driver to enable
* database optimizations.
*
* Note: This method cannot be called during a transaction.
*
* @param readOnly true enables read-only mode;
* false disables it
* @throws java.sql.SQLException if a database access error occurs, this
* method is called on a closed connection or this
* method is called during a transaction
*/
@Override
public void setReadOnly(boolean readOnly) throws SQLException
{
checkClosed();
protocol.setReadOnly(readOnly);
}
/**
* Retrieves whether this Connection
* object is in read-only mode.
*
* @return true if this Connection object
* is read-only; false otherwise
* @throws java.sql.SQLException SQLException if a database access error occurs
* or this method is called on a closed connection
*/
@Override
public boolean isReadOnly() throws SQLException
{
checkClosed();
return protocol.getReadOnly();
}
/**
* Sets the given catalog name in order to select
* a subspace of this Connection object's database
* in which to work.
*
* If the driver does not support catalogs, it will
* silently ignore this request.
*
* Calling {@code setCatalog} has no effect on previously created or prepared
* {@code Statement} objects. It is implementation defined whether a DBMS
* prepare operation takes place immediately when the {@code Connection}
* method {@code prepareStatement} or {@code prepareCall} is invoked.
* For maximum portability, {@code setCatalog} should be called before a
* {@code Statement} is created or prepared.
*
* @param catalog the name of a catalog (subspace in this
* Connection object's database) in which to work
* @throws java.sql.SQLException if a database access error occurs
* or this method is called on a closed connection
* @see #getCatalog
*/
@Override
public void setCatalog(String catalog) throws SQLException
{
checkClosed();
protocol.setSchema(catalog);
}
/**
* Retrieves this Connection object's current catalog name.
*
* @return the current catalog name or null if there is none
* @throws java.sql.SQLException if a database access error occurs
* or this method is called on a closed connection
* @see #setCatalog
*/
@Override
public String getCatalog() throws SQLException
{
checkClosed();
return protocol.getSchema();
}
/**
* Attempts to change the transaction isolation level for this
* Connection object to the one given.
* The constants defined in the interface Connection
* are the possible transaction isolation levels.
*
* Note: If this method is called during a transaction, the result
* is implementation-defined.
*
* @param level one of the following Connection constants:
* Connection.TRANSACTION_READ_UNCOMMITTED,
* Connection.TRANSACTION_READ_COMMITTED,
* Connection.TRANSACTION_REPEATABLE_READ, or
* Connection.TRANSACTION_SERIALIZABLE.
* (Note that Connection.TRANSACTION_NONE cannot be used
* because it specifies that transactions are not supported.)
* @throws java.sql.SQLException if a database access error occurs, this
* method is called on a closed connection
* or the given parameter is not one of the Connection
* constants
* @see java.sql.DatabaseMetaData#supportsTransactionIsolationLevel
* @see #getTransactionIsolation
*/
@Override
public void setTransactionIsolation(int level) throws SQLException
{
checkClosed();
switch (level)
{
case Connection.TRANSACTION_NONE:
case Connection.TRANSACTION_READ_UNCOMMITTED:
case Connection.TRANSACTION_READ_COMMITTED:
case Connection.TRANSACTION_REPEATABLE_READ:
case Connection.TRANSACTION_SERIALIZABLE:
break;
default:
throw new SQLException("transaction level " + level + " not allowed ");
}
}
/**
* Retrieves this Connection object's current
* transaction isolation level.
*
* @return the current transaction isolation level, which will be one
* of the following constants:
* Connection.TRANSACTION_READ_UNCOMMITTED,
* Connection.TRANSACTION_READ_COMMITTED,
* Connection.TRANSACTION_REPEATABLE_READ,
* Connection.TRANSACTION_SERIALIZABLE, or
* Connection.TRANSACTION_NONE.
* @throws java.sql.SQLException if a database access error occurs
* or this method is called on a closed connection
* @see #setTransactionIsolation
*/
@Override
public int getTransactionIsolation() throws SQLException
{
checkClosed();
return Connection.TRANSACTION_NONE;
}
/**
* Retrieves the first warning reported by calls on this
* Connection object. If there is more than one
* warning, subsequent warnings will be chained to the first one
* and can be retrieved by calling the method
* SQLWarning.getNextWarning on the warning
* that was retrieved previously.
*
* This method may not be
* called on a closed connection; doing so will cause an
* SQLException to be thrown.
*
* Note: Subsequent warnings will be chained to this
* SQLWarning.
*
* @return the first SQLWarning object or null
* if there are none
* @throws java.sql.SQLException if a database access error occurs or
* this method is called on a closed connection
* @see java.sql.SQLWarning
*/
@Override
public SQLWarning getWarnings() throws SQLException
{
checkClosed();
return protocol.getWarnings();
}
/**
* Clears all warnings reported for this Connection object.
* After a call to this method, the method getWarnings
* returns null until a new warning is
* reported for this Connection object.
*
* @throws java.sql.SQLException SQLException if a database access error occurs
* or this method is called on a closed connection
*/
@Override
public void clearWarnings() throws SQLException
{
checkClosed();
protocol.clearWarning();
}
/**
* Creates a Statement object that will generate
* ResultSet objects with the given type and concurrency.
* This method is the same as the createStatement method
* above, but it allows the default result set
* type and concurrency to be overridden.
* The holdability of the created result sets can be determined by
* calling {@link #getHoldability}.
*
* @param resultSetType a result set type; one of
* ResultSet.TYPE_FORWARD_ONLY,
* ResultSet.TYPE_SCROLL_INSENSITIVE, or
* ResultSet.TYPE_SCROLL_SENSITIVE
* @param resultSetConcurrency a concurrency type; one of
* ResultSet.CONCUR_READ_ONLY or
* ResultSet.CONCUR_UPDATABLE
* @return a new Statement object that will generate
* ResultSet objects with the given type and
* concurrency
* @throws java.sql.SQLException if a database access error occurs, this
* method is called on a closed connection
* or the given parameters are not ResultSet
* constants indicating type and concurrency
* @throws java.sql.SQLFeatureNotSupportedException if the JDBC driver does not support
* this method or this method is not supported for the specified result
* set type and result set concurrency.
* @since 1.2
*/
@Override
public Statement createStatement(int resultSetType, int resultSetConcurrency) throws SQLException
{
checkClosed();
if (resultSetType == ResultSet.TYPE_FORWARD_ONLY && resultSetConcurrency == ResultSet.CONCUR_READ_ONLY)
return createStatement();
else
throw CBDriver.notImplemented(CBConnection.class, "createStatement");
}
/**
* Creates a PreparedStatement object that will generate
* ResultSet objects with the given type and concurrency.
* This method is the same as the prepareStatement method
* above, but it allows the default result set
* type and concurrency to be overridden.
* The holdability of the created result sets can be determined by
* calling {@link #getHoldability}.
*
* @param sql a String object that is the SQL statement to
* be sent to the database; may contain one or more '?' IN
* parameters
* @param resultSetType a result set type; one of
* ResultSet.TYPE_FORWARD_ONLY,
* ResultSet.TYPE_SCROLL_INSENSITIVE, or
* ResultSet.TYPE_SCROLL_SENSITIVE
* @param resultSetConcurrency a concurrency type; one of
* ResultSet.CONCUR_READ_ONLY or
* ResultSet.CONCUR_UPDATABLE
* @return a new PreparedStatement object containing the
* pre-compiled SQL statement that will produce ResultSet
* objects with the given type and concurrency
* @throws java.sql.SQLException if a database access error occurs, this
* method is called on a closed connection
* or the given parameters are not ResultSet
* constants indicating type and concurrency
* @throws java.sql.SQLFeatureNotSupportedException if the JDBC driver does not support
* this method or this method is not supported for the specified result
* set type and result set concurrency.
* @since 1.2
*/
@Override
public PreparedStatement prepareStatement(String sql, int resultSetType, int resultSetConcurrency) throws SQLException
{
checkClosed();
if (resultSetType == ResultSet.TYPE_FORWARD_ONLY && resultSetConcurrency == ResultSet.CONCUR_READ_ONLY)
return prepareStatement(sql);
else
throw CBDriver.notImplemented(CBConnection.class, "prepareStatement");
}
/**
* Creates a CallableStatement object that will generate
* ResultSet objects with the given type and concurrency.
* This method is the same as the prepareCall method
* above, but it allows the default result set
* type and concurrency to be overridden.
* The holdability of the created result sets can be determined by
* calling {@link #getHoldability}.
*
* @param sql a String object that is the SQL statement to
* be sent to the database; may contain on or more '?' parameters
* @param resultSetType a result set type; one of
* ResultSet.TYPE_FORWARD_ONLY,
* ResultSet.TYPE_SCROLL_INSENSITIVE, or
* ResultSet.TYPE_SCROLL_SENSITIVE
* @param resultSetConcurrency a concurrency type; one of
* ResultSet.CONCUR_READ_ONLY or
* ResultSet.CONCUR_UPDATABLE
* @return a new CallableStatement object containing the
* pre-compiled SQL statement that will produce ResultSet
* objects with the given type and concurrency
* @throws java.sql.SQLException if a database access error occurs, this method
* is called on a closed connection
* or the given parameters are not ResultSet
* constants indicating type and concurrency
* @throws java.sql.SQLFeatureNotSupportedException if the JDBC driver does not support
* this method or this method is not supported for the specified result
* set type and result set concurrency.
* @since 1.2
*/
@Override
public CallableStatement prepareCall(String sql, int resultSetType, int resultSetConcurrency) throws SQLException
{
checkClosed();
throw CBDriver.notImplemented(CBConnection.class, "prepareCall");
}
/**
* Retrieves the Map object associated with this
* Connection object.
* Unless the application has added an entry, the type map returned
* will be empty.
*
* You must invoke setTypeMap after making changes to the
* Map object returned from
* getTypeMap as a JDBC driver may create an internal
* copy of the Map object passed to setTypeMap:
*
*
* Map<String,Class<?>> myMap = con.getTypeMap();
* myMap.put("mySchemaName.ATHLETES", Athletes.class);
* con.setTypeMap(myMap);
*
*
* @return the java.util.Map object associated
* with this Connection object
* @throws java.sql.SQLException if a database access error occurs
* or this method is called on a closed connection
* @throws java.sql.SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @see #setTypeMap
* @since 1.2
*/
@Override
public Map> getTypeMap() throws SQLException
{
checkClosed();
throw CBDriver.notImplemented(CBConnection.class, "getTypeMap");
}
/**
* Installs the given TypeMap object as the type map for
* this Connection object. The type map will be used for the
* custom mapping of SQL structured types and distinct types.
*
* You must set the the values for the TypeMap prior to
* callng setMap as a JDBC driver may create an internal copy
* of the TypeMap:
*
*
* Map myMap<String,Class<?>> = new HashMap<String,Class<?>>();
* myMap.put("mySchemaName.ATHLETES", Athletes.class);
* con.setTypeMap(myMap);
*
*
* @param map the java.util.Map object to install
* as the replacement for this Connection
* object's default type map
* @throws java.sql.SQLException if a database access error occurs, this
* method is called on a closed connection or
* the given parameter is not a java.util.Map
* object
* @throws java.sql.SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @see #getTypeMap
* @since 1.2
*/
@Override
public void setTypeMap(Map> map) throws SQLException
{
checkClosed();
throw CBDriver.notImplemented(CBConnection.class, "setTypeMap");
}
/**
* Changes the default holdability of ResultSet objects
* created using this Connection object to the given
* holdability. The default holdability of ResultSet objects
* can be be determined by invoking
* {@link java.sql.DatabaseMetaData#getResultSetHoldability}.
*
* @param holdability a ResultSet holdability constant; one of
* ResultSet.HOLD_CURSORS_OVER_COMMIT or
* ResultSet.CLOSE_CURSORS_AT_COMMIT
* @throws java.sql.SQLException if a database access occurs, this method is called
* on a closed connection, or the given parameter
* is not a ResultSet constant indicating holdability
* @throws java.sql.SQLFeatureNotSupportedException if the given holdability is not supported
* @see #getHoldability
* @see java.sql.DatabaseMetaData#getResultSetHoldability
* @see java.sql.ResultSet
* @since 1.4
*/
@Override
public void setHoldability(int holdability) throws SQLException
{
checkClosed();
throw CBDriver.notImplemented(CBConnection.class, "setHoldability");
}
/**
* Retrieves the current holdability of ResultSet objects
* created using this Connection object.
*
* @return the holdability, one of
* ResultSet.HOLD_CURSORS_OVER_COMMIT or
* ResultSet.CLOSE_CURSORS_AT_COMMIT
* @throws java.sql.SQLException if a database access error occurs
* or this method is called on a closed connection
* @see #setHoldability
* @see java.sql.DatabaseMetaData#getResultSetHoldability
* @see java.sql.ResultSet
* @since 1.4
*/
@Override
public int getHoldability() throws SQLException
{
checkClosed();
return ResultSet.CLOSE_CURSORS_AT_COMMIT;
}
/**
* Creates an unnamed savepoint in the current transaction and
* returns the new Savepoint object that represents it.
*
* if setSavepoint is invoked outside of an active transaction, a transaction will be started at this newly created
* savepoint.
*
* @return the new Savepoint object
* @throws java.sql.SQLException if a database access error occurs,
* this method is called while participating in a distributed transaction,
* this method is called on a closed connection
* or this Connection object is currently in
* auto-commit mode
* @throws java.sql.SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @see java.sql.Savepoint
* @since 1.4
*/
@Override
public Savepoint setSavepoint() throws SQLException
{
checkClosed();
throw CBDriver.notImplemented(CBConnection.class, "setSavepoint");
}
/**
* Creates a savepoint with the given name in the current transaction
* and returns the new Savepoint object that represents it.
*
* if setSavepoint is invoked outside of an active transaction, a transaction will be started at this newly created
* savepoint.
*
* @param name a String containing the name of the savepoint
* @return the new Savepoint object
* @throws java.sql.SQLException if a database access error occurs,
* this method is called while participating in a distributed transaction,
* this method is called on a closed connection
* or this Connection object is currently in
* auto-commit mode
* @throws java.sql.SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @see java.sql.Savepoint
* @since 1.4
*/
@Override
public Savepoint setSavepoint(String name) throws SQLException
{
checkClosed();
throw CBDriver.notImplemented(CBConnection.class, "setSavepoint");
}
/**
* Undoes all changes made after the given Savepoint object
* was set.
*
* This method should be used only when auto-commit has been disabled.
*
* @param savepoint the Savepoint object to roll back to
* @throws java.sql.SQLException if a database access error occurs,
* this method is called while participating in a distributed transaction,
* this method is called on a closed connection,
* the Savepoint object is no longer valid,
* or this Connection object is currently in
* auto-commit mode
* @throws java.sql.SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @see java.sql.Savepoint
* @see #rollback
* @since 1.4
*/
@Override
public void rollback(Savepoint savepoint) throws SQLException
{
checkClosed();
throw CBDriver.notImplemented(CBConnection.class, "rollback");
}
/**
* Removes the specified Savepoint and subsequent Savepoint objects from the current
* transaction. Any reference to the savepoint after it have been removed
* will cause an SQLException to be thrown.
*
* @param savepoint the Savepoint object to be removed
* @throws java.sql.SQLException if a database access error occurs, this
* method is called on a closed connection or
* the given Savepoint object is not a valid
* savepoint in the current transaction
* @throws java.sql.SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.4
*/
@Override
public void releaseSavepoint(Savepoint savepoint) throws SQLException
{
checkClosed();
throw CBDriver.notImplemented(CBConnection.class, "releaseSavepoint");
}
/**
* Creates a Statement object that will generate
* ResultSet objects with the given type, concurrency,
* and holdability.
* This method is the same as the createStatement method
* above, but it allows the default result set
* type, concurrency, and holdability to be overridden.
*
* @param resultSetType one of the following ResultSet
* constants:
* ResultSet.TYPE_FORWARD_ONLY,
* ResultSet.TYPE_SCROLL_INSENSITIVE, or
* ResultSet.TYPE_SCROLL_SENSITIVE
* @param resultSetConcurrency one of the following ResultSet
* constants:
* ResultSet.CONCUR_READ_ONLY or
* ResultSet.CONCUR_UPDATABLE
* @param resultSetHoldability one of the following ResultSet
* constants:
* ResultSet.HOLD_CURSORS_OVER_COMMIT or
* ResultSet.CLOSE_CURSORS_AT_COMMIT
* @return a new Statement object that will generate
* ResultSet objects with the given type,
* concurrency, and holdability
* @throws java.sql.SQLException if a database access error occurs, this
* method is called on a closed connection
* or the given parameters are not ResultSet
* constants indicating type, concurrency, and holdability
* @throws java.sql.SQLFeatureNotSupportedException if the JDBC driver does not support
* this method or this method is not supported for the specified result
* set type, result set holdability and result set concurrency.
* @see java.sql.ResultSet
* @since 1.4
*/
@Override
public Statement createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws SQLException
{
checkClosed();
throw CBDriver.notImplemented(CBConnection.class, "createStatement");
}
/**
* Creates a PreparedStatement object that will generate
* ResultSet objects with the given type, concurrency,
* and holdability.
*
* This method is the same as the prepareStatement method
* above, but it allows the default result set
* type, concurrency, and holdability to be overridden.
*
* @param sql a String object that is the SQL statement to
* be sent to the database; may contain one or more '?' IN
* parameters
* @param resultSetType one of the following ResultSet
* constants:
* ResultSet.TYPE_FORWARD_ONLY,
* ResultSet.TYPE_SCROLL_INSENSITIVE, or
* ResultSet.TYPE_SCROLL_SENSITIVE
* @param resultSetConcurrency one of the following ResultSet
* constants:
* ResultSet.CONCUR_READ_ONLY or
* ResultSet.CONCUR_UPDATABLE
* @param resultSetHoldability one of the following ResultSet
* constants:
* ResultSet.HOLD_CURSORS_OVER_COMMIT or
* ResultSet.CLOSE_CURSORS_AT_COMMIT
* @return a new PreparedStatement object, containing the
* pre-compiled SQL statement, that will generate
* ResultSet objects with the given type,
* concurrency, and holdability
* @throws java.sql.SQLException if a database access error occurs, this
* method is called on a closed connection
* or the given parameters are not ResultSet
* constants indicating type, concurrency, and holdability
* @throws java.sql.SQLFeatureNotSupportedException if the JDBC driver does not support
* this method or this method is not supported for the specified result
* set type, result set holdability and result set concurrency.
* @see java.sql.ResultSet
* @since 1.4
*/
@Override
public PreparedStatement prepareStatement(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws SQLException
{
checkClosed();
throw CBDriver.notImplemented(CBConnection.class, "prepareStatement");
}
/**
* Creates a CallableStatement object that will generate
* ResultSet objects with the given type and concurrency.
* This method is the same as the prepareCall method
* above, but it allows the default result set
* type, result set concurrency type and holdability to be overridden.
*
* @param sql a String object that is the SQL statement to
* be sent to the database; may contain on or more '?' parameters
* @param resultSetType one of the following ResultSet
* constants:
* ResultSet.TYPE_FORWARD_ONLY,
* ResultSet.TYPE_SCROLL_INSENSITIVE, or
* ResultSet.TYPE_SCROLL_SENSITIVE
* @param resultSetConcurrency one of the following ResultSet
* constants:
* ResultSet.CONCUR_READ_ONLY or
* ResultSet.CONCUR_UPDATABLE
* @param resultSetHoldability one of the following ResultSet
* constants:
* ResultSet.HOLD_CURSORS_OVER_COMMIT or
* ResultSet.CLOSE_CURSORS_AT_COMMIT
* @return a new CallableStatement object, containing the
* pre-compiled SQL statement, that will generate
* ResultSet objects with the given type,
* concurrency, and holdability
* @throws java.sql.SQLException if a database access error occurs, this
* method is called on a closed connection
* or the given parameters are not ResultSet
* constants indicating type, concurrency, and holdability
* @throws java.sql.SQLFeatureNotSupportedException if the JDBC driver does not support
* this method or this method is not supported for the specified result
* set type, result set holdability and result set concurrency.
* @see java.sql.ResultSet
* @since 1.4
*/
@Override
public CallableStatement prepareCall(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws SQLException
{
checkClosed();
throw CBDriver.notImplemented(CBConnection.class, "prepareCall");
}
/**
* Creates a default PreparedStatement object that has
* the capability to retrieve auto-generated keys. The given constant
* tells the driver whether it should make auto-generated keys
* available for retrieval. This parameter is ignored if the SQL statement
* is not an INSERT statement, or an SQL statement able to return
* auto-generated keys (the list of such statements is vendor-specific).
*
* Note: This method is optimized for handling
* parametric SQL statements that benefit from precompilation. If
* the driver supports precompilation,
* the method prepareStatement will send
* the statement to the database for precompilation. Some drivers
* may not support precompilation. In this case, the statement may
* not be sent to the database until the PreparedStatement
* object is executed. This has no direct effect on users; however, it does
* affect which methods throw certain SQLExceptions.
*
* Result sets created using the returned PreparedStatement
* object will by default be type TYPE_FORWARD_ONLY
* and have a concurrency level of CONCUR_READ_ONLY.
* The holdability of the created result sets can be determined by
* calling {@link #getHoldability}.
*
* @param sql an SQL statement that may contain one or more '?' IN
* parameter placeholders
* @param autoGeneratedKeys a flag indicating whether auto-generated keys
* should be returned; one of
* Statement.RETURN_GENERATED_KEYS or
* Statement.NO_GENERATED_KEYS
* @return a new PreparedStatement object, containing the
* pre-compiled SQL statement, that will have the capability of
* returning auto-generated keys
* @throws java.sql.SQLException if a database access error occurs, this
* method is called on a closed connection
* or the given parameter is not a Statement
* constant indicating whether auto-generated keys should be
* returned
* @throws java.sql.SQLFeatureNotSupportedException if the JDBC driver does not support
* this method with a constant of Statement.RETURN_GENERATED_KEYS
* @since 1.4
*/
@Override
public PreparedStatement prepareStatement(String sql, int autoGeneratedKeys) throws SQLException
{
checkClosed();
throw CBDriver.notImplemented(CBConnection.class, "prepareStatement");
}
/**
* Creates a default PreparedStatement object capable
* of returning the auto-generated keys designated by the given array.
* This array contains the indexes of the columns in the target
* table that contain the auto-generated keys that should be made
* available. The driver will ignore the array if the SQL statement
* is not an INSERT statement, or an SQL statement able to return
* auto-generated keys (the list of such statements is vendor-specific).
*
* An SQL statement with or without IN parameters can be
* pre-compiled and stored in a PreparedStatement object. This
* object can then be used to efficiently execute this statement
* multiple times.
*
* Note: This method is optimized for handling
* parametric SQL statements that benefit from precompilation. If
* the driver supports precompilation,
* the method prepareStatement will send
* the statement to the database for precompilation. Some drivers
* may not support precompilation. In this case, the statement may
* not be sent to the database until the PreparedStatement
* object is executed. This has no direct effect on users; however, it does
* affect which methods throw certain SQLExceptions.
*
* Result sets created using the returned PreparedStatement
* object will by default be type TYPE_FORWARD_ONLY
* and have a concurrency level of CONCUR_READ_ONLY.
* The holdability of the created result sets can be determined by
* calling {@link #getHoldability}.
*
* @param sql an SQL statement that may contain one or more '?' IN
* parameter placeholders
* @param columnIndexes an array of column indexes indicating the columns
* that should be returned from the inserted row or rows
* @return a new PreparedStatement object, containing the
* pre-compiled statement, that is capable of returning the
* auto-generated keys designated by the given array of column
* indexes
* @throws java.sql.SQLException if a database access error occurs
* or this method is called on a closed connection
* @throws java.sql.SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.4
*/
@Override
public PreparedStatement prepareStatement(String sql, int[] columnIndexes) throws SQLException
{
checkClosed();
throw CBDriver.notImplemented(CBConnection.class, "prepareStatement");
}
/**
* Creates a default PreparedStatement object capable
* of returning the auto-generated keys designated by the given array.
* This array contains the names of the columns in the target
* table that contain the auto-generated keys that should be returned.
* The driver will ignore the array if the SQL statement
* is not an INSERT statement, or an SQL statement able to return
* auto-generated keys (the list of such statements is vendor-specific).
*
* An SQL statement with or without IN parameters can be
* pre-compiled and stored in a PreparedStatement object. This
* object can then be used to efficiently execute this statement
* multiple times.
*
* Note: This method is optimized for handling
* parametric SQL statements that benefit from precompilation. If
* the driver supports precompilation,
* the method prepareStatement will send
* the statement to the database for precompilation. Some drivers
* may not support precompilation. In this case, the statement may
* not be sent to the database until the PreparedStatement
* object is executed. This has no direct effect on users; however, it does
* affect which methods throw certain SQLExceptions.
*
* Result sets created using the returned PreparedStatement
* object will by default be type TYPE_FORWARD_ONLY
* and have a concurrency level of CONCUR_READ_ONLY.
* The holdability of the created result sets can be determined by
* calling {@link #getHoldability}.
*
* @param sql an SQL statement that may contain one or more '?' IN
* parameter placeholders
* @param columnNames an array of column names indicating the columns
* that should be returned from the inserted row or rows
* @return a new PreparedStatement object, containing the
* pre-compiled statement, that is capable of returning the
* auto-generated keys designated by the given array of column
* names
* @throws java.sql.SQLException if a database access error occurs
* or this method is called on a closed connection
* @throws java.sql.SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.4
*/
@Override
public PreparedStatement prepareStatement(String sql, String[] columnNames) throws SQLException
{
checkClosed();
return new CBPreparedStatement(this, protocol, sql, columnNames);
}
/**
* Constructs an object that implements the Clob interface. The object
* returned initially contains no data. The setAsciiStream,
* setCharacterStream and setString methods of
* the Clob interface may be used to add data to the Clob.
*
* @return An object that implements the Clob interface
* @throws java.sql.SQLException if an object that implements the
* Clob interface can not be constructed, this method is
* called on a closed connection or a database access error occurs.
* @throws java.sql.SQLFeatureNotSupportedException if the JDBC driver does not support
* this data type
* @since 1.6
*/
@Override
public Clob createClob() throws SQLException
{
checkClosed();
throw CBDriver.notImplemented(CBConnection.class, "createClob");
}
/**
* Constructs an object that implements the Blob interface. The object
* returned initially contains no data. The setBinaryStream and
* setBytes methods of the Blob interface may be used to add data to
* the Blob.
*
* @return An object that implements the Blob interface
* @throws java.sql.SQLException if an object that implements the
* Blob interface can not be constructed, this method is
* called on a closed connection or a database access error occurs.
* @throws java.sql.SQLFeatureNotSupportedException if the JDBC driver does not support
* this data type
* @since 1.6
*/
@Override
public Blob createBlob() throws SQLException
{
checkClosed();
throw CBDriver.notImplemented(CBConnection.class, "createBlob");
}
/**
* Constructs an object that implements the NClob interface. The object
* returned initially contains no data. The setAsciiStream,
* setCharacterStream and setString methods of the NClob interface may
* be used to add data to the NClob.
*
* @return An object that implements the NClob interface
* @throws java.sql.SQLException if an object that implements the
* NClob interface can not be constructed, this method is
* called on a closed connection or a database access error occurs.
* @throws java.sql.SQLFeatureNotSupportedException if the JDBC driver does not support
* this data type
* @since 1.6
*/
@Override
public NClob createNClob() throws SQLException
{
checkClosed();
throw CBDriver.notImplemented(CBConnection.class, "createNClob");
}
/**
* Constructs an object that implements the SQLXML interface. The object
* returned initially contains no data. The createXmlStreamWriter object and
* setString method of the SQLXML interface may be used to add data to the SQLXML
* object.
*
* @return An object that implements the SQLXML interface
* @throws java.sql.SQLException if an object that implements the SQLXML interface can not
* be constructed, this method is
* called on a closed connection or a database access error occurs.
* @throws java.sql.SQLFeatureNotSupportedException if the JDBC driver does not support
* this data type
* @since 1.6
*/
@Override
public SQLXML createSQLXML() throws SQLException
{
checkClosed();
throw CBDriver.notImplemented(CBConnection.class, "createSQLXML");
}
/**
* Returns true if the connection has not been closed and is still valid.
* The driver shall submit a query on the connection or use some other
* mechanism that positively verifies the connection is still valid when
* this method is called.
*
* The query submitted by the driver to validate the connection shall be
* executed in the context of the current transaction.
*
* @param timeout - The time in seconds to wait for the database operation
* used to validate the connection to complete. If
* the timeout period expires before the operation
* completes, this method returns false. A value of
* 0 indicates a timeout is not applied to the
* database operation.
*
* @return true if the connection is valid, false otherwise
* @throws java.sql.SQLException if the value supplied for timeout
* is less then 0
* @see java.sql.DatabaseMetaData#getClientInfoProperties
* @since 1.6
*
*/
@Override
public boolean isValid(int timeout) throws SQLException
{
if (isClosed()) return false;
return protocol.isValid(timeout);
}
/**
* Sets the value of the client info property specified by name to the
* value specified by value.
*
* Applications may use the DatabaseMetaData.getClientInfoProperties
* method to determine the client info properties supported by the driver
* and the maximum length that may be specified for each property.
*
* The driver stores the value specified in a suitable location in the
* database. For example in a special register, session parameter, or
* system table column. For efficiency the driver may defer setting the
* value in the database until the next time a statement is executed or
* prepared. Other than storing the client information in the appropriate
* place in the database, these methods shall not alter the behavior of
* the connection in anyway. The values supplied to these methods are
* used for accounting, diagnostics and debugging purposes only.
*
* The driver shall generate a warning if the client info name specified
* is not recognized by the driver.
*
* If the value specified to this method is greater than the maximum
* length for the property the driver may either truncate the value and
* generate a warning or generate a SQLClientInfoException. If the driver
* generates a SQLClientInfoException, the value specified was not set on the
* connection.
*
* The following are standard client info properties. Drivers are not
* required to support these properties however if the driver supports a
* client info property that can be described by one of the standard
* properties, the standard property name should be used.
*
*
* - ApplicationName - The name of the application currently utilizing
* the connection
* - ClientUser - The name of the user that the application using
* the connection is performing work for. This may
* not be the same as the user name that was used
* in establishing the connection.
* - ClientHostname - The hostname of the computer the application
* using the connection is running on.
*
*
*
* @param name The name of the client info property to set
* @param value The value to set the client info property to. If the
* value is null, the current value of the specified
* property is cleared.
*
* @throws java.sql.SQLClientInfoException if the database server returns an error while
* setting the client info value on the database server or this method
* is called on a closed connection
*
* @since 1.6
*/
@Override
public void setClientInfo(String name, String value) throws SQLClientInfoException
{
}
/**
* Sets the value of the connection's client info properties. The
* Properties object contains the names and values of the client info
* properties to be set. The set of client info properties contained in
* the properties list replaces the current set of client info properties
* on the connection. If a property that is currently set on the
* connection is not present in the properties list, that property is
* cleared. Specifying an empty properties list will clear all of the
* properties on the connection. See setClientInfo (String, String) for
* more information.
*
* If an error occurs in setting any of the client info properties, a
* SQLClientInfoException is thrown. The SQLClientInfoException
* contains information indicating which client info properties were not set.
* The state of the client information is unknown because
* some databases do not allow multiple client info properties to be set
* atomically. For those databases, one or more properties may have been
* set before the error occurred.
*
*
* @param properties the list of client info properties to set
*
* @throws java.sql.SQLClientInfoException if the database server returns an error while
* setting the clientInfo values on the database server or this method
* is called on a closed connection
*
* @see java.sql.Connection#setClientInfo(String, String) setClientInfo(String, String)
* @since 1.6
*
*/
@Override
public void setClientInfo(Properties properties) throws SQLClientInfoException
{
}
/**
* Returns the value of the client info property specified by name. This
* method may return null if the specified client info property has not
* been set and does not have a default value. This method will also
* return null if the specified client info property name is not supported
* by the driver.
*
* Applications may use the DatabaseMetaData.getClientInfoProperties
* method to determine the client info properties supported by the driver.
*
*
* @param name The name of the client info property to retrieve
*
* @return The value of the client info property specified
*
* @throws java.sql.SQLException if the database server returns an error when
* fetching the client info value from the database
* or this method is called on a closed connection
*
* @see java.sql.DatabaseMetaData#getClientInfoProperties
* @since 1.6
*
*/
@Override
public String getClientInfo(String name) throws SQLException
{
return null;
}
/**
* Returns a list containing the name and current value of each client info
* property supported by the driver. The value of a client info property
* may be null if the property has not been set and does not have a
* default value.
*
*
* @return A Properties object that contains the name and current value of
* each of the client info properties supported by the driver.
*
* @throws java.sql.SQLException if the database server returns an error when
* fetching the client info values from the database
* or this method is called on a closed connection
*
* @since 1.6
*/
@Override
public Properties getClientInfo() throws SQLException
{
return null;
}
/**
* Factory method for creating Array objects.
*
* Note: When createArrayOf is used to create an array object
* that maps to a primitive data type, then it is implementation-defined
* whether the Array object is an array of that primitive
* data type or an array of Object.
*
* Note: The JDBC driver is responsible for mapping the elements
* Object array to the default JDBC SQL type defined in
* java.sql.Types for the given class of Object. The default
* mapping is specified in Appendix B of the JDBC specification. If the
* resulting JDBC type is not the appropriate type for the given typeName then
* it is implementation defined whether an SQLException is
* thrown or the driver supports the resulting conversion.
*
* @param typeName the SQL name of the type the elements of the array map to. The typeName is a
* database-specific name which may be the name of a built-in type, a user-defined type or a standard SQL type supported by this database. This
* is the value returned by Array.getBaseTypeName
* @param elements the elements that populate the returned object
* @return an Array object whose elements map to the specified SQL type
* @throws java.sql.SQLException if a database error occurs, the JDBC type is not
* appropriate for the typeName and the conversion is not supported, the typeName is null or this method is called on a closed connection
* @throws java.sql.SQLFeatureNotSupportedException if the JDBC driver does not support this data type
* @since 1.6
*/
@Override
public Array createArrayOf(String typeName, Object[] elements) throws SQLException
{
checkClosed();
return new CBArray(typeName, elements);
}
/**
* Factory method for creating Struct objects.
*
* @param typeName the SQL type name of the SQL structured type that this Struct
* object maps to. The typeName is the name of a user-defined type that
* has been defined for this database. It is the value returned by
* Struct.getSQLTypeName.
* @param attributes the attributes that populate the returned object
* @return a Struct object that maps to the given SQL type and is populated with the given attributes
* @throws java.sql.SQLException if a database error occurs, the typeName is null or this method is called on a closed connection
* @throws java.sql.SQLFeatureNotSupportedException if the JDBC driver does not support this data type
* @since 1.6
*/
@Override
public Struct createStruct(String typeName, Object[] attributes) throws SQLException
{
checkClosed();
throw CBDriver.notImplemented(CBConnection.class, "createStruct");
}
/**
* Sets the given schema name to access.
*
* If the driver does not support schemas, it will
* silently ignore this request.
*
* Calling {@code setSchema} has no effect on previously created or prepared
* {@code Statement} objects. It is implementation defined whether a DBMS
* prepare operation takes place immediately when the {@code Connection}
* method {@code prepareStatement} or {@code prepareCall} is invoked.
* For maximum portability, {@code setSchema} should be called before a
* {@code Statement} is created or prepared.
*
* @param schema the name of a schema in which to work
* @throws java.sql.SQLException if a database access error occurs
* or this method is called on a closed connection
* @see #getSchema
* @since 1.7
*/
@Override
public void setSchema(String schema) throws SQLException
{
checkClosed();
protocol.setSchema(schema);
}
/**
* Retrieves this Connection object's current schema name.
*
* @return the current schema name or null if there is none
* @throws java.sql.SQLException if a database access error occurs
* or this method is called on a closed connection
* @see #setSchema
* @since 1.7
*/
@Override
public String getSchema() throws SQLException
{
checkClosed();
return protocol.getSchema();
}
/**
* Terminates an open connection. Calling abort results in:
*
* - The connection marked as closed
*
- Closes any physical connection to the database
*
- Releases resources used by the connection
*
- Insures that any thread that is currently accessing the connection
* will either progress to completion or throw an
SQLException.
*
*
* Calling abort marks the connection closed and releases any
* resources. Calling abort on a closed connection is a
* no-op.
*
* It is possible that the aborting and releasing of the resources that are
* held by the connection can take an extended period of time. When the
* abort method returns, the connection will have been marked as
* closed and the Executor that was passed as a parameter to abort
* may still be executing tasks to release resources.
*
* This method checks to see that there is an SQLPermission
* object before allowing the method to proceed. If a
* SecurityManager exists and its
* checkPermission method denies calling abort,
* this method throws a
* java.lang.SecurityException.
*
* @param executor The Executor implementation which will
* be used by abort.
* @throws java.sql.SQLException if a database access error occurs or
* the {@code executor} is {@code null},
* @throws SecurityException if a security manager exists and its
* checkPermission method denies calling abort
* @see SecurityManager#checkPermission
* @see java.util.concurrent.Executor
* @since 1.7
*/
@Override
public void abort(Executor executor) throws SQLException
{
if ( executor == null) throw new SQLException("Executor is null");
close();
}
/**
* Sets the maximum period a Connection or
* objects created from the Connection
* will wait for the database to reply to any one request. If any
* request remains unanswered, the waiting method will
* return with a SQLException, and the Connection
* or objects created from the Connection will be marked as
* closed. Any subsequent use of
* the objects, with the exception of the close,
* isClosed or Connection.isValid
* methods, will result in a SQLException.
*
* Note: This method is intended to address a rare but serious
* condition where network partitions can cause threads issuing JDBC calls
* to hang uninterruptedly in socket reads, until the OS TCP-TIMEOUT
* (typically 10 minutes). This method is related to the
* {@link #abort abort() } method which provides an administrator
* thread a means to free any such threads in cases where the
* JDBC connection is accessible to the administrator thread.
* The setNetworkTimeout method will cover cases where
* there is no administrator thread, or it has no access to the
* connection. This method is severe in it's effects, and should be
* given a high enough value so it is never triggered before any more
* normal timeouts, such as transaction timeouts.
*
* JDBC driver implementations may also choose to support the
* {@code setNetworkTimeout} method to impose a limit on database
* response time, in environments where no network is present.
*
* Drivers may internally implement some or all of their API calls with
* multiple internal driver-database transmissions, and it is left to the
* driver implementation to determine whether the limit will be
* applied always to the response to the API call, or to any
* single request made during the API call.
*
*
* This method can be invoked more than once, such as to set a limit for an
* area of JDBC code, and to reset to the default on exit from this area.
* Invocation of this method has no impact on already outstanding
* requests.
*
* The {@code Statement.setQueryTimeout()} timeout value is independent of the
* timeout value specified in {@code setNetworkTimeout}. If the query timeout
* expires before the network timeout then the
* statement execution will be canceled. If the network is still
* active the result will be that both the statement and connection
* are still usable. However if the network timeout expires before
* the query timeout or if the statement timeout fails due to network
* problems, the connection will be marked as closed, any resources held by
* the connection will be released and both the connection and
* statement will be unusable.
*
* When the driver determines that the {@code setNetworkTimeout} timeout
* value has expired, the JDBC driver marks the connection
* closed and releases any resources held by the connection.
*
*
* This method checks to see that there is an SQLPermission
* object before allowing the method to proceed. If a
* SecurityManager exists and its
* checkPermission method denies calling
* setNetworkTimeout, this method throws a
* java.lang.SecurityException.
*
* @param executor The Executor implementation which will
* be used by setNetworkTimeout.
* @param milliseconds The time in milliseconds to wait for the database
* operation
* to complete. If the JDBC driver does not support milliseconds, the
* JDBC driver will round the value up to the nearest second. If the
* timeout period expires before the operation
* completes, a SQLException will be thrown.
* A value of 0 indicates that there is not timeout for database operations.
* @throws java.sql.SQLException if a database access error occurs, this
* method is called on a closed connection,
* the {@code executor} is {@code null},
* or the value specified for seconds is less than 0.
* @throws SecurityException if a security manager exists and its
* checkPermission method denies calling
* setNetworkTimeout.
* @throws java.sql.SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @see SecurityManager#checkPermission
* @see java.sql.Statement#setQueryTimeout
* @see #getNetworkTimeout
* @see #abort
* @see java.util.concurrent.Executor
* @since 1.7
*/
@Override
public void setNetworkTimeout(Executor executor, int milliseconds) throws SQLException
{
checkClosed();
throw CBDriver.notImplemented(CBConnection.class, "setNetworkTimeout");
}
/**
* Retrieves the number of milliseconds the driver will
* wait for a database request to complete.
* If the limit is exceeded, a
* SQLException is thrown.
*
* @return the current timeout limit in milliseconds; zero means there is
* no limit
* @throws java.sql.SQLException if a database access error occurs or
* this method is called on a closed Connection
* @throws java.sql.SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @see #setNetworkTimeout
* @since 1.7
*/
@Override
public int getNetworkTimeout() throws SQLException
{
checkClosed();
throw CBDriver.notImplemented(CBConnection.class, "getNetworkTimeout");
}
/**
* Returns an object that implements the given interface to allow access to
* non-standard methods, or standard methods not exposed by the proxy.
*
* If the receiver implements the interface then the result is the receiver
* or a proxy for the receiver. If the receiver is a wrapper
* and the wrapped object implements the interface then the result is the
* wrapped object or a proxy for the wrapped object. Otherwise return the
* the result of calling unwrap recursively on the wrapped object
* or a proxy for that result. If the receiver is not a
* wrapper and does not implement the interface, then an SQLException is thrown.
*
* @param iface A Class defining an interface that the result must implement.
* @return an object that implements the interface. May be a proxy for the actual implementing object.
* @throws java.sql.SQLException If no object found that implements the interface
* @since 1.6131G
*/
@Override
public T unwrap(Class iface) throws SQLException
{
checkClosed();
if (iface.isAssignableFrom(getClass()))
{
return iface.cast(this);
}
throw new SQLException("Cannot unwrap to " + iface.getName());
}
/**
* Returns true if this either implements the interface argument or is directly or indirectly a wrapper
* for an object that does. Returns false otherwise. If this implements the interface then return true,
* else if this is a wrapper then return the result of recursively calling isWrapperFor on the wrapped
* object. If this does not implement the interface and is not a wrapper, return false.
* This method should be implemented as a low-cost operation compared to unwrap so that
* callers can use this method to avoid expensive unwrap calls that may fail. If this method
* returns true then calling unwrap with the same argument should succeed.
*
* @param iface a Class defining an interface.
* @return true if this implements the interface or directly or indirectly wraps an object that does.
* @throws java.sql.SQLException if an error occurs while determining whether this is a wrapper
* for an object with the given interface.
* @since 1.6
*/
@Override
public boolean isWrapperFor(Class iface) throws SQLException
{
checkClosed();
return iface.isAssignableFrom(getClass());
}
void checkClosed() throws SQLException
{
if (isClosed() ) {
throw new SQLException("Connection is closed");
}
}
public SQLJSON createSQLJSON()
{
return new SqlJsonImplementation();
}
protected void pollCluster() throws SQLException
{
protocol.pollCluster();
}
}