1/*
2 * Copyright (c) 2002, 2003, 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
26package com.sun.jndi.ldap.pool;
27
28/**
29 * Is a reference to Connections that is stored in Pool.
30 * This is an intermediate object that is outside of the circular
31 * reference loop of
32 *  com.sun.jndi.ldap.Connection <-> com.sun.jndi.ldap.LdapClient
33 *    <-> com.sun.jndi.ldap.pool.Connections
34 *
35 * Because Connection is a daemon thread, it will keep LdapClient
36 * alive until LdapClient closes Connection. This will in turn
37 * keep Connections alive. So even when Connections is removed
38 * from (the WeakHashMap of) Pool, it won't be finalized.
39 * ConnectionsRef acts as Connections's finalizer.
40 *
41 * Without connection pooling, com.sun.jndi.ldap.LdapCtx's finalize()
42 * closes LdapClient, which in turn closes Connection.
43 * With connection pooling, ConnectionsRef's finalize() calls
44 * Connections.close(), which in turn will close all idle connections
45 * and mark Connections such that in-use connections will be closed
46 * when they are returned to the pool.
47 */
48final class ConnectionsRef {
49    final private Connections conns;
50
51    ConnectionsRef(Connections conns) {
52        this.conns = conns;
53    }
54
55    Connections getConnections() {
56        return conns;
57    }
58}
59