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 * @since 2.0
025 */
026public class SwallowedExceptionLogger implements SwallowedExceptionListener{
027
028    private final Log log;
029    private final boolean logExpiredConnections;
030
031    /**
032     * Create a SwallowedExceptionLogger with the given logger.  By default,
033     * expired connection logging is turned on.
034     *
035     * @param log logger
036     */
037    public SwallowedExceptionLogger(final Log log) {
038        this(log, true);
039    }
040
041    /**
042     * Create a SwallowedExceptionLogger with the given logger and expired
043     * connection logging property.
044     *
045     * @param log logger
046     * @param logExpiredConnections false suppresses logging of expired connection events
047     */
048    public SwallowedExceptionLogger(final Log log, final boolean logExpiredConnections) {
049        this.log = log;
050        this.logExpiredConnections = logExpiredConnections;
051    }
052
053    @Override
054    public void onSwallowException(final Exception e) {
055        if (logExpiredConnections || !(e instanceof LifetimeExceededException)) {
056            log.warn(Utils.getMessage(
057                    "swallowedExceptionLogger.onSwallowedException"), e);
058        }
059    }
060}