com.rapiddweller.jdbacl.proxy.LoggingResultSetHandler Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of rd-lib-jdbacl Show documentation
'jdbacl' stands for 'Java DataBase ACcess Layer' and provides utilities for accessing JDBC databases from Java programs, retrieving meta information in an object model and querying database data. 'rapiddweller jdbacl' is forked from Databene jdbacl by Volker Bergmann.
The newest version!
/*
 * (c) Copyright 2011 by Volker Bergmann. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, is permitted under the terms of the
 * GNU General Public License (GPL).
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * WITHOUT A WARRANTY OF ANY KIND. ALL EXPRESS OR IMPLIED CONDITIONS,
 * REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE
 * HEREBY EXCLUDED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

package com.rapiddweller.jdbacl.proxy;

import com.rapiddweller.common.BeanUtil;
import com.rapiddweller.common.ConfigurationError;
import com.rapiddweller.common.LogCategoriesConstants;
import com.rapiddweller.common.debug.Debug;
import com.rapiddweller.common.debug.ResourceMonitor;
import org.slf4j.LoggerFactory;
import org.slf4j.Logger;

import java.lang.reflect.InvocationHandler;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Statement;
import java.util.concurrent.atomic.AtomicInteger;

/**
 * {@link InvocationHandler} for the {@link ResultSet} interface
 * that logs certain calls to the category {@link LogCategoriesConstants#JDBC}.


 * Created: 12.04.2011 14:02:38
 * @author Volker Bergmann
 * @since 0.6.8
 */
public class LoggingResultSetHandler implements InvocationHandler {

  private static final Logger jdbcLogger = LoggerFactory.getLogger(LogCategoriesConstants.JDBC);

  private static final AtomicInteger openResultSetCount;
  private static ResourceMonitor openResultSetMonitor;

  // attributes ------------------------------------------------------------------------------------------------------

  private final ResultSet realResultSet;
  private final Statement statement;

  // constructor -----------------------------------------------------------------------------------------------------

  static {
    openResultSetCount = new AtomicInteger();
    if (Debug.active()) {
      openResultSetMonitor = new ResourceMonitor();
    }
  }

  public LoggingResultSetHandler(ResultSet realResultSet, Statement statement) {
    this.realResultSet = realResultSet;
    this.statement = statement;
    openResultSetCount.incrementAndGet();
    if (openResultSetMonitor != null) {
      openResultSetMonitor.register(this);
    }
    jdbcLogger.debug("created result set {}", this);
  }

  // InvocationHandler interface implementation ----------------------------------------------------------------------

  @Override
  public Object invoke(Object proxy, Method method, Object[] args)
      throws Throwable {
    try {
      String methodName = method.getName();
      switch (methodName) {
        case "close":
          openResultSetCount.decrementAndGet();
          if (openResultSetMonitor != null) {
            openResultSetMonitor.unregister(this);
          }
          jdbcLogger.debug("closing result set {}", this);
          break;
        case "toString":
          return "ResultSet (" + statement + ")";
        case "getStatement":
          return statement;
      }
      return BeanUtil.invoke(realResultSet, method, args);
    } catch (ConfigurationError e) {
      if (e.getCause() instanceof InvocationTargetException && e.getCause().getCause() instanceof SQLException) {
        throw e.getCause().getCause();
      } else {
        throw e;
      }
    }
  }

  // tracking methods ------------------------------------------------------------------------------------------------

  public static int getOpenResultSetCount() {
    return openResultSetCount.get();
  }

  public static void resetMonitors() {
    openResultSetCount.set(0);
    if (openResultSetMonitor != null) {
      openResultSetMonitor.reset();
    }
  }

  public static boolean assertAllResultSetsClosed(boolean critical) {
    return openResultSetMonitor.assertNoRegistrations(critical);
  }

}