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 import javax.resource.ResourceException;
40
41 /** The ManagedConnectionMetaData interface provides information about the
42 * underlying EIS instance associated with a ManagedConnection instance.
43 * An application server uses this information to get runtime information
44 * about a connected EIS instance.
45 *
46 * <p>The method ManagedConnection.getMetaData returns a
47 * ManagedConnectionMetaData instance.
48 *
49 * @version 0.8
50 * @author Rahul Sharma
51 * @see javax.resource.spi.ManagedConnection
52 **/
53
54 public interface ManagedConnectionMetaData {
55
56 /** Returns Product name of the underlying EIS instance connected
57 * through the ManagedConnection.
58 *
59 * @return Product name of the EIS instance.
60 **/
61 public
62 String getEISProductName() throws ResourceException;
63
64 /** Returns product version of the underlying EIS instance connected
65 * through the ManagedConnection.
66 *
67 * @return Product version of the EIS instance
68 **/
69 public
70 String getEISProductVersion() throws ResourceException;
71
72 /** Returns maximum limit on number of active concurrent connections
73 * that an EIS instance can support across client processes. If an EIS
74 * instance does not know about (or does not have) any such limit, it
75 * returns a 0.
76 *
77 * @return Maximum limit for number of active concurrent connections
78 **/
79 public
80 int getMaxConnections() throws ResourceException;
81
82 /** Returns name of the user associated with the ManagedConnection
83 * instance. The name corresponds to the resource principal under whose
84 * whose security context, a connection to the EIS instance has been
85 * established.
86 *
87 * @return name of the user
88 **/
89 public
90 String getUserName() throws ResourceException;
91 }
Save This Page