1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3 *
4 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
5 *
6 * The contents of this file are subject to the terms of either the GNU
7 * General Public License Version 2 only ("GPL") or the Common Development
8 * and Distribution License("CDDL") (collectively, the "License"). You
9 * may not use this file except in compliance with the License. You can obtain
10 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11 * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12 * language governing permissions and limitations under the License.
13 *
14 * When distributing the software, include this License Header Notice in each
15 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16 * Sun designates this particular file as subject to the "Classpath" exception
17 * as provided by Sun in the GPL Version 2 section of the License file that
18 * accompanied this code. If applicable, add the following below the License
19 * Header, with the fields enclosed by brackets [] replaced by your own
20 * identifying information: "Portions Copyrighted [year]
21 * [name of copyright owner]"
22 *
23 * Contributor(s):
24 *
25 * If you wish your version of this file to be governed by only the CDDL or
26 * only the GPL Version 2, indicate your decision by adding "[Contributor]
27 * elects to include this software in this distribution under the [CDDL or GPL
28 * Version 2] license." If you don't indicate a single choice of license, a
29 * recipient has the option to distribute your version of this file under
30 * either the CDDL, the GPL Version 2 or to extend the choice of license to
31 * its licensees as provided above. However, if you add GPL Version 2 code
32 * and therefore, elected the GPL Version 2 license, then the option applies
33 * only if the new code is made subject to such option by the copyright
34 * holder.
35 */
36
37 package javax.resource.spi;
38
39 /** <p>The ConnectionRequestInfo interface enables a resource adapter to
40 * pass its own request specific data structure across the connection
41 * request flow. A resource adapter extends the empty interface to
42 * supports its own data structures for connection request.
43 *
44 * <p>A typical use allows a resource adapter to handle
45 * application component specified per-connection request properties
46 * (example - client ID, language). The application server passes these
47 * properties back across to match/createManagedConnection calls on
48 * the resource adapter. These properties remain opaque to the
49 * application server during the connection request flow.
50 *
51 * <p>Once the ConnectionRequestInfo reaches match/createManagedConnection
52 * methods on the ManagedConnectionFactory instance, resource adapter
53 * uses this additional per-request information to do connection
54 * creation and matching.
55 *
56 * @version 0.8
57 * @author Rahul Sharma
58 * @see javax.resource.spi.ManagedConnectionFactory
59 * @see javax.resource.spi.ManagedConnection
60 **/
61
62 public interface ConnectionRequestInfo {
63
64 /** Checks whether this instance is equal to another. Since
65 * connectionRequestInfo is defined specific to a resource
66 * adapter, the resource adapter is required to implement
67 * this method. The conditions for equality are specific
68 * to the resource adapter.
69 *
70 * @return True if the two instances are equal.
71 **/
72 public
73 boolean equals(Object other);
74
75 /** Returns the hashCode of the ConnectionRequestInfo.
76 *
77 * @return hash code os this instance
78 **/
79 public
80 int hashCode();
81
82
83 }
Save This Page