net.sf.log4jdbc.SpyLogDelegator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of log4jdbc-remix Show documentation
experimental fork of log4jdbc
The newest version!
/**
 * Copyright 2007-2010 Arthur Blake
 *
 * 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 net.sf.log4jdbc;

/**
 * Delegates Spy events to a logger.
 * This interface is used for all logging activity used by log4jdbc and hides the specific implementation
 * of any given logging system from log4jdbc.
 *
 * @author Arthur Blake
 * @author Tim Azzopardi minor changes for supporting result set tracing
 */
public interface SpyLogDelegator
{
  /**
   * Determine if any of the jdbc or sql loggers are turned on.
   *
   * @return true if any of the jdbc or sql loggers are enabled at error level or higher.
   */
  public boolean isJdbcLoggingEnabled();

  /**
   * Called when a spied upon method throws an Exception.
   *
   * @param spy        the Spy wrapping the class that threw an Exception.
   * @param methodCall a description of the name and call parameters of the method generated the Exception.
   * @param e          the Exception that was thrown.
   * @param sql        optional sql that occured just before the exception occured.
   * @param execTime   optional amount of time that passed before an exception was thrown when sql was being executed.
   *                   caller should pass -1 if not used
   */
  public void exceptionOccured(Spy spy, String methodCall, Exception e, String sql, long execTime);

  /**
   * Called when spied upon method call returns.
   *
   * @param spy        the Spy wrapping the class that called the method that returned.
   * @param methodCall a description of the name and call parameters of the method that returned.
   * @param returnValue  return value from the method call, null for void return types.
   * @param targetObject the target object method call (E.g. a CallableStatement, ResultSet etc) 
   * @param methodParams the params passed to the method
   */
  public void methodReturned(Spy spy, String methodCall, Object returnValue, Object targetObject, Object... methodParams);

  /**
   * Called when a spied upon object is constructed.
   *
   * @param spy              the Spy wrapping the class that called the method that returned.
   * @param constructionInfo information about the object construction
   */
  public void constructorReturned(Spy spy, String constructionInfo);

  /**
   * Special call that is called only for JDBC method calls that contain SQL.
   *
   * @param spy        the Spy wrapping the class where the SQL occured.
   * @param methodCall a description of the name and call parameters of the method that generated the SQL.
   * @param sql        sql that occured.
   * @return           the (possibly reformatted) sql
   */
  public String sqlOccured(Spy spy, String methodCall, String sql);

  /**
   * Special call that is called only for JDBC method calls that contain SQL batches.
   *
   * @param spy        the Spy wrapping the class where the SQL occured.
   * @param methodCall a description of the name and call parameters of the method that generated the SQL.
   * @param sqls       the sql batch that occured.
   * @return           the (possibly reformatted) sql string for the whole batch
   */
  public String sqlOccured(Spy spy, String methodCall, String[] sqls);
  
  /**
   * Similar to sqlOccured, but reported after SQL executes and used to report timing stats on the SQL
   *
   * @param spy the    Spy wrapping the class where the SQL occured.
   * @param execTime   how long it took the sql to run, in msec.
   * @param methodCall a description of the name and call parameters of the method that generated the SQL.
   * @param sql        sql that occured.
   */
  public void sqlTimingOccured(Spy spy, long execTime, String methodCall, String sql);

  /**
   * Called whenever a new connection spy is created.
   * 
   * @param spy ConnectionSpy that was created.
   */
  public void connectionOpened(Spy spy);

  /**
   * Called whenever a connection spy is closed.
   * 
   * @param spy ConnectionSpy that was closed.
   */
  public void connectionClosed(Spy spy);

  /**
   * Log a Setup and/or administrative log message for log4jdbc.
   *
   * @param msg message to log.
   */
  public void debug(String msg);

  /**
   * Determine whether the logger is expecting results sets to be collected
   *
   * @return true if the logger is expecting results sets to be collected
   */
  public boolean isResultSetCollectionEnabled();

  /**
   * Determine whether the logger is expecting results sets to be collected AND any unread result set values read explicitly  
   *
   * @return true if the logger is expecting results sets to be collected
   */
  public boolean isResultSetCollectionEnabledWithUnreadValueFillIn();
  
  /**
   * Called whenever result set has been collected
   */ 
  public void resultSetCollected(ResultSetCollector resultSetCollector);


}