/*
Derby - Class org.apache.derby.impl.jdbc.EmbedConnection
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to you 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 org.apache.derby.impl.jdbc;
import org.apache.derby.iapi.error.ExceptionSeverity;
import org.apache.derby.jdbc.InternalDriver;
import org.apache.derby.iapi.reference.Attribute;
import org.apache.derby.iapi.reference.JDBC20Translation;
import org.apache.derby.iapi.reference.JDBC30Translation;
import org.apache.derby.iapi.reference.MessageId;
import org.apache.derby.iapi.reference.Property;
import org.apache.derby.iapi.reference.SQLState;
import org.apache.derby.iapi.services.context.ContextManager;
import org.apache.derby.iapi.services.memory.LowMemory;
import org.apache.derby.iapi.services.monitor.Monitor;
import org.apache.derby.iapi.services.sanity.SanityManager;
import org.apache.derby.iapi.jdbc.AuthenticationService;
import org.apache.derby.iapi.jdbc.EngineConnection;
import org.apache.derby.iapi.db.Database;
import org.apache.derby.iapi.error.ExceptionSeverity;
import org.apache.derby.iapi.error.StandardException;
import org.apache.derby.iapi.services.i18n.MessageService;
import org.apache.derby.iapi.sql.conn.LanguageConnectionContext;
import org.apache.derby.iapi.sql.execute.ExecutionContext;
import org.apache.derby.iapi.sql.dictionary.DataDictionary;
import org.apache.derby.iapi.store.access.XATransactionController;
/* can't import due to name overlap:
import java.sql.Connection;
import java.sql.ResultSet;
*/
import java.sql.PreparedStatement;
import java.sql.CallableStatement;
import java.sql.Blob;
import java.sql.Clob;
import java.sql.DatabaseMetaData;
import java.sql.SQLException;
import java.sql.SQLWarning;
import java.sql.Statement;
import java.util.HashMap;
import java.util.Properties;
import java.util.Iterator;
import org.apache.derby.impl.jdbc.authentication.NoneAuthenticationServiceImpl;
/**
* Local implementation of Connection for a JDBC driver in
* the same process as the database.
* <p>
* There is always a single root (parent) connection. The
* initial JDBC connection is the root connection. A
* call to <I>getCurrentConnection()</I> or with the URL
* <I>jdbc:default:connection</I> yields a nested connection that shares
* the same root connection as the parent. A nested connection
* is implemented using this class. The nested connection copies the
* state of the parent connection and shares some of the same
* objects (e.g. ContextManager) that are shared across all
* nesting levels. The proxy also maintains its own
* state that is distinct from its parent connection (e.g.
* autocommit or warnings).
* <p>
* <B>SYNCHRONIZATION</B>: Just about all JDBC actions are
* synchronized across all connections stemming from the
* same root connection. The synchronization is upon
* the a synchronized object return by the rootConnection.
<P><B>Supports</B>
<UL>
<LI> JDBC 2.0
</UL>
*
*
* @see TransactionResourceImpl
*
*/
public abstract class EmbedConnection implements EngineConnection
{
private static final StandardException exceptionClose = StandardException.closeException();
/**
* Static exception to be thrown when a Connection request can not
* be fulfilled due to lack of memory. A static exception as the lack
* of memory would most likely cause another OutOfMemoryException and
* if there is not enough memory to create the OOME exception then something
* like the VM dying could occur. Simpler just to throw a static.
*/
public static final SQLException NO_MEM =
Util.generateCsSQLException(SQLState.LOGIN_FAILED, "java.lang.OutOfMemoryError");
/**
* Low memory state object for connection requests.
*/
public static final LowMemory memoryState = new LowMemory();
//////////////////////////////////////////////////////////
// OBJECTS SHARED ACROSS CONNECTION NESTING
//////////////////////////////////////////////////////////
DatabaseMetaData dbMetadata;
TransactionResourceImpl tr; // always access tr thru getTR()
private HashMap lobHashMap = null;
private int lobHMKey = 0;
//////////////////////////////////////////////////////////
// STATE (copied to new nested connections, but nesting
// specific)
//////////////////////////////////////////////////////////
private boolean active;
boolean autoCommit = true;
boolean needCommit;
// Set to true if NONE authentication is being used
private boolean usingNoneAuth;
/*
following is a new feature in JDBC3.0 where you can specify the holdability
of a resultset at the end of the transaction. This gets set by the
new method setHoldability(int) in JDBC3.0
*
*/
private int connectionHoldAbility = JDBC30Translation.HOLD_CURSORS_OVER_COMMIT;
//////////////////////////////////////////////////////////
// NESTING SPECIFIC OBJECTS
//////////////////////////////////////////////////////////
/*
** The root connection is the base connection upon
** which all actions are synchronized. By default,
** we are the root connection unless we are created
** by copying the state from another connection.
*/
final EmbedConnection rootConnection;
private SQLWarning topWarning;
/**
Factory for JDBC objects to be created.
*/
private InternalDriver factory;
/**
The Connection object the application is using when accessing the
database through this connection. In most cases this will be equal
to this. When Connection pooling is being used, then it will
be set to the Connection object handed to the application.
It is used for the getConnection() methods of various JDBC objects.
*/
private java.sql.Connection applicationConnection;
/**
An increasing counter to assign to a ResultSet on its creation.
Used for ordering ResultSets returned from a procedure, always
returned in order of their creation. Is maintained at the root connection.
*/
private int resultSetId;
/** Cached string representation of the connection id */
private String connString;
//////////////////////////////////////////////////////////
// CONSTRUCTORS
//////////////////////////////////////////////////////////
// create a new Local Connection, using a new context manager
//
public EmbedConnection(InternalDriver driver, String url, Properties info)
throws SQLException
{
// Create a root connection.
applicationConnection = rootConnection = this;
factory = driver;
tr = new TransactionResourceImpl(driver, url, info);
active = true;
// register this thread and its context manager with
// the global context service
setupContextStack();
try {
// stick my context into the context manager
EmbedConnectionContext context = pushConnectionContext(tr.getContextManager());
// if we are shutting down don't attempt to boot or create the database
boolean shutdown = Boolean.valueOf(info.getProperty(Attribute.SHUTDOWN_ATTR)).booleanValue();
// see if database is already booted
Database database = (Database) Monitor.findService(Property.DATABASE_MODULE, tr.getDBName());
// See if user wants to create a new database.
boolean createBoot = createBoot(info);
// DERBY-2264: keeps track of whether we do a plain boot before an
// (re)encryption or hard upgrade boot to (possibly) authenticate
// first. We can not authenticate before we have booted, so in
// order to enforce data base owner powers over encryption or
// upgrade, we need a plain boot, then authenticate, then, if all
// is well, boot with (re)encryption or upgrade. Encryption at
// create time is not checked.
boolean isTwoPhaseEncryptionBoot = (!createBoot &&
isEncryptionBoot(info));
boolean isTwoPhaseUpgradeBoot = (!createBoot &&
isHardUpgradeBoot(info));
// Save original properties if we modified them for
// two phase encryption or upgrade boot.
Properties savedInfo = null;
if (database != null)
{
// database already booted by someone else
tr.setDatabase(database);
isTwoPhaseEncryptionBoot = false;
isTwoPhaseUpgradeBoot = false;
}
else if (!shutdown)
{
if (isTwoPhaseEncryptionBoot || isTwoPhaseUpgradeBoot) {
savedInfo = info;
info = removePhaseTwoProps((Properties)info.clone());
}
// Return false iff the monitor cannot handle a service of the
// type indicated by the proptocol within the name. If that's
// the case then we are the wrong driver.
if (!bootDatabase(info, isTwoPhaseUpgradeBoot))
{
tr.clearContextInError();
setInactive();
return;
}
}
if (createBoot && !shutdown)
{
// if we are shutting down don't attempt to boot or create the
// database
if (tr.getDatabase() != null) {
addWarning(EmbedSQLWarning.newEmbedSQLWarning(SQLState.DATABASE_EXISTS, getDBName()));
} else {
// check for user's credential and authenticate the user
// with system level authentication service.
// FIXME: We should also check for CREATE DATABASE operation
// authorization for the user if authorization was
// set at the system level.
// Right now, the authorization service does not
// restrict/account for Create database op.
checkUserCredentials(null, info);
// Process with database creation
database = createDatabase(tr.getDBName(), info);
tr.setDatabase(database);
}
}
if (tr.getDatabase() == null) {
String dbname = tr.getDBName();
// do not clear the TransactionResource context. It will be restored
// as part of the finally clause below.
this.setInactive();
throw newSQLException(SQLState.DATABASE_NOT_FOUND, dbname);
}
// Check User's credentials and if it is a valid user of
// the database
//
checkUserCredentials(tr.getDBName(), info);
// Make a real connection into the database, setup lcc, tc and all
// the rest.
tr.startTransaction();
if (isTwoPhaseEncryptionBoot || isTwoPhaseUpgradeBoot) {
// DERBY-2264: shutdown and boot again with encryption or
// upgrade attributes active. This is restricted to the
// database owner if authentication and sqlAuthorization is on.
if (!usingNoneAuth &&
getLanguageConnection().usesSqlAuthorization()) {
// a failure here leaves database booted, but no
// (re)encryption has taken place and the connection is
// rejected.
checkIsDBOwner(isTwoPhaseEncryptionBoot? OP_ENCRYPT :
OP_HARD_UPGRADE);
}
// shutdown and reboot using saved properties which
// include the (re)encyption or upgrade attribute(s)
info = savedInfo;
handleException(tr.shutdownDatabaseException());
restoreContextStack();
tr = new TransactionResourceImpl(driver, url, info);
active = true;
setupContextStack();
context = pushConnectionContext(tr.getContextManager());
if (!bootDatabase(info, false))
{
if (SanityManager.DEBUG) {
SanityManager.THROWASSERT(
"bootDatabase failed after initial plain boot " +
"for (re)encryption or upgrade");
}
tr.clearContextInError();
setInactive();
return;
}
// don't need to check user credentials again, did
// that on first plain boot, so just start
tr.startTransaction();
}
// now we have the database connection, we can shut down
if (shutdown) {
if (!usingNoneAuth &&
getLanguageConnection().usesSqlAuthorization()) {
// DERBY-2264: Only allow database owner to shut down if
// authentication and sqlAuthorization is on.
checkIsDBOwner(OP_SHUTDOWN);
}
throw tr.shutdownDatabaseException();
}
// Raise a warning in sqlAuthorization mode if authentication is not ON
if (usingNoneAuth && getLanguageConnection().usesSqlAuthorization())
addWarning(EmbedSQLWarning.newEmbedSQLWarning(SQLState.SQL_AUTHORIZATION_WITH_NO_AUTHENTICATION));
}
catch (OutOfMemoryError noMemory)
{
//System.out.println("freeA");
restoreContextStack();
tr.lcc = null;
tr.cm = null;
//System.out.println("free");
//System.out.println(Runtime.getRuntime().freeMemory());
memoryState.setLowMemory();
//noMemory.printStackTrace();
// throw Util.generateCsSQLException(SQLState.LOGIN_FAILED, noMemory.getMessage(), noMemory);
throw NO_MEM;
}
catch (Throwable t) {
if (t instanceof StandardException)
{
StandardException se = (StandardException) t;
if (se.getSeverity() < ExceptionSeverity.SESSION_SEVERITY)
se.setSeverity(ExceptionSeverity.SESSION_SEVERITY);
}
tr.cleanupOnError(t);
throw handleException(t);
} finally {
restoreContextStack();
}
}
/**
Examine the attributes set provided for illegal boot
combinations and determine if this is a create boot.
@return true iff the attribute <em>create=true</em> is provided. This
means create a standard database. In other cases, returns
false.
@param p the attribute set.
@exception SQLException Throw if more than one of
<em>create</em>, <em>createFrom</em>, <em>restoreFrom</em> and
<em>rollForwardRecoveryFrom</em> is used simultaneously. <br>
Also, throw if (re)encryption is attempted with one of
<em>createFrom</em>, <em>restoreFrom</em> and
<em>rollForwardRecoveryFrom</em>.
*/
private boolean createBoot(Properties p) throws SQLException
{
int createCount = 0;
if (Boolean.valueOf(p.getProperty(Attribute.CREATE_ATTR)).booleanValue())
createCount++;
int restoreCount=0;
//check if the user has specified any /create/restore/recover from backup attributes.
if (p.getProperty(Attribute.CREATE_FROM) != null)
restoreCount++;
if (p.getProperty(Attribute.RESTORE_FROM) != null)
restoreCount++;
if (p.getProperty(Attribute.ROLL_FORWARD_RECOVERY_FROM)!=null)
restoreCount++;
if(restoreCount > 1)
throw newSQLException(SQLState.CONFLICTING_RESTORE_ATTRIBUTES);
// check if user has specified re-encryption attributes in
// combination with createFrom/restoreFrom/rollForwardRecoveryFrom
// attributes. Re-encryption is not
// allowed when restoring from backup.
if (restoreCount != 0 && isEncryptionBoot(p)) {
throw newSQLException(SQLState.CONFLICTING_RESTORE_ATTRIBUTES);
}
//add the restore count to create count to make sure
//user has not specified and restore together by mistake.
createCount = createCount + restoreCount ;
//
if (createCount > 1) throw newSQLException(SQLState.CONFLICTING_CREATE_ATTRIBUTES);
//retuns true only for the create flag not for restore flags
return (createCount - restoreCount) == 1;
}
/**
* Examine boot properties and determine if a boot with the given
* attributes would entail an encryption operation.
*
* @param p the attribute set
* @return true if a boot will encrypt or re-encrypt the database
*/
private boolean isEncryptionBoot(Properties p)
{
return ((Boolean.valueOf(
p.getProperty(Attribute.DATA_ENCRYPTION)).booleanValue()) ||
(p.getProperty(Attribute.NEW_BOOT_PASSWORD) != null) ||
(p.getProperty(Attribute.NEW_CRYPTO_EXTERNAL_KEY) != null));
}
/**
* Examine boot properties and determine if a boot with the given
* attributes would entail a hard upgrade.
*
* @param p the attribute set
* @return true if a boot will hard upgrade the database
*/
private boolean isHardUpgradeBoot(Properties p)
{
return Boolean.valueOf(
p.getProperty(Attribute.UPGRADE_ATTR)).booleanValue();
}
/**
* Remove any encryption or upgarde properties from the given properties
*
* @param p the attribute set
* @return clone sans encryption properties
*/
private Properties removePhaseTwoProps(Properties p)
{
p.remove(Attribute.DATA_ENCRYPTION);
p.remove(Attribute.NEW_BOOT_PASSWORD);
p.remove(Attribute.NEW_CRYPTO_EXTERNAL_KEY);
p.remove(Attribute.UPGRADE_ATTR);
return p;
}
/**
* Create a new connection based off of the
* connection passed in. Initializes state
* based on input connection, and copies
* appropriate object pointers. This is only used
for nested connections.
*
* @param inputConnection the input connection
*/
public EmbedConnection(EmbedConnection inputConnection)
{
if (SanityManager.DEBUG)
{
SanityManager.ASSERT(inputConnection.active,
"trying to create a proxy for an inactive conneciton");
}
// Proxy connections are always autocommit false
// thus needCommit is irrelavent.
autoCommit = false;
/*
** Nesting specific state we are copying from
** the inputConnection
*/
/*
** Objects we are sharing across nestings
*/
// set it to null to allow it to be final.
tr = null; // a proxy connection has no direct
// pointer to the tr. Every call has to go
// thru the rootConnection's tr.
active = true;
this.rootConnection = inputConnection.rootConnection;
this.applicationConnection = this;
this.factory = inputConnection.factory;
//if no holdability specified for the resultset, use the holability
//defined for the connection
this.connectionHoldAbility = inputConnection.connectionHoldAbility;
//RESOLVE: although it looks like the right
// thing to share the metadata object, if
// we do we'll get the wrong behavior on
// getCurrentConnection().getMetaData().isReadOnly()
// so don't try to be smart and uncomment the
// following. Ultimately, the metadata should
// be shared by all connections anyway.
//dbMetadata = inputConnection.dbMetadata;
}
//
// Check passed-in user's credentials.
//
private void checkUserCredentials(String dbname,
Properties userInfo)
throws SQLException
{
if (SanityManager.DEBUG)
SanityManager.ASSERT(!isClosed(), "connection is closed");
// If a database name was passed-in then check user's credential
// in that database using the database's authentication service,
// otherwise check if it is a valid user in the JBMS system.
//
// NOTE: We always expect an authentication service per database
// and one at the system level.
//
AuthenticationService authenticationService = null;
// Retrieve appropriate authentication service handle
if (dbname == null)
authenticationService = getLocalDriver().getAuthenticationService();
else
authenticationService = getTR().getDatabase().getAuthenticationService();
// check that we do have a authentication service
// it is _always_ expected.
if (authenticationService == null)
{
String failedString = MessageService.getTextMessage(
(dbname == null) ? MessageId.AUTH_NO_SERVICE_FOR_SYSTEM : MessageId.AUTH_NO_SERVICE_FOR_DB);
throw newSQLException(SQLState.LOGIN_FAILED, failedString);
}
// Let's authenticate now
if (!authenticationService.authenticate(
dbname,
userInfo
)) {
throw newSQLException(SQLState.LOGIN_FAILED, MessageService.getTextMessage(MessageId.AUTH_INVALID));
}
// If authentication is not on, we have to raise a warning if sqlAuthorization is ON
// Since NoneAuthenticationService is the default for Derby, it should be ok to refer
// to its implementation here, since it will always be present.
if (authenticationService instanceof NoneAuthenticationServiceImpl)
usingNoneAuth = true;
}
/* Enumerate operations controlled by database owner powers */
private static final int OP_ENCRYPT = 0;
private static final int OP_SHUTDOWN = 1;
private static final int OP_HARD_UPGRADE = 2;
/**
* Check if actual authenticationId is equal to the database owner's.
*
* @param operation attempted operation which needs database owner powers
* @throws SQLException if actual authenticationId is different
* from authenticationId of database owner.
*/
private void checkIsDBOwner(int operation) throws SQLException
{
final LanguageConnectionContext lcc = getLanguageConnection();
final String actualId = lcc.getAuthorizationId();
final String dbOwnerId = lcc.getDataDictionary().
getAuthorizationDatabaseOwner();
if (!actualId.equals(dbOwnerId)) {
switch (operation) {
case OP_ENCRYPT:
throw newSQLException(SQLState.AUTH_ENCRYPT_NOT_DB_OWNER,
actualId, tr.getDBName());
case OP_SHUTDOWN:
throw newSQLException(SQLState.AUTH_SHUTDOWN_NOT_DB_OWNER,
actualId, tr.getDBName());
case OP_HARD_UPGRADE:
throw newSQLException(SQLState.AUTH_HARD_UPGRADE_NOT_DB_OWNER,
actualId, tr.getDBName());
default:
if (SanityManager.DEBUG) {
SanityManager.THROWASSERT(
"illegal checkIsDBOwner operation");
}
throw newSQLException(
SQLState.AUTH_DATABASE_CONNECTION_REFUSED);
}
}
}
/**
* Gets the EngineType of the connected database.
*
* @return 0 if there is no database, the engine type otherwise. @see org.apache.derby.iapi.reference.EngineType
*/
public int getEngineType()
{
Database db = getDatabase();
if( null == db)
return 0;
return db.getEngineType();
}
/*
** Methods from java.sql.Connection
*/
/**
* SQL statements without parameters are normally
* executed using Statement objects. If the same SQL statement
* is executed many times, it is more efficient to use a
* PreparedStatement
*
* JDBC 2.0
*
* Result sets created using the returned Statement will have
* forward-only type, and read-only concurrency, by default.
*
* @return a new Statement object
* @exception SQLException if a database-access error occurs.
*/
public final Statement createStatement() throws SQLException
{
return createStatement(JDBC20Translation.TYPE_FORWARD_ONLY,
JDBC20Translation.CONCUR_READ_ONLY,
connectionHoldAbility);
}
/**
* JDBC 2.0
*
* Same as createStatement() above, but allows the default result set
* type and result set concurrency type to be overridden.
*
* @param resultSetType a result set type, see ResultSet.TYPE_XXX
* @param resultSetConcurrency a concurrency type, see ResultSet.CONCUR_XXX
* @return a new Statement object
* @exception SQLException if a database-access error occurs.
*/
public final Statement createStatement(int resultSetType,
int resultSetConcurrency)
throws SQLException
{
return createStatement(resultSetType, resultSetConcurrency,
connectionHoldAbility);
}
/**
* JDBC 3.0
*
* Same as createStatement() above, but allows the default result set
* type, result set concurrency type and result set holdability type to
* be overridden.
*
* @param resultSetType a result set type, see ResultSet.TYPE_XXX
* @param resultSetConcurrency a concurrency type, see ResultSet.CONCUR_XXX
* @param resultSetHoldability a holdability type,
* ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT
* @return a new Statement object
* @exception SQLException if a database-access error occurs.
*/
public final Statement createStatement(int resultSetType,
int resultSetConcurrency,
int resultSetHoldability)
throws SQLException
{
checkIfClosed();
return factory.newEmbedStatement(this, false,
setResultSetType(resultSetType), resultSetConcurrency,
resultSetHoldability);
}
/**
* 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.
*
* <P><B>Note:</B> This method is optimized for handling
* parametric SQL statements that benefit from precompilation. If
* the driver supports precompilation, 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 is
* executed. This has no direct affect on users; however, it does
* affect which method throws certain SQLExceptions.
*
* JDBC 2.0
*
* Result sets created using the returned PreparedStatement will have
* forward-only type, and read-only concurrency, by default.
*
* @param sql a SQL statement that may contain one or more '?' IN
* parameter placeholders
* @return a new PreparedStatement object containing the
* pre-compiled statement
* @exception SQLException if a database-access error occurs.
*/
public final PreparedStatement prepareStatement(String sql)
throws SQLException
{
return prepareStatement(sql,JDBC20Translation.TYPE_FORWARD_ONLY,
JDBC20Translation.CONCUR_READ_ONLY,
connectionHoldAbility,
JDBC30Translation.NO_GENERATED_KEYS,
null,
null);
}
/**
* JDBC 2.0
*
* Same as prepareStatement() above, but allows the default result set
* type and result set concurrency type to be overridden.
*
* @param resultSetType a result set type, see ResultSet.TYPE_XXX
* @param resultSetConcurrency a concurrency type, see ResultSet.CONCUR_XXX
* @return a new PreparedStatement object containing the
* pre-compiled SQL statement
* @exception SQLException if a database-access error occurs.
*/
public final PreparedStatement prepareStatement(String sql, int resultSetType,
int resultSetConcurrency)
throws SQLException
{
return prepareStatement(sql,
resultSetType,
resultSetConcurrency,
connectionHoldAbility,
JDBC30Translation.NO_GENERATED_KEYS,
null,
null);
}
/**
* JDBC 3.0
*
* Same as prepareStatement() above, but allows the default result set
* type, result set concurrency type and result set holdability
* to be overridden.
*
* @param resultSetType a result set type, see ResultSet.TYPE_XXX
* @param resultSetConcurrency a concurrency type, see ResultSet.CONCUR_XXX
* @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
* @exception SQLException if a database-access error occurs.
*/
public final PreparedStatement prepareStatement(String sql, int resultSetType,
int resultSetConcurrency, int resultSetHoldability)
throws SQLException
{
return prepareStatement(sql,
resultSetType,
resultSetConcurrency,
resultSetHoldability,
JDBC30Translation.NO_GENERATED_KEYS,
null,
null);
}
/**
* 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. This array is ignored if the SQL statement
* is not an INSERT statement
JDBC 3.0
*
*
* @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
* SQL statement, that will have the capability of returning auto-generated keys
* designated by the given array of column indexes
*
* @exception SQLException Thrown on error.
*/
public final PreparedStatement prepareStatement(
String sql,
int[] columnIndexes)
throws SQLException
{
return prepareStatement(sql,
JDBC20Translation.TYPE_FORWARD_ONLY,
JDBC20Translation.CONCUR_READ_ONLY,
connectionHoldAbility,
columnIndexes == null
? JDBC30Translation.NO_GENERATED_KEYS
: JDBC30Translation.RETURN_GENERATED_KEYS,
columnIndexes,
null);
}
/**
* 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. This array is ignored if the SQL statement
* is not an INSERT statement
*
JDBC 3.0
*
* @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
* SQL statement, that will have the capability of returning auto-generated keys
* designated by the given array of column names
*
* @exception SQLException Thrown on error.
*/
public final PreparedStatement prepareStatement(
String sql,
String[] columnNames)
throws SQLException
{
return prepareStatement(sql,
JDBC20Translation.TYPE_FORWARD_ONLY,
JDBC20Translation.CONCUR_READ_ONLY,
connectionHoldAbility,
columnNames == null
? JDBC30Translation.NO_GENERATED_KEYS
: JDBC30Translation.RETURN_GENERATED_KEYS,
null,
columnNames);
}
/**
* Creates a default PreparedStatement object that has the capability to
* retieve 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.
* JDBC 3.0
*
* @param sql A SQL statement that may contain one or more ? IN parameter placeholders
* @param autoGeneratedKeys A flag indicating whether auto-generated keys
* should be returned
*
* @return A new PreparedStatement object, containing the pre-compiled
* SQL statement, that will have the capability of returning auto-generated keys
*
* @exception SQLException Feature not implemented for now.
*/
public final PreparedStatement prepareStatement(
String sql,
int autoGeneratedKeys)
throws SQLException
{
return prepareStatement(sql,
JDBC20Translation.TYPE_FORWARD_ONLY,
JDBC20Translation.CONCUR_READ_ONLY,
connectionHoldAbility,
autoGeneratedKeys,
null,
null);
}
private PreparedStatement prepareStatement(String sql, int resultSetType,
int resultSetConcurrency, int resultSetHoldability,
int autoGeneratedKeys, int[] columnIndexes, String[] columnNames)
throws SQLException
{
synchronized (getConnectionSynchronization()) {
setupContextStack();
try {
return factory.newEmbedPreparedStatement(this, sql, false,
setResultSetType(resultSetType),
resultSetConcurrency,
resultSetHoldability,
autoGeneratedKeys,
columnIndexes,
columnNames);
} finally {
restoreContextStack();
}
}
}
/**
* A SQL stored procedure call statement is handled by creating a
* CallableStatement for it. The CallableStatement provides
* methods for setting up its IN and OUT parameters, and
* methods for executing it.
*
* <P><B>Note:</B> This method is optimized for handling stored
* procedure call statements. Some drivers may send the call
* statement to the database when the prepareCall is done; others
* may wait until the CallableStatement is executed. This has no
* direct affect on users; however, it does affect which method
* throws certain SQLExceptions.
*
* JDBC 2.0
*
* Result sets created using the returned CallableStatement will have
* forward-only type, and read-only concurrency, by default.
*
* @param sql a SQL statement that may contain one or more '?'
* parameter placeholders. Typically this statement is a JDBC
* function call escape string.
* @return a new CallableStatement object containing the
* pre-compiled SQL statement
* @exception SQLException if a database-access error occurs.
*/
public final CallableStatement prepareCall(String sql)
throws SQLException
{
return prepareCall(sql, JDBC20Translation.TYPE_FORWARD_ONLY,
JDBC20Translation.CONCUR_READ_ONLY,
connectionHoldAbility);
}
/**
* JDBC 2.0
*
* Same as prepareCall() above, but allows the default result set
* type and result set concurrency type to be overridden.
*
* @param resultSetType a result set type, see ResultSet.TYPE_XXX
* @param resultSetConcurrency a concurrency type, see ResultSet.CONCUR_XXX
* @return a new CallableStatement object containing the
* pre-compiled SQL statement
* @exception SQLException if a database-access error occurs.
*/
public final CallableStatement prepareCall(String sql, int resultSetType,
int resultSetConcurrency)
throws SQLException
{
return prepareCall(sql, resultSetType, resultSetConcurrency,
connectionHoldAbility);
}
/**
* JDBC 3.0
*
* Same as prepareCall() above, but allows the default result set
* type, result set concurrency type and result set holdability
* to be overridden.
*
* @param resultSetType a result set type, see ResultSet.TYPE_XXX
* @param resultSetConcurrency a concurrency type, see ResultSet.CONCUR_XXX
* @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
* @exception SQLException if a database-access error occurs.
*/
public final CallableStatement prepareCall(String sql, int resultSetType,
int resultSetConcurrency, int resultSetHoldability)
throws SQLException
{
checkIfClosed();
synchronized (getConnectionSynchronization())
{
setupContextStack();
try
{
return factory.newEmbedCallableStatement(this, sql,
setResultSetType(resultSetType),
resultSetConcurrency,
resultSetHoldability);
}
finally
{
restoreContextStack();
}
}
}
/**
* A driver may convert the JDBC sql grammar into its system's
* native SQL grammar prior to sending it; nativeSQL returns the
* native form of the statement that the driver would have sent.
*
* @param sql a SQL statement that may contain one or more '?'
* parameter placeholders
* @return the native form of this statement
*/
public String nativeSQL(String sql) throws SQLException {
checkIfClosed();
// we don't massage the strings at all, so this is easy:
return sql;
}
/**
* 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 either commit() or
* rollback(). By default, new connections are in auto-commit
* mode.
*
* The commit occurs when the statement completes or the next
* execute occurs, whichever comes first. In the case of
* statements returning a ResultSet, the statement completes when
* the last row of the ResultSet has been retrieved or the
* ResultSet has been closed. In advanced cases, a single
* statement may return multiple results as well as output
* parameter values. Here the commit occurs when all results and
* output param values have been retrieved.
*
* @param autoCommit true enables auto-commit; false disables
* auto-commit.
* @exception SQLException if a database-access error occurs.
*/
public void setAutoCommit(boolean autoCommit) throws SQLException {
checkIfClosed();
// Is this a nested connection
if (rootConnection != this) {
if (autoCommit)
throw newSQLException(SQLState.NO_AUTO_COMMIT_ON);
}
if (this.autoCommit != autoCommit)
commit();
this.autoCommit = autoCommit;
}
/**
* Get the current auto-commit state.
*
* @return Current state of auto-commit mode.
* @see #setAutoCommit
*/
public boolean getAutoCommit() throws SQLException {
checkIfClosed();
return autoCommit;
}
/**
* Commit makes all changes made since the previous
* commit/rollback permanent and releases any database locks
* currently held by the Connection. This method should only be
* used when auto commit has been disabled.
*
* @exception SQLException if a database-access error occurs.
* @see #setAutoCommit
*/
public void commit() throws SQLException {
synchronized (getConnectionSynchronization())
{
/*
** Note that the context stack is
** needed even for rollback & commit
*/
setupContextStack();
try
{
getTR().commit();
clearLOBMapping();
}
catch (Throwable t)
{
throw handleException(t);
}
finally
{
restoreContextStack();
}
needCommit = false;
}
}
/**
* Rollback drops all changes made since the previous
* commit/rollback and releases any database locks currently held
* by the Connection. This method should only be used when auto
* commit has been disabled.
*
* @exception SQLException if a database-access error occurs.
* @see #setAutoCommit
*/
public void rollback() throws SQLException {
synchronized (getConnectionSynchronization())
{
/*
** Note that the context stack is
** needed even for rollback & commit
*/
setupContextStack();
try
{
getTR().rollback();
clearLOBMapping();
} catch (Throwable t) {
throw handleException(t);
}
finally
{
restoreContextStack();
}
needCommit = false;
}
}
/**
* In some cases, it is desirable to immediately release a
* Connection's database and JDBC resources instead of waiting for
* them to be automatically released; the close method provides this
* immediate release.
*
* <P><B>Note:</B> A Connection is automatically closed when it is
* garbage collected. Certain fatal errors also result in a closed
* Connection.
*
* @exception SQLException if a database-access error occurs.
*/
public void close() throws SQLException {
// JDK 1.4 javadoc indicates close on a closed connection is a no-op
if (!isClosed() &&
(rootConnection == this) &&
(!autoCommit && !transactionIsIdle())) {
throw newSQLException(
SQLState.LANG_INVALID_TRANSACTION_STATE);
}
close(exceptionClose);
}
// This inner close takes the exception and calls
// the context manager to make the connection close.
// The exception must be a session severity exception.
//
// NOTE: This method is not part of JDBC specs.
//
private void close(StandardException e) throws SQLException {
synchronized(getConnectionSynchronization())
{
if (rootConnection == this)
{
/*
* If it isn't active, it's already been closed.
*/
if (active) {
if (tr.isActive()) {
setupContextStack();
try {
tr.rollback();
// Let go of lcc reference so it can be GC'ed after
// cleanupOnError, the tr will stay around until the
// rootConnection itself is GC'ed, which is dependent
// on how long the client program wants to hold on to
// the Connection object.
tr.clearLcc();
tr.cleanupOnError(e);
} catch (Throwable t) {
throw handleException(t);
} finally {
restoreContextStack();
}
} else {
// DERBY-1947: If another connection has closed down
// the database, the transaction is not active, but
// the cleanup has not been done yet.
tr.clearLcc();
tr.cleanupOnError(e);
}
}
}
if (!isClosed())
setInactive();
}
}
/**
* Tests to see if a Connection is closed.
*
* @return true if the connection is closed; false if it's still open
*/
public final boolean isClosed() {
if (active) {
// I am attached, check the database state
if (getTR().isActive()) {
return false;
}
}
return true;
}
/**
* A Connection's database is able to provide information
* describing its tables, its supported SQL grammar, its stored
* procedures, the capabilities of this connection, etc. This
* information is made available through a DatabaseMetaData
* object.
*
* @return a DatabaseMetaData object for this Connection
* @exception SQLException if a database-access error occurs.
*/
public DatabaseMetaData getMetaData() throws SQLException {
checkIfClosed();
if (dbMetadata == null) {
// There is a case where dbname can be null.
// Replication client of this method does not have a
// JDBC connection; therefore dbname is null and this
// is expected.
//
dbMetadata = factory.newEmbedDatabaseMetaData(this, getTR().getUrl());
}
return dbMetadata;
}
/**
JDBC 3.0
* 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
*
*/
public final int getHoldability() throws SQLException {
checkIfClosed();
return connectionHoldAbility;
}
/**
JDBC 3.0
* Changes the holdability of ResultSet objects created using this
* Connection object to the given holdability.
*
*
* @param holdability A ResultSet holdability constant, one of ResultSet.HOLD_CURSORS_OVER_COMMIT
* or ResultSet.CLOSE_CURSORS_AT_COMMIT
*
*/
public final void setHoldability(int holdability) throws SQLException {
checkIfClosed();
connectionHoldAbility = holdability;
}
/**
* You can put a connection in read-only mode as a hint to enable
* database optimizations.
*
* <P><B>Note:</B> setReadOnly cannot be called while in the
* middle of a transaction.
*
* @param readOnly true enables read-only mode; false disables
* read-only mode.
* @exception SQLException if a database-access error occurs.
*/
public final void setReadOnly(boolean readOnly) throws SQLException
{
synchronized(getConnectionSynchronization())
{
setupContextStack();
try {
getLanguageConnection().setReadOnly(readOnly);
} catch (StandardException e) {
throw handleException(e);
} finally {
restoreContextStack();
}
}
}
/**
* Tests to see if the connection is in read-only mode.
*
* @return true if connection is read-only
* @exception SQLException if a database-access error occurs.
*/
public final boolean isReadOnly() throws SQLException
{
checkIfClosed();
return getLanguageConnection().isReadOnly();
}
/**
* A sub-space of this Connection's database may be selected by setting a
* catalog name. If the driver does not support catalogs it will
* silently ignore this request.
*
* @exception SQLException if a database-access error occurs.
*/
public void setCatalog(String catalog) throws SQLException {
checkIfClosed();
// silently ignoring this request like the javadoc said.
return;
}
/**
* Return the Connection's current catalog name.
*
* @return the current catalog name or null
* @exception SQLException if a database-access error occurs.
*/
public String getCatalog() throws SQLException {
checkIfClosed();
// we do not have support for Catalog, just return null as
// the JDBC specs mentions then.
return null;
}
/**
* You can call this method to try to change the transaction
* isolation level using one of the TRANSACTION_* values.
*
* <P><B>Note:</B> setTransactionIsolation causes the current
* transaction to commit if the isolation level is changed. Otherwise, if
* the requested isolation level is the same as the current isolation
* level, this method is a no-op.
*
* @param level one of the TRANSACTION_* isolation values with the
* exception of TRANSACTION_NONE; some databases may not support
* other values
* @exception SQLException if a database-access error occurs.
* @see DatabaseMetaData#supportsTransactionIsolationLevel
*/
public void setTransactionIsolation(int level) throws SQLException {
if (level == getTransactionIsolation())
return;
// Convert the isolation level to the internal one
int iLevel;
switch (level)
{
case java.sql.Connection.TRANSACTION_READ_UNCOMMITTED:
iLevel = ExecutionContext.READ_UNCOMMITTED_ISOLATION_LEVEL;
break;
case java.sql.Connection.TRANSACTION_READ_COMMITTED:
iLevel = ExecutionContext.READ_COMMITTED_ISOLATION_LEVEL;
break;
case java.sql.Connection.TRANSACTION_REPEATABLE_READ:
iLevel = ExecutionContext.REPEATABLE_READ_ISOLATION_LEVEL;
break;
case java.sql.Connection.TRANSACTION_SERIALIZABLE:
iLevel = ExecutionContext.SERIALIZABLE_ISOLATION_LEVEL;
break;
default:
throw newSQLException(SQLState.UNIMPLEMENTED_ISOLATION_LEVEL, new Integer(level));
}
synchronized(getConnectionSynchronization())
{
setupContextStack();
try {
getLanguageConnection().setIsolationLevel(iLevel);
} catch (StandardException e) {
throw handleException(e);
} finally {
restoreContextStack();
}
}
}
/**
* Get this Connection's current transaction isolation mode.
*
* @return the current TRANSACTION_* mode value
* @exception SQLException if a database-access error occurs.
*/
public final int getTransactionIsolation() throws SQLException {
checkIfClosed();
return ExecutionContext.CS_TO_JDBC_ISOLATION_LEVEL_MAP[getLanguageConnection().getCurrentIsolationLevel()];
}
/**
* The first warning reported by calls on this Connection is
* returned.
*
* <P><B>Note:</B> Subsequent warnings will be chained to this
* SQLWarning.
*
* @return the first SQLWarning or null
*
* Synchronization note: Warnings are synchronized
* on nesting level
*/
public final synchronized SQLWarning getWarnings() throws SQLException {
checkIfClosed();
return topWarning;
}
/**
* After this call, getWarnings returns null until a new warning is
* reported for this Connection.
*
* Synchronization node: Warnings are synchonized
* on nesting level
*/
public final synchronized void clearWarnings() throws SQLException {
checkIfClosed();
topWarning = null;
}
/////////////////////////////////////////////////////////////////////////
//
// JDBC 2.0 - New public methods
//
/////////////////////////////////////////////////////////////////////////
/**
*
* Get the type-map object associated with this connection.
* By default, the map returned is empty.
* JDBC 2.0 - java.util.Map requires JDK 1
*
*/
public java.util.Map getTypeMap() throws SQLException {
checkIfClosed();
// just return an immuntable empty map
return java.util.Collections.EMPTY_MAP;
}
/**
* Install a type-map object as the default type-map for
* this connection.
* JDBC 2.0 - java.util.Map requires JDK 1
*
* @exception SQLException Feature not implemented for now.
*/
public final void setTypeMap(java.util.Map map) throws SQLException {
checkIfClosed();
if( map == null)
throw Util.generateCsSQLException(SQLState.INVALID_API_PARAMETER,map,"map",
"java.sql.Connection.setTypeMap");
if(!(map.isEmpty()))
throw Util.notImplemented();
}
/////////////////////////////////////////////////////////////////////////
//
// Implementation specific methods
//
/////////////////////////////////////////////////////////////////////////
/**
Add a warning to the current list of warnings, to follow
this note from Connection.getWarnings.
Note: Subsequent warnings will be chained to this SQLWarning.
@see java.sql.Connection#getWarnings
*/
public final synchronized void addWarning(SQLWarning newWarning) {
if (topWarning == null) {
topWarning = newWarning;
return;
}
topWarning.setNextWarning(newWarning);
}
/**
* Return the dbname for this connection.
*
* @return String The dbname for this connection.
*/
public String getDBName()
{
if (SanityManager.DEBUG)
SanityManager.ASSERT(!isClosed(), "connection is closed");
return getTR().getDBName();
}
public final LanguageConnectionContext getLanguageConnection() {
if (SanityManager.DEBUG)
SanityManager.ASSERT(!isClosed(), "connection is closed");
return getTR().getLcc();
}
/**
* Raises an exception if the connection is closed.
*
* @exception SQLException if the connection is closed
*/
protected final void checkIfClosed() throws SQLException {
if (isClosed()) {
throw Util.noCurrentConnection();
}
}
//EmbedConnection30 overrides this method so it can release the savepoints array if
//the exception severity is transaction level
SQLException handleException(Throwable thrownException)
throws SQLException
{
//assume in case of SQLException cleanup is
//done already. This assumption is inline with
//TR's assumption. In case no rollback was
//called lob objects will remain valid.
if (thrownException instanceof StandardException) {
if (((StandardException) thrownException)
.getSeverity()
>= ExceptionSeverity.TRANSACTION_SEVERITY) {
clearLOBMapping();
}
}
/*
** By default, rollback the connection on if autocommit
** is on.
*/
return getTR().handleException(thrownException,
autoCommit,
true // Rollback xact on auto commit
);
}
/**
Handle any type of Exception.
<UL>
<LI> Inform the contexts of the error
<LI> Throw an Util based upon the thrown exception.
</UL>
REMIND: now that we know all the exceptions from our driver
are Utils, would it make sense to shut down the system
for unknown SQLExceptions? At present, we do not.
Because this is the last stop for exceptions,
it will catch anything that occurs in it and try
to cleanup before re-throwing them.
@param thrownException the exception
@param rollbackOnAutoCommit rollback the xact on if autocommit is
on, otherwise rollback stmt but leave xact open (and
continue to hold on to locks). Most of the time, this
will be true, excepting operations on result sets, like
getInt().
*/
final SQLException handleException(Throwable thrownException,
boolean rollbackOnAutoCommit)
throws SQLException
{
//assume in case of SQLException cleanup is
//done already. This assumption is inline with
//TR's assumption. In case no rollback was
//called lob objects will remain valid.
if (thrownException instanceof StandardException) {
if (((StandardException) thrownException)
.getSeverity()
>= ExceptionSeverity.TRANSACTION_SEVERITY) {
clearLOBMapping();
}
}
return getTR().handleException(thrownException, autoCommit,
rollbackOnAutoCommit);
}
/*
This is called from the EmbedConnectionContext to
close on errors. We assume all handling of the connectin
is dealt with via the context stack, and our only role
is to mark ourself as closed.
*/
/**
Close the connection when processing errors, or when
closing a nested connection.
<p>
This only marks it as closed and frees up its resources;
any closing of the underlying connection or commit work
is assumed to be done elsewhere.
Called from EmbedConnectionContext's cleanup routine,
and by proxy.close().
*/
public final void setInactive() {
if (active == false)
return;
// active = false
// tr = null !-> active = false
synchronized (getConnectionSynchronization()) {
active = false;
// tr = null; cleanupOnerror sets inactive but still needs tr to
// restore context later
dbMetadata = null;
}
}
/**
@exception Throwable standard error policy
*/
protected void finalize() throws Throwable
{
try {
// Only close root connections, since for nested
// connections, it is not strictly necessary and close()
// synchronizes on the root connection which can cause
// deadlock with the call to runFinalization from
// GenericPreparedStatement#prepareToInvalidate (see
// DERBY-1947) on SUN VMs.
if (rootConnection == this) {
close(exceptionClose);
}
}
finally {
super.finalize();
}
}
/**
* if auto commit is on, remember that we need to commit
* the current statement.
*/
protected void needCommit() {
if (!needCommit) needCommit = true;
}
/**
* if a commit is needed, perform it.
*
* Must have connection synchonization and context set up already.
*
* @exception SQLException if commit returns error
*/
protected void commitIfNeeded() throws SQLException
{
if (autoCommit && needCommit)
{
try
{
getTR().commit();
clearLOBMapping();
}
catch (Throwable t)
{
throw handleException(t);
}
needCommit = false;
}
}
/**
* If in autocommit, then commit.
*
* Used to force a commit after a result set closes in autocommit mode.
* The needCommit mechanism does not work correctly as there are times
* with cursors (like a commit, followed by a next, followed by a close)
* where the system does not think it needs a commit but we need to
* force the commit on close. It seemed safer to just force a commit
* on close rather than count on keeping the needCommit flag correct for
* all cursor cases.
*
* Must have connection synchonization and context set up already.
*
* @exception SQLException if commit returns error
*/
protected void commitIfAutoCommit() throws SQLException
{
if (autoCommit)
{
try
{
getTR().commit();
clearLOBMapping();
}
catch (Throwable t)
{
throw handleException(t);
}
needCommit = false;
}
}
final protected Object getConnectionSynchronization()
{
return rootConnection;
}
/**
Install the context manager for this thread. Check connection status here.
@exception SQLException if fails
*/
protected final void setupContextStack() throws SQLException {
/*
Track this entry, then throw an exception
rather than doing the quiet return. Need the
track before the throw because the backtrack
is in a finally block.
*/
checkIfClosed();
getTR().setupContextStack();
}
protected final void restoreContextStack() throws SQLException {
if (SanityManager.DEBUG)
Util.ASSERT(this, (active) || getTR().getCsf() !=null, "No context service to do restore");
TransactionResourceImpl tr = getTR();
//REMIND: someone is leaving an incorrect manager on when they
// are exiting the system in the nested case.
if (SanityManager.DEBUG)
{
if (tr.getCsf() != null) {
ContextManager cm1 = tr.getCsf().getCurrentContextManager();
ContextManager cm2 = tr.getContextManager();
// If the system has been shut down, cm1 can be null.
// Otherwise, cm1 and cm2 should be identical.
Util.ASSERT(this, (cm1 == cm2 || cm1 == null),
"Current Context Manager not the one was expected: " +
cm1 + " " + cm2);
}
}
tr.restoreContextStack();
}
/*
** Create database methods.
*/
/**
Create a new database.
@param dbname the database name
@param info the properties
@return Database The newly created database or null.
@exception SQLException if fails to create database
*/
private Database createDatabase(String dbname, Properties info)
throws SQLException {
info = filterProperties(info);
try {
if (Monitor.createPersistentService(Property.DATABASE_MODULE, dbname, info) == null)
{
// service already exists, create a warning
addWarning(EmbedSQLWarning.newEmbedSQLWarning(SQLState.DATABASE_EXISTS, dbname));
}
} catch (StandardException mse) {
throw Util.seeNextException(SQLState.CREATE_DATABASE_FAILED,
new Object[] { dbname },
handleException(mse));
}
// clear these values as some modules hang onto
// the properties set corresponding to service.properties
// and they shouldn't be interested in these JDBC attributes.
info.clear();
return (Database) Monitor.findService(Property.DATABASE_MODULE, dbname);
}
/**
* Boot database.
*
* @param info boot properties
*
* @param softAuthenticationBoot If true, don't fail soft upgrade due
* to missing features (phase one of two phased hard upgrade boot).
*
* @return false iff the monitor cannot handle a service
* of the type indicated by the protocol within the name.
* If that's the case then we are the wrong driver.
*
* @throws Throwable if anything else is wrong.
*/
private boolean bootDatabase(Properties info,
boolean softAuthenticationBoot
) throws Throwable
{
String dbname = tr.getDBName();
// boot database now
try {
info = filterProperties(info);
if (softAuthenticationBoot) {
info.setProperty(Attribute.SOFT_UPGRADE_NO_FEATURE_CHECK,
"true");
} else {
info.remove(Attribute.SOFT_UPGRADE_NO_FEATURE_CHECK);
}
// try to start the service if it doesn't already exist
if (!Monitor.startPersistentService(dbname, info)) {
// a false indicates the monitor cannot handle a service
// of the type indicated by the protocol within the name.
// If that's the case then we are the wrong driver
// so just return null.
return false;
}
// clear these values as some modules hang onto
// the properties set corresponding to service.properties
// and they shouldn't be interested in these JDBC attributes.
info.clear();
Database database = (Database) Monitor.findService(Property.DATABASE_MODULE, dbname);
tr.setDatabase(database);
} catch (StandardException mse) {
Throwable ne = mse.getCause();
SQLException nse;
/*
If there is a next exception, assume
that the first one is just a redundant "see the
next exception" message.
if it is a BEI, treat it as a database exception.
If there isn't a BEI, treat it as a java exception.
In general we probably want to walk the chain
and return all of them, but empirically, this
is all we need to do for now.
*/
if (ne instanceof StandardException)
nse = Util.generateCsSQLException((StandardException)ne);
else if (ne != null)
nse = Util.javaException(ne);
else
nse = Util.generateCsSQLException(mse);
throw Util.seeNextException(SQLState.BOOT_DATABASE_FAILED,
new Object[] { dbname }, nse);
}
// If database exists, getDatabase() will return the database object.
// If any error occured while booting an existing database, an
// exception would have been thrown already.
return true;
}
/*
* Class interface methods used by database metadata to ensure
* good relations with autocommit.
*/
PreparedStatement prepareMetaDataStatement(String sql)
throws SQLException {
synchronized (getConnectionSynchronization()) {
setupContextStack();
PreparedStatement s = null;
try {
s = factory.newEmbedPreparedStatement(this, sql, true,
JDBC20Translation.TYPE_FORWARD_ONLY,
JDBC20Translation.CONCUR_READ_ONLY,
connectionHoldAbility,
JDBC30Translation.NO_GENERATED_KEYS,
null,
null);
} finally {
restoreContextStack();
}
return s;
}
}
public final InternalDriver getLocalDriver()
{
if (SanityManager.DEBUG)
SanityManager.ASSERT(!isClosed(), "connection is closed");
return getTR().getDriver();
}
/**
Return the context manager for this connection.
*/
public final ContextManager getContextManager() {
if (SanityManager.DEBUG)
SanityManager.ASSERT(!isClosed(), "connection is closed");
return getTR().getContextManager();
}
/**
* Filter out properties from the passed in set of JDBC attributes
* to remove any derby.* properties. This is to ensure that setting
* derby.* properties does not work this way, it's not a defined way
* to set such properties and could be a secuirty hole in allowing
* remote connections to override system, application or database settings.
*
* @return a new Properties set copied from the parameter but with no
* derby.* properties.
*/
private Properties filterProperties(Properties inputSet) {
Properties limited = new Properties();
// filter out any derby.* properties, only
// JDBC attributes can be set this way
for (java.util.Enumeration e = inputSet.propertyNames(); e.hasMoreElements(); ) {
String key = (String) e.nextElement();
// we don't allow properties to be set this way
if (key.startsWith("derby."))
continue;
limited.put(key, inputSet.getProperty(key));
}
return limited;
}
/*
** methods to be overridden by subimplementations wishing to insert
** their classes into the mix.
*/
protected Database getDatabase()
{
if (SanityManager.DEBUG)
SanityManager.ASSERT(!isClosed(), "connection is closed");
return getTR().getDatabase();
}
final protected TransactionResourceImpl getTR()
{
return rootConnection.tr;
}
private EmbedConnectionContext pushConnectionContext(ContextManager cm) {
return new EmbedConnectionContext(cm, this);
}
public final void setApplicationConnection(java.sql.Connection applicationConnection) {
this.applicationConnection = applicationConnection;
}
public final java.sql.Connection getApplicationConnection() {
return applicationConnection;
}
public void setDrdaID(String drdaID) {
getLanguageConnection().setDrdaID(drdaID);
}
/**
Reset the connection before it is returned from a PooledConnection
to a new application request (wrapped by a BrokeredConnection).
Examples of reset covered here is dropping session temporary tables
and reseting IDENTITY_VAL_LOCAL.
Most JDBC level reset is handled by calling standard java.sql.Connection
methods from EmbedPooledConnection.
*/
public void resetFromPool() throws SQLException {
synchronized (getConnectionSynchronization())
{
setupContextStack();
try {
getLanguageConnection().resetFromPool();
} catch (StandardException t) {
throw handleException(t);
}
finally
{
restoreContextStack();
}
}
}
/*
** methods to be overridden by subimplementations wishing to insert
** their classes into the mix.
** The reason we need to override them is because we want to create a
** Local20/LocalStatment object (etc) rather than a Local/LocalStatment
** object (etc).
*/
/*
** XA support
*/
/**
* Do not use this method directly use XATransactionState.xa_prepare
* instead because it also maintains/cancels the timout task which is
* scheduled to cancel/rollback the global transaction.
*/
public final int xa_prepare() throws SQLException {
synchronized (getConnectionSynchronization())
{
setupContextStack();
try
{
XATransactionController tc =
(XATransactionController) getLanguageConnection().getTransactionExecute();
int ret = tc.xa_prepare();
if (ret == XATransactionController.XA_RDONLY)
{
// On a prepare call, xa allows an optimization that if the
// transaction is read only, the RM can just go ahead and
// commit it. So if store returns this read only status -
// meaning store has taken the liberty to commit already - we
// needs to turn around and call internalCommit (without
// committing the store again) to make sure the state is
// consistent. Since the transaction is read only, there is
// probably not much that needs to be done.
getLanguageConnection().internalCommit(false /* don't commitStore again */);
}
return ret;
} catch (StandardException t)
{
throw handleException(t);
}
finally
{
restoreContextStack();
}
}
}
/**
* Do not use this method directly use XATransactionState.xa_commit
* instead because it also maintains/cancels the timout task which is
* scheduled to cancel/rollback the global transaction.
*/
public final void xa_commit(boolean onePhase) throws SQLException {
synchronized (getConnectionSynchronization())
{
setupContextStack();
try
{
getLanguageConnection().xaCommit(onePhase);
} catch (StandardException t)
{
throw handleException(t);
}
finally
{
restoreContextStack();
}
}
}
/**
* Do not use this method directly use XATransactionState.xa_rollback
* instead because it also maintains/cancels the timout task which is
* scheduled to cancel/rollback the global transaction.
*/
public final void xa_rollback() throws SQLException {
synchronized (getConnectionSynchronization())
{
setupContextStack();
try
{
getLanguageConnection().xaRollback();
} catch (StandardException t)
{
throw handleException(t);
}
finally
{
restoreContextStack();
}
}
}
/**
* returns false if there is an underlying transaction and that transaction
* has done work. True if there is no underlying transaction or that
* underlying transaction is idle
*/
public final boolean transactionIsIdle()
{
return getTR().isIdle();
}
private int setResultSetType(int resultSetType) {
/* Add warning if scroll sensitive cursor
* and downgrade to scroll insensitive cursor.
*/
if (resultSetType == JDBC20Translation.TYPE_SCROLL_SENSITIVE)
{
addWarning(EmbedSQLWarning.newEmbedSQLWarning(SQLState.NO_SCROLL_SENSITIVE_CURSORS));
resultSetType = JDBC20Translation.TYPE_SCROLL_INSENSITIVE;
}
return resultSetType;
}
/**
* Set the transaction isolation level that will be used for the
* next prepare. Used by network server to implement DB2 style
* isolation levels.
* @param level Isolation level to change to. level is the DB2 level
* specified in the package names which happen to correspond
* to our internal levels. If
* level == ExecutionContext.UNSPECIFIED_ISOLATION,
* the statement won't be prepared with an isolation level.
*
*
*/
public void setPrepareIsolation(int level) throws SQLException
{
if (level == getPrepareIsolation())
return;
switch (level)
{
case ExecutionContext.READ_UNCOMMITTED_ISOLATION_LEVEL:
case ExecutionContext.REPEATABLE_READ_ISOLATION_LEVEL:
case ExecutionContext.READ_COMMITTED_ISOLATION_LEVEL:
case ExecutionContext.SERIALIZABLE_ISOLATION_LEVEL:
case ExecutionContext.UNSPECIFIED_ISOLATION_LEVEL:
break;
default:
throw Util.generateCsSQLException(
SQLState.UNIMPLEMENTED_ISOLATION_LEVEL, new Integer(level));
}
synchronized(getConnectionSynchronization())
{
getLanguageConnection().setPrepareIsolationLevel(level);
}
}
/**
* Return prepare isolation
*/
public int getPrepareIsolation()
{
return getLanguageConnection().getPrepareIsolationLevel();
}
/**
Return a unique order number for a result set.
A unique value is only needed if the result set is
being created within procedure and thus must be using
a nested connection.
*/
final int getResultSetOrderId() {
if (this == rootConnection) {
return 0;
} else {
return rootConnection.resultSetId++;
}
}
protected SQLException newSQLException(String messageId) {
return Util.generateCsSQLException(messageId);
}
protected SQLException newSQLException(String messageId, Object arg1) {
return Util.generateCsSQLException(messageId, arg1);
}
protected SQLException newSQLException(String messageId, Object arg1, Object arg2) {
return Util.generateCsSQLException(messageId, arg1, arg2);
}
/////////////////////////////////////////////////////////////////////////
//
// OBJECT OVERLOADS
//
/////////////////////////////////////////////////////////////////////////
/**
* Get a String representation that uniquely identifies
* this connection. Include the same information that is
* printed in the log for various trace and error messages.
*
* In Derby the "physical" connection is a LanguageConnectionContext,
* or LCC.
* The JDBC Connection is an JDBC-specific layer on top of this. Rather
* than create a new id here, we simply use the id of the underlying LCC.
* Note that this is a big aid in debugging, because much of the
* engine trace and log code prints the LCC id.
*
* @return a string representation for this connection
*/
public String toString()
{
if ( connString == null )
{
LanguageConnectionContext lcc = getLanguageConnection();
connString =
this.getClass().getName() + "@" + this.hashCode() + " " +
lcc.xidStr +
lcc.getTransactionExecute().getTransactionIdString() +
"), " +
lcc.lccStr +
Integer.toString(lcc.getInstanceNumber()) + "), " +
lcc.dbnameStr + lcc.getDbname() + "), " +
lcc.drdaStr + lcc.getDrdaID() + ") ";
}
return connString;
}
/**
*
* Constructs an object that implements the <code>Clob</code> interface. The object
* returned initially contains no data. The <code>setAsciiStream</code>,
* <code>setCharacterStream</code> and <code>setString</code> methods of
* the <code>Clob</code> interface may be used to add data to the <code>Clob</code>.
*
* @return An object that implements the <code>Clob</code> interface
* @throws SQLException if an object that implements the
* <code>Clob</code> interface can not be constructed, this method is
* called on a closed connection or a database access error occurs.
*
*/
public Clob createClob() throws SQLException {
checkIfClosed();
return new EmbedClob(this);
}
/**
*
* Constructs an object that implements the <code>Blob</code> interface. The object
* returned initially contains no data. The <code>setBinaryStream</code> and
* <code>setBytes</code> methods of the <code>Blob</code> interface may be used to add data to
* the <code>Blob</code>.
*
* @return An object that implements the <code>Blob</code> interface
* @throws SQLException if an object that implements the
* <code>Blob</code> interface can not be constructed, this method is
* called on a closed connection or a database access error occurs.
*
*/
public Blob createBlob() throws SQLException {
checkIfClosed();
return new EmbedBlob(new byte[0], this);
}
/**
* Add the locator and the corresponding LOB object into the
* HashMap
*
* @param LOBReference The object which contains the LOB object that
* that is added to the HashMap.
* @return an integer that represents the locator that has been
* allocated to this LOB.
*/
public int addLOBMapping(Object LOBReference) {
int loc = getIncLOBKey();
getlobHMObj().put(new Integer(loc), LOBReference);
return loc;
}
/**
* Remove the key(LOCATOR) from the hash table.
* @param key an integer that represents the locator that needs to be
* removed from the table.
*/
public void removeLOBMapping(int key) {
getlobHMObj().remove(new Integer(key));
}
/**
* Get the LOB reference corresponding to the locator.
* @param key the integer that represents the LOB locator value.
* @return the LOB Object corresponding to this locator.
*/
public Object getLOBMapping(int key) {
return getlobHMObj().get(new Integer(key));
}
/**
* Clear the HashMap of all entries.
* Called when a commit or rollback of the transaction
* happens.
*/
public void clearLOBMapping() throws SQLException {
//free all the lob resources in the HashMap
//initialize the locator value to 0 and
//the hash table object to null.
if (rootConnection.lobHashMap != null) {
for (Iterator e = getlobHMObj().values().iterator();
e.hasNext() ;) {
Object obj = e.next();
if (obj instanceof Clob) {
EmbedClob temp = (EmbedClob)obj;
temp.free();
}
if (obj instanceof Blob) {
EmbedBlob temp = (EmbedBlob)obj;
temp.free();
}
}
getlobHMObj().clear();
}
}
/**
* Return the current locator value
* @return an integer that represents the most recent locator value.
*/
private int getIncLOBKey() {
return ++rootConnection.lobHMKey;
}
/**
* Return the Hash Map in the root connection
* @return the HashMap that contains the locator to LOB object mapping
*/
public HashMap getlobHMObj() {
if (rootConnection.lobHashMap == null) {
rootConnection.lobHashMap = new HashMap();
}
return rootConnection.lobHashMap;
}
/** Cancels the current running statement. */
public void cancelRunningStatement() {
getLanguageConnection().getStatementContext().cancel();
}
}