appserver/connectors/connectors-runtime/src/main/java/com/sun/enterprise/resource/pool/ConnectionLeakListener.java

/*
 * Copyright (c) 1997, 2018 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package com.sun.enterprise.resource.pool;

import com.sun.enterprise.resource.ResourceHandle;


/**
 * Leak listener that will be used by ConnectionLeakDetector to intimate the listeners
 * during connection leaks and to print-leak-stack-trace, reclaim leaked connection.
 *
 * @author Jagadish Ramu
 */
public interface ConnectionLeakListener {

    /**
     * listener method to handle in the event of connection leak detected
     */
    public void potentialConnectionLeakFound();

    /**
     * to print the stack trace of the caller of getConnection
     * @param stackTrace Stack trace of the caller
     */
    public void printConnectionLeakTrace(StringBuffer stackTrace);

    /**
     * reclaim the leaked connection
     * @param handle Resource to be reclaimed
     */
    public void reclaimConnection(ResourceHandle handle);
}