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.cci;
38
39
40 import javax.resource.ResourceException;
41
42 /** The interface <code>ConnectionMetaData</code> provides information
43 * about an EIS instance connected through a Connection instance. A
44 * component calls the method <code>Connection.getMetaData</code> to
45 * get a <code>ConnectionMetaData</code> instance.
46 *
47 * @version 0.8
48 * @author Rahul Sharma
49 * @see javax.resource.cci.Connection
50 * @see javax.resource.cci.ResultSetInfo
51 **/
52
53 public interface ConnectionMetaData {
54
55 /** Returns product name of the underlying EIS instance connected
56 * through the Connection that produced this metadata.
57 *
58 * @return Product name of the EIS instance
59 * @throws ResourceException Failed to get the information for
60 * the EIS instance
61 **/
62 public
63 String getEISProductName() throws ResourceException;
64
65 /** Returns product version of the underlying EIS instance.
66 *
67 * @return Product version of an EIS instance.
68 * @throws ResourceException Failed to get the information for
69 * the EIS instance
70 **/
71 public
72 String getEISProductVersion() throws ResourceException;
73
74 /** Returns the user name for an active connection as known to
75 * the underlying EIS instance. The name corresponds the resource
76 * principal under whose security context a connection to the
77 * EIS instance has been established.
78 *
79 * @return String representing the user name
80 * @throws ResourceException Failed to get the information for
81 * the EIS instance
82 **/
83 public
84 String getUserName() throws ResourceException;
85 }
Save This Page