View Javadoc
1   /*
2    * Copyright (c) 2002, Oracle and/or its affiliates. All rights reserved.
3    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4    *
5    * This code is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU General Public License version 2 only, as
7    * published by the Free Software Foundation.  Oracle designates this
8    * particular file as subject to the "Classpath" exception as provided
9    * by Oracle in the LICENSE file that accompanied this code.
10   *
11   * This code is distributed in the hope that it will be useful, but WITHOUT
12   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13   * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14   * version 2 for more details (a copy is included in the LICENSE file that
15   * accompanied this code).
16   *
17   * You should have received a copy of the GNU General Public License version
18   * 2 along with this work; if not, write to the Free Software Foundation,
19   * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20   *
21   * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22   * or visit www.oracle.com if you need additional information or have any
23   * questions.
24   */
25  
26  package com.sun.jndi.ldap.pool;
27  
28  /**
29   * Represents a callback used to release or remove a PooledConnection back
30   * into the pool.
31   *
32   * A pooled connection typically has a close method that its clients
33   * use to indicate that they no longer need the connection. This close
34   * method should use the methods defined in this interface to
35   * interact with the connection pool to return the connection
36   * to the pool.
37   *
38   * The methods in this interface are typically invoked by a PooledConnection.
39   * The methods in this interface are typically implemented by the connection
40   * pool manager.
41   *
42   * @author Rosanna Lee
43   */
44  public interface PoolCallback {
45      /**
46       * Releases a useable connection back to the pool.
47       *
48       * @param conn The connection to release.
49       * @return true if the connection released; false if the connection
50       * is no longer in the pool.
51       */
52      public abstract boolean releasePooledConnection(PooledConnection conn);
53  
54      /**
55       * Removes a connection from the pool. The connection should not be reused.
56       * The physical connection should have already been closed.
57       *
58       * @param conn The connection to return.
59       * @return true if the connection was removed; false if the connection
60       * is no longer in the pool prior to removal.
61       */
62      public abstract boolean removePooledConnection(PooledConnection conn);
63  }