KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > exolab > jms > net > connector > PoolEntry


1 /**
2  * Redistribution and use of this software and associated documentation
3  * ("Software"), with or without modification, are permitted provided
4  * that the following conditions are met:
5  *
6  * 1. Redistributions of source code must retain copyright
7  * statements and notices. Redistributions must also contain a
8  * copy of this document.
9  *
10  * 2. Redistributions in binary form must reproduce the
11  * above copyright notice, this list of conditions and the
12  * following disclaimer in the documentation and/or other
13  * materials provided with the distribution.
14  *
15  * 3. The name "Exolab" must not be used to endorse or promote
16  * products derived from this Software without prior written
17  * permission of Exoffice Technologies. For written permission,
18  * please contact info@exolab.org.
19  *
20  * 4. Products derived from this Software may not be called "Exolab"
21  * nor may "Exolab" appear in their names without prior written
22  * permission of Exoffice Technologies. Exolab is a registered
23  * trademark of Exoffice Technologies.
24  *
25  * 5. Due credit should be given to the Exolab Project
26  * (http://www.exolab.org/).
27  *
28  * THIS SOFTWARE IS PROVIDED BY EXOFFICE TECHNOLOGIES AND CONTRIBUTORS
29  * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
30  * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
31  * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
32  * EXOFFICE TECHNOLOGIES OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
33  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
34  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
35  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
37  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
39  * OF THE POSSIBILITY OF SUCH DAMAGE.
40  *
41  * Copyright 2004-2005 (C) Exoffice Technologies Inc. All Rights Reserved.
42  *
43  * $Id: PoolEntry.java,v 1.2 2005/05/24 06:01:36 tanderson Exp $
44  */
45 package org.exolab.jms.net.connector;
46
47
48 /**
49  * An entry in the {@link ConnectionPool}.
50  *
51  * @author <a HREF="mailto:tma@netspace.net.au">Tim Anderson</a>
52  * @version $Revision: 1.2 $ $Date: 2005/05/24 06:01:36 $
53  */
54 class PoolEntry {
55
56     /**
57      * The connection.
58      */
59     private ManagedConnection _connection;
60
61     /**
62      * If <code>true</code>, the connection was accepted via an {@link
63      * ManagedConnectionAcceptor}, otherwise it was created via {@link
64      * ManagedConnectionFactory#createManagedConnection}
65      */
66     private final boolean _accepted;
67
68     /**
69      * Determines if the connection has been initialised.
70      */
71     private boolean _initialised = false;
72
73
74     /**
75      * Construct a new <code>PoolEntry</code>.
76      *
77      * @param connection the managed connection
78      * @param accepted if <code>true</code> the connection was accepted via an
79      * {@link ManagedConnectionAcceptor}, otherwise it was
80      * created via
81      * {@link ManagedConnectionFactory#createManagedConnection}
82      */
83     public PoolEntry(ManagedConnection connection, boolean accepted) {
84         _connection = connection;
85         _accepted = accepted;
86     }
87
88     /**
89      * Returns the connection
90      *
91      * @return the connection
92      */
93     public ManagedConnection getManagedConnection() {
94         return _connection;
95     }
96
97     /**
98      * Determines if the connection was accepted
99      *
100      * @return <code>true</code> if the connection was accepted via an {@link
101      * ManagedConnectionAcceptor}, otherwise <code>false</code>,
102      * indicating it was created via
103      * {@link ManagedConnectionFactory#createManagedConnection}
104      */
105     public boolean getAccepted() {
106         return _accepted;
107     }
108
109     /**
110      * Determines if the connection has been initialised.
111      * An initialised connection may be reaped.
112      *
113      * @return <code>true</code> if the connection has been initialised
114      */
115     public synchronized boolean isInitialised() {
116         return _initialised;
117     }
118
119     /**
120      * Marks the connection as being initialised.
121      */
122     public synchronized void setInitialised() {
123         _initialised = true;
124     }
125
126 }
127
Popular Tags