java/org/apache/tomcat/dbcp/pool2/SwallowedExceptionListener.java

/*
 * 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.tomcat.dbcp.pool2;

/**
 * Pools that unavoidably swallow exceptions may be configured with an instance
 * of this listener so the user may receive notification of when this happens.
 * The listener should not throw an exception when called but pools calling
 * listeners should protect themselves against exceptions anyway.
 *
 * @since 2.0
 */
public interface SwallowedExceptionListener {

    /**
     * This method is called every time the implementation unavoidably swallows
     * an exception.
     *
     * @param e The exception that was swallowed
     */
    void onSwallowException(Exception e);
}