Open Source Repository

Home /spring/spring-jdbc-3.0.5 | Repository Home



org/springframework/jdbc/support/nativejdbc/JBossNativeJdbcExtractor.java
/*
 * Copyright 2002-2008 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.jdbc.support.nativejdbc;

import java.lang.reflect.Method;
import java.sql.CallableStatement;
import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Statement;

import org.springframework.util.ReflectionUtils;

/**
 * Implementation of the {@link NativeJdbcExtractor} interface for JBoss,
 * supporting JBoss Application Server 3.2.4+.
 *
 <p>Returns the underlying native Connection, Statement, etc to
 * application code instead of JBoss' wrapper implementations.
 * The returned JDBC classes can then safely be cast, e.g. to
 <code>oracle.jdbc.OracleConnection</code>.
 *
 <p>This NativeJdbcExtractor can be set just to <i>allow</i> working with
 * a JBoss connection pool: If a given object is not a JBoss wrapper,
 * it will be returned as-is.
 *
 @author Juergen Hoeller
 @since 03.01.2004
 @see org.jboss.resource.adapter.jdbc.WrappedConnection#getUnderlyingConnection
 @see org.jboss.resource.adapter.jdbc.WrappedStatement#getUnderlyingStatement
 @see org.jboss.resource.adapter.jdbc.WrappedResultSet#getUnderlyingResultSet
 */
public class JBossNativeJdbcExtractor extends NativeJdbcExtractorAdapter {

  private static final String WRAPPED_CONNECTION_NAME = "org.jboss.resource.adapter.jdbc.WrappedConnection";

  private static final String WRAPPED_STATEMENT_NAME = "org.jboss.resource.adapter.jdbc.WrappedStatement";

  private static final String WRAPPED_RESULT_SET_NAME = "org.jboss.resource.adapter.jdbc.WrappedResultSet";


  private Class wrappedConnectionClass;

  private Class wrappedStatementClass;

  private Class wrappedResultSetClass;

  private Method getUnderlyingConnectionMethod;

  private Method getUnderlyingStatementMethod;

  private Method getUnderlyingResultSetMethod;


  /**
   * This constructor retrieves JBoss JDBC wrapper classes,
   * so we can get the underlying vendor connection using reflection.
   */
  public JBossNativeJdbcExtractor() {
    try {
      this.wrappedConnectionClass = getClass().getClassLoader().loadClass(WRAPPED_CONNECTION_NAME);
      this.wrappedStatementClass = getClass().getClassLoader().loadClass(WRAPPED_STATEMENT_NAME);
      this.wrappedResultSetClass = getClass().getClassLoader().loadClass(WRAPPED_RESULT_SET_NAME);
      this.getUnderlyingConnectionMethod =
          this.wrappedConnectionClass.getMethod("getUnderlyingConnection"(Class[]) null);
      this.getUnderlyingStatementMethod =
          this.wrappedStatementClass.getMethod("getUnderlyingStatement"(Class[]) null);
      this.getUnderlyingResultSetMethod =
          this.wrappedResultSetClass.getMethod("getUnderlyingResultSet"(Class[]) null);
    }
    catch (Exception ex) {
      throw new IllegalStateException(
          "Could not initialize JBossNativeJdbcExtractor because JBoss API classes are not available: " + ex);
    }
  }


  /**
   * Retrieve the Connection via JBoss' <code>getUnderlyingConnection</code> method.
   */
  @Override
  protected Connection doGetNativeConnection(Connection conthrows SQLException {
    if (this.wrappedConnectionClass.isAssignableFrom(con.getClass())) {
      return (ConnectionReflectionUtils.invokeJdbcMethod(this.getUnderlyingConnectionMethod, con);
    }
    return con;
  }

  /**
   * Retrieve the Connection via JBoss' <code>getUnderlyingStatement</code> method.
   */
  @Override
  public Statement getNativeStatement(Statement stmtthrows SQLException {
    if (this.wrappedStatementClass.isAssignableFrom(stmt.getClass())) {
      return (StatementReflectionUtils.invokeJdbcMethod(this.getUnderlyingStatementMethod, stmt);
    }
    return stmt;
  }

  /**
   * Retrieve the Connection via JBoss' <code>getUnderlyingStatement</code> method.
   */
  @Override
  public PreparedStatement getNativePreparedStatement(PreparedStatement psthrows SQLException {
    return (PreparedStatementgetNativeStatement(ps);
  }

  /**
   * Retrieve the Connection via JBoss' <code>getUnderlyingStatement</code> method.
   */
  @Override
  public CallableStatement getNativeCallableStatement(CallableStatement csthrows SQLException {
    return (CallableStatementgetNativeStatement(cs);
  }

  /**
   * Retrieve the Connection via JBoss' <code>getUnderlyingResultSet</code> method.
   */
  @Override
  public ResultSet getNativeResultSet(ResultSet rsthrows SQLException {
    if (this.wrappedResultSetClass.isAssignableFrom(rs.getClass())) {
      return (ResultSetReflectionUtils.invokeJdbcMethod(this.getUnderlyingResultSetMethod, rs);
    }
    return rs;
  }
  
}