All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.cayenne.log.JdbcEventLogger Maven / Gradle / Ivy

There is a newer version: 4.2.1
Show newest version
/*****************************************************************
 *   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.cayenne.log;

import java.util.List;

import org.apache.cayenne.conn.DataSourceInfo;
import org.apache.cayenne.map.DbAttribute;

/**
 * A logging service used by Cayenne to output database interactions.
 * 
 * @since 3.1
 */
public interface JdbcEventLogger {

    /**
     * Logs an arbitrary message.
     */
    void log(String message);

    /**
     * Logs database connection event using container data source.
     */
    void logConnect(String dataSource);

    void logConnect(String url, String userName, String password);

    /**
     * Logs database connection event.
     */
    void logPoolCreated(DataSourceInfo dsi);

    void logConnectSuccess();

    void logConnectFailure(Throwable th);

    void logGeneratedKey(DbAttribute attribute, Object value);

    void logQuery(String sql, List params);

    void logQuery(String sql, List attrs, List params, long time);

    void logQueryParameters(
            String label,
            List attrs,
            List parameters,
            boolean isInserting);

    void logSelectCount(int count, long time);

    void logUpdateCount(int count);

    void logBeginTransaction(String transactionLabel);

    void logCommitTransaction(String transactionLabel);

    void logRollbackTransaction(String transactionLabel);

    void logQueryError(Throwable th);

    /**
     * Returns true if current thread default log level is high enough to generate output.
     */
    boolean isLoggable();
}