001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.dbcp2;
018
019import org.apache.commons.logging.Log;
020import org.apache.commons.pool2.SwallowedExceptionListener;
021
022/**
023 * Class for logging swallowed exceptions.
024 * @version $Id: SwallowedExceptionLogger.java 1651275 2015-01-13 04:11:09Z psteitz $
025 * @since 2.0
026 */
027public class SwallowedExceptionLogger implements SwallowedExceptionListener{
028
029    private final Log log;
030    private final boolean logExpiredConnections;
031
032    /**
033     * Create a SwallowedExceptionLogger with the given logger.  By default,
034     * expired connection logging is turned on.
035     *
036     * @param log logger
037     */
038    public SwallowedExceptionLogger(Log log) {
039        this(log, true);    
040    }
041    
042    /**
043     * Create a SwallowedExceptionLogger with the given logger and expired
044     * connection logging property.
045     *
046     * @param log logger
047     * @param logExpiredConnections false suppresses logging of expired connection events
048     */
049    public SwallowedExceptionLogger(Log log, boolean logExpiredConnections) {
050        this.log = log;
051        this.logExpiredConnections = logExpiredConnections;
052    }
053
054    @Override
055    public void onSwallowException(Exception e) {
056        if (logExpiredConnections || !(e instanceof LifetimeExceededException)) {
057            log.warn(Utils.getMessage(
058                    "swallowedExceptionLogger.onSwallowedException"), e);
059        }
060    }
061}