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 connection that is managed in a pool. The connection
30   * may be reused by multiple clients.
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 would interact with the connection pool to return the connection
35   * to the pool (see PoolCallback).
36   *<p>
37   * The pooled connection also needs to provide a close method that the
38   * connection pool can use to physically close the connection.
39   * The pool might need to physically close the connection as determined
40   * by the pool's policy (for example, to manage the pool size or idle
41   * connections). This second close method should *not* use PoolCallback
42   * methods. It should only do what is required to close the physical
43   * connection.
44   *
45   * @author Rosanna Lee
46   */
47  public interface PooledConnection {
48  
49      /**
50       * Closes the physical connection.
51       */
52      public abstract void closeConnection();
53  }