/*

  * 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.commons.dbcp.cpdsadapter;

 import java.sql.Connection;

 import java.sql.PreparedStatement;

 import java.sql.SQLException;

 import org.apache.commons.dbcp.DelegatingConnection;

 import org.apache.commons.dbcp.DelegatingPreparedStatement;

 /**

  * This class is the <code>Connection</code> that will be returned

  * from <code>PooledConnectionImpl.getConnection()</code>.  

  * Most methods are wrappers around the jdbc 1.x <code>Connection</code>.  

  * A few exceptions include preparedStatement and close.

  * In accordance with the jdbc specification this Connection cannot

  * be used after closed() is called.  Any further usage will result in an

  * SQLException.

  * 

  * ConnectionImpl extends DelegatingConnection to enable access to the

  * underlying connection.

  *

  * @author John D. McNally

  * @version $Revision: 1023401 $ $Date: 2010-10-16 21:54:24 -0400 (Sat, 16 Oct 2010) $

  */

 class ConnectionImpl extends DelegatingConnection {

     private final boolean accessToUnderlyingConnectionAllowed;

     /** The object that instantiated this object */

      private final PooledConnectionImpl pooledConnection;

     /**

      * Creates a <code>ConnectionImpl</code>. 

      *

      * @param pooledConnection The PooledConnection that is calling the ctor.

      * @param connection The JDBC 1.x Connection to wrap.

      * @param accessToUnderlyingConnectionAllowed if true, then access is allowed to the underlying connectiion

      */

     ConnectionImpl(PooledConnectionImpl pooledConnection, 

             Connection connection,

             boolean accessToUnderlyingConnectionAllowed) {

         super(connection);

         this.pooledConnection = pooledConnection;

         this.accessToUnderlyingConnectionAllowed =

             accessToUnderlyingConnectionAllowed;

     }

     /**

      * Marks the Connection as closed, and notifies the pool that the

      * pooled connection is available.

      * In accordance with the jdbc specification this Connection cannot

      * be used after closed() is called.  Any further usage will result in an

      * SQLException.

      *

      * @exception SQLException The database connection couldn't be closed.

      */

     public void close() throws SQLException {

         if (!_closed) {

             _closed = true;

             passivate();

             pooledConnection.notifyListeners();

         }

     }

     /**

      * If pooling of <code>PreparedStatement</code>s is turned on in the

      * {@link DriverAdapterCPDS}, a pooled object may be returned, otherwise

      * delegate to the wrapped jdbc 1.x {@link java.sql.Connection}.

      *

      * @param sql SQL statement to be prepared

      * @return the prepared statement

      * @exception SQLException if this connection is closed or an error occurs

      * in the wrapped connection.

      */

     public PreparedStatement prepareStatement(String sql) throws SQLException {

         checkOpen();

         try {

             return new DelegatingPreparedStatement

                 (this, pooledConnection.prepareStatement(sql));

         }

         catch (SQLException e) {

             handleException(e); // Does not return

             return null;

         }

     }

     /**

      * If pooling of <code>PreparedStatement</code>s is turned on in the

      * {@link DriverAdapterCPDS}, a pooled object may be returned, otherwise

      * delegate to the wrapped jdbc 1.x {@link java.sql.Connection}.

      *

      * @exception SQLException if this connection is closed or an error occurs

      * in the wrapped connection.

      */

     public PreparedStatement prepareStatement(String sql, int resultSetType, 

                                               int resultSetConcurrency) 

             throws SQLException {

         checkOpen();

         try {

             return new DelegatingPreparedStatement

                 (this, pooledConnection.prepareStatement

                     (sql,resultSetType,resultSetConcurrency));

         }

         catch (SQLException e) {

             handleException(e);

             return null;

         }

     }

     public PreparedStatement prepareStatement(String sql, int resultSetType,

                                               int resultSetConcurrency,

                                               int resultSetHoldability)

             throws SQLException {

         checkOpen();

         try {

             return new DelegatingPreparedStatement(this,

                     pooledConnection.prepareStatement(sql, resultSetType,

                             resultSetConcurrency, resultSetHoldability));

         }

         catch (SQLException e) {

             handleException(e);

             return null;

         }

     }

     public PreparedStatement prepareStatement(String sql, int autoGeneratedKeys)

             throws SQLException {

         checkOpen();

         try {

             return new DelegatingPreparedStatement(this,

                     pooledConnection.prepareStatement(sql, autoGeneratedKeys));

         }

         catch (SQLException e) {

             handleException(e);

             return null;

         }

     }

     public PreparedStatement prepareStatement(String sql, int columnIndexes[])

             throws SQLException {

         checkOpen();

         try {

             return new DelegatingPreparedStatement(this,

                     pooledConnection.prepareStatement(sql, columnIndexes));

         }

         catch (SQLException e) {

             handleException(e);

             return null;

         }

     }

     public PreparedStatement prepareStatement(String sql, String columnNames[])

             throws SQLException {

         checkOpen();

         try {

             return new DelegatingPreparedStatement(this,

                     pooledConnection.prepareStatement(sql, columnNames));

         }

         catch (SQLException e) {

             handleException(e);

             return null;

         }

     }

     //

     // Methods for accessing the delegate connection

     //

     /**

      * If false, getDelegate() and getInnermostDelegate() will return null.

      * @return true if access is allowed to the underlying connection

      * @see ConnectionImpl

      */

     public boolean isAccessToUnderlyingConnectionAllowed() {

         return accessToUnderlyingConnectionAllowed;

     }

     /**

      * Get the delegated connection, if allowed.

      * @return the internal connection, or null if access is not allowed.

      * @see #isAccessToUnderlyingConnectionAllowed()

      */

     public Connection getDelegate() {

         if (isAccessToUnderlyingConnectionAllowed()) {

             return getDelegateInternal();

         } else {

             return null;

         }

     }

     /**

      * Get the innermost connection, if allowed.

      * @return the innermost internal connection, or null if access is not allowed.

      * @see #isAccessToUnderlyingConnectionAllowed()

      */

     public Connection getInnermostDelegate() {

         if (isAccessToUnderlyingConnectionAllowed()) {

             return super.getInnermostDelegateInternal();

         } else {

             return null;

         }

     }

 }