1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.commons.dbcp2;
18
19 import org.apache.commons.logging.Log;
20 import org.apache.commons.pool2.SwallowedExceptionListener;
21
22 /**
23 * Class for logging swallowed exceptions.
24 *
25 * @since 2.0
26 */
27 public class SwallowedExceptionLogger implements SwallowedExceptionListener {
28
29 private final Log log;
30 private final boolean logExpiredConnections;
31
32 /**
33 * Create a SwallowedExceptionLogger with the given logger. By default, expired connection logging is turned on.
34 *
35 * @param log
36 * logger
37 */
38 public SwallowedExceptionLogger(final Log log) {
39 this(log, true);
40 }
41
42 /**
43 * Create a SwallowedExceptionLogger with the given logger and expired connection logging property.
44 *
45 * @param log
46 * logger
47 * @param logExpiredConnections
48 * false suppresses logging of expired connection events
49 */
50 public SwallowedExceptionLogger(final Log log, final boolean logExpiredConnections) {
51 this.log = log;
52 this.logExpiredConnections = logExpiredConnections;
53 }
54
55 @Override
56 public void onSwallowException(final Exception e) {
57 if (logExpiredConnections || !(e instanceof LifetimeExceededException)) {
58 log.warn(Utils.getMessage("swallowedExceptionLogger.onSwallowedException"), e);
59 }
60 }
61 }