Glassfish example source code file (ProfiledConnectionWrapper40.java)

This example Glassfish source code file (ProfiledConnectionWrapper40.java) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Java - Glassfish tags/keywords

callablestatement, callablestatementwrapper40, class, class, jdbc, object, preparedstatement, preparedstatement, preparedstatementwrapper40, preparedstatementwrapper40, reflection, sql, sqlexception, sqlexception, statement, statementwrapper40, t

The Glassfish ProfiledConnectionWrapper40.java source code

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package com.sun.gjc.spi.jdbc40;

import com.sun.gjc.spi.ManagedConnection;
import com.sun.gjc.spi.base.ConnectionWrapper;
import com.sun.gjc.util.SQLTraceDelegator;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
import java.sql.CallableStatement;
import java.sql.Connection;
import java.sql.DatabaseMetaData;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Statement;
import org.glassfish.api.jdbc.SQLTraceRecord;

/**
 * Wrapper class that aids to provide wrapper for Statement, PreparedStatement, 
 * CallableStatement, DatabaseMetaData. Along with providing a wrapper, this
 * aids in logging the SQL statements executed by the various applications. 
 * 
 * @author Shalini M
 */
public class ProfiledConnectionWrapper40 extends ConnectionHolder40 implements ConnectionWrapper {
    
    private SQLTraceDelegator sqlTraceDelegator;

    /**
     * Instantiates connection wrapper to wrap JDBC objects.
     * @param con Connection that is wrapped
     * @param mc  Managed Connection
     * @param cxRequestInfo  Connection Request Info
     */
    public ProfiledConnectionWrapper40(Connection con, ManagedConnection mc,
            javax.resource.spi.ConnectionRequestInfo cxRequestInfo,
            boolean jdbc30Connection, SQLTraceDelegator delegator) {
        super(con, mc, cxRequestInfo, jdbc30Connection);
        this.sqlTraceDelegator = delegator;
    }

    /**
     * Creates a statement from the underlying Connection
     *
     * @return <code>Statement object.
     * @throws java.sql.SQLException In case of a database error.
     */
    public Statement createStatement() throws SQLException {
        Statement output = null;
        Class intf[] = new Class[]{java.sql.Statement.class};
        try {
            output = (java.sql.Statement) getProxyObject(
                    new StatementWrapper40(this, super.createStatement()), intf);
        } catch (Exception e) {
            //TODO SQLexception or any other type?
            throw new SQLException(e.getMessage());
        }
        output = super.createStatement();
        return output;
    }

    /**
     * Creates a statement from the underlying Connection.
     *
     * @param resultSetType        Type of the ResultSet
     * @param resultSetConcurrency ResultSet Concurrency.
     * @return <code>Statement object.
     * @throws SQLException In case of a database error.
     */
    public Statement createStatement(int resultSetType, int resultSetConcurrency) throws SQLException {
        Statement output = null;
        Class intf[] = new Class[]{java.sql.Statement.class};
        try{
            output = (java.sql.Statement)getProxyObject(
                    new StatementWrapper40(this, 
                    super.createStatement(resultSetType, resultSetConcurrency)), intf);
        }catch(Exception e){
            throw new SQLException(e.getMessage());
        }
        return output;
    }

    /**
     * Creates a statement from the underlying Connection.
     *
     * @param resultSetType        Type of the ResultSet
     * @param resultSetConcurrency ResultSet Concurrency.
     * @param resultSetHoldability ResultSet Holdability.
     * @return <code>Statement object.
     * @throws SQLException In case of a database error.
     */
    public Statement createStatement(int resultSetType, int resultSetConcurrency,
            int resultSetHoldability) throws SQLException {
        Statement output = null;
        Class intf[] = new Class[]{java.sql.Statement.class};
        try{
            output = (java.sql.Statement)getProxyObject(
                    new StatementWrapper40(this, 
                    super.createStatement(resultSetType, resultSetConcurrency, resultSetHoldability)), 
                    intf);
        }catch(Exception e){
            throw new SQLException(e.getMessage());
        }
        return output;
    }

    /**
     * Retrieves the <code>DatabaseMetaDataobject from the underlying
     * <code> Connection  object.
     *
     * @return <code>DatabaseMetaData object.
     * @throws SQLException In case of a database error.
     */
    public DatabaseMetaData getMetaData() throws SQLException {
        return new DatabaseMetaDataWrapper40(this, super.getMetaData());
    }

    /**
     * Creates a <code> CallableStatement  object for calling database
     * stored procedures.
     *
     * @param sql SQL Statement
     * @return <code> CallableStatement object.
     * @throws java.sql.SQLException In case of a database error.
     */
    public CallableStatement prepareCall(String sql) throws SQLException {
        CallableStatement output = null;
        Class intf[] = new Class[]{java.sql.CallableStatement.class};
        try{
            output = (java.sql.CallableStatement)getProxyObject(
                    mc.prepareCachedCallableStatement(this,sql, ResultSet.TYPE_FORWARD_ONLY, ResultSet.CONCUR_READ_ONLY), 
                    intf);
        }catch(Exception e){
            throw new SQLException(e.getMessage());
        }
        return output;
    }

    /**
     * Creates a <code> CallableStatement  object for calling database
     * stored procedures.
     *
     * @param sql                  SQL Statement
     * @param resultSetType        Type of the ResultSet
     * @param resultSetConcurrency ResultSet Concurrency.
     * @return <code> CallableStatement object.
     * @throws SQLException In case of a database error.
     */
    public CallableStatement prepareCall(String sql, int resultSetType,
            int resultSetConcurrency) throws SQLException {
        CallableStatement output = null;
        Class intf[] = new Class[]{java.sql.CallableStatement.class};
        try{
            output = (java.sql.CallableStatement)getProxyObject(
                    mc.prepareCachedCallableStatement(this, sql, resultSetType, resultSetConcurrency), 
                    intf);
        }catch(Exception e){
            throw new SQLException(e.getMessage());
        }
        return output;        
    }

    /**
     * Creates a <code> CallableStatement  object for calling database
     * stored procedures.
     *
     * @param sql                  SQL Statement
     * @param resultSetType        Type of the ResultSet
     * @param resultSetConcurrency ResultSet Concurrency.
     * @param resultSetHoldability ResultSet Holdability.
     * @return <code> CallableStatement object.
     * @throws SQLException In case of a database error.
     */
    public CallableStatement prepareCall(String sql, int resultSetType,
            int resultSetConcurrency,
            int resultSetHoldability) throws SQLException {
        CallableStatement output = null;
        Class intf[] = new Class[]{java.sql.CallableStatement.class};
        try{
            output = (java.sql.CallableStatement)getProxyObject(
                    mc.prepareCachedCallableStatement(this, sql, resultSetType, resultSetConcurrency, resultSetHoldability), 
                    intf);
        }catch(Exception e){
            throw new SQLException(e.getMessage());
        }
        return output;        
    }

    /**
     * Creates a <code> PreparedStatement  object for sending
     * paramterized SQL statements to database
     *
     * @param sql SQL Statement
     * @return <code> PreparedStatement object.
     * @throws SQLException In case of a database error.
     */
    public PreparedStatement prepareStatement(String sql) throws SQLException {
        PreparedStatement output = null;
        Class intf[] = new Class[]{java.sql.PreparedStatement.class};
        
        try{
            output = (PreparedStatement)getProxyObject(
                    mc.prepareCachedStatement(this, sql, 
                    ResultSet.TYPE_FORWARD_ONLY, ResultSet.CONCUR_READ_ONLY),
                    intf);
        }catch(Exception e){
            throw new SQLException(e.getMessage());
        }
        return output;        
    }

    /**
     * Creates a <code> PreparedStatement  object for sending
     * paramterized SQL statements to database
     *
     * @param sql               SQL Statement
     * @param autoGeneratedKeys a flag indicating AutoGeneratedKeys need to be returned.
     * @return <code> PreparedStatement object.
     * @throws SQLException In case of a database error.
     */
    public PreparedStatement prepareStatement(String sql, int autoGeneratedKeys) throws SQLException {
        PreparedStatement output = null;
        Class intf[] = new Class[]{java.sql.PreparedStatement.class};
        try{
            output = (PreparedStatement)getProxyObject(
                    mc.prepareCachedStatement(this, sql, autoGeneratedKeys), intf);
        }catch(Exception e){
            throw new SQLException(e.getMessage());
        }
        return output;
    }

    /**
     * Creates a <code> PreparedStatement  object for sending
     * paramterized SQL statements to database
     *
     * @param sql           SQL Statement
     * @param columnIndexes an array of column indexes indicating the columns that should be
     *                      returned from the inserted row or rows.
     * @return <code> PreparedStatement object.
     * @throws SQLException In case of a database error.
     */
    public PreparedStatement prepareStatement(String sql, int[] columnIndexes) throws SQLException {
            PreparedStatement output = null;
        Class intf[] = new Class[]{java.sql.PreparedStatement.class};
        try{
            output = (PreparedStatement)getProxyObject(
                    mc.prepareCachedStatement(this, sql, columnIndexes), intf);
        }catch(Exception e){
            throw new SQLException(e.getMessage());
        }
        return output;
    }

    /**
     * Creates a <code> PreparedStatement  object for sending
     * paramterized SQL statements to database
     *
     * @param sql                  SQL Statement
     * @param resultSetType        Type of the ResultSet
     * @param resultSetConcurrency ResultSet Concurrency.
     * @return <code> PreparedStatement object.
     * @throws SQLException In case of a database error.
     */
    public PreparedStatement prepareStatement(String sql, int resultSetType,
            int resultSetConcurrency) throws SQLException {
        PreparedStatement output = null;
        Class intf[] = new Class[]{java.sql.PreparedStatement.class};
        try{
            output = (PreparedStatement)getProxyObject(
                    mc.prepareCachedStatement(this, sql, resultSetType, resultSetConcurrency), 
                    intf);
        }catch(Exception e){
            throw new SQLException(e.getMessage());
        }
        return output;
    }

    /**
     * Creates a <code> PreparedStatement  object for sending
     * paramterized SQL statements to database
     *
     * @param sql                  SQL Statement
     * @param resultSetType        Type of the ResultSet
     * @param resultSetConcurrency ResultSet Concurrency.
     * @param resultSetHoldability ResultSet Holdability.
     * @return <code> PreparedStatement object.
     * @throws SQLException In case of a database error.
     */
    public PreparedStatement prepareStatement(String sql, int resultSetType,
            int resultSetConcurrency,
            int resultSetHoldability) throws SQLException {
        PreparedStatement output = null;
        Class intf[] = new Class[]{java.sql.PreparedStatement.class};
        try{
            output = (PreparedStatement)getProxyObject(
                    mc.prepareCachedStatement(this, sql, resultSetType, resultSetConcurrency, resultSetHoldability), 
                    intf);
        }catch(Exception e){
            throw new SQLException(e.getMessage());
        }
        return output;        
    }

    /**
     * Creates a <code> PreparedStatement  object for sending
     * paramterized SQL statements to database
     *
     * @param sql         SQL Statement
     * @param columnNames Name of bound columns.
     * @return <code> PreparedStatement object.
     * @throws SQLException In case of a database error.
     */
    public PreparedStatement prepareStatement(String sql, String[] columnNames) throws SQLException {
        checkValidity();
        jdbcPreInvoke();
        PreparedStatement output = null;
        Class intf[] = new Class[]{java.sql.PreparedStatement.class};
        try{
            output = (PreparedStatement)getProxyObject(mc.prepareCachedStatement(this, sql, columnNames), 
                    intf);
        }catch(Exception e){
            throw new SQLException(e.getMessage());
        }
        return output;
        
    }

    public PreparedStatementWrapper40 prepareCachedStatement(String sql,
            int resultSetType, int resultSetConcurrency, boolean enableCaching)
            throws SQLException {
        return new PreparedStatementWrapper40(this, super.prepareStatement(sql,
                resultSetType, resultSetConcurrency), enableCaching);
    }

    public PreparedStatementWrapper40 prepareCachedStatement(String sql,
            String[] columnNames, boolean enableCaching)
            throws SQLException {
        return new PreparedStatementWrapper40(this,
                super.prepareStatement(sql, columnNames), enableCaching);
    }

    public PreparedStatementWrapper40 prepareCachedStatement(String sql,
            int resultSetType, int resultSetConcurrency, int resultSetHoldability,
            boolean enableCaching) throws SQLException {
        return new PreparedStatementWrapper40(this,
                super.prepareCall(sql, resultSetType, resultSetConcurrency, resultSetHoldability),
                enableCaching);
    }

    public PreparedStatementWrapper40 prepareCachedStatement(String sql,
            int[] columnIndexes, boolean enableCaching)
            throws SQLException {
        return new PreparedStatementWrapper40(this,
                super.prepareStatement(sql, columnIndexes), enableCaching);
    }

    public PreparedStatementWrapper40 prepareCachedStatement(String sql,
            int autoGeneratedKeys, boolean enableCaching)
            throws SQLException {
        return new PreparedStatementWrapper40(this,
                super.prepareStatement(sql, autoGeneratedKeys), enableCaching);
    }

    public CallableStatementWrapper40 callableCachedStatement(String sql,
            int resultSetType, int resultSetConcurrency, boolean enableCaching)
            throws SQLException {
        return new CallableStatementWrapper40(this, super.prepareCall(sql,
                resultSetType, resultSetConcurrency), enableCaching);
    }

    public CallableStatementWrapper40 callableCachedStatement(String sql,
            int resultSetType, int resultSetConcurrency,
            int resultSetHoldability, boolean enableCaching)
            throws SQLException {
        return new CallableStatementWrapper40(this, super.prepareCall(sql,
                resultSetType, resultSetConcurrency, resultSetHoldability),
                enableCaching);
    }

    //TODO refactor this method and move to a higher level
    private <T> T getProxyObject(final Object actualObject, Class[] ifaces) throws Exception {
        
        T result;
        InvocationHandler ih = new InvocationHandler() {

            public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
                SQLTraceRecord record = new SQLTraceRecord();
                record.setMethodName(method.getName());
                record.setParams(args);
                record.setClassName(actualObject.getClass().getName());
                record.setThreadName(Thread.currentThread().getName());
                record.setThreadID(Thread.currentThread().getId());
                record.setTimeStamp(System.currentTimeMillis());
                sqlTraceDelegator.sqlTrace(record);
                return method.invoke(actualObject, args);
            }
        };
        result = (T) Proxy.newProxyInstance(actualObject.getClass().getClassLoader(), ifaces, ih);
        return result;
    }

}