KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > javax > resource > cci > ConnectionMetaData


1 /*
2  * The contents of this file are subject to the terms
3  * of the Common Development and Distribution License
4  * (the License). You may not use this file except in
5  * compliance with the License.
6  *
7  * You can obtain a copy of the license at
8  * https://glassfish.dev.java.net/public/CDDLv1.0.html or
9  * glassfish/bootstrap/legal/CDDLv1.0.txt.
10  * See the License for the specific language governing
11  * permissions and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL
14  * Header Notice in each file and include the License file
15  * at glassfish/bootstrap/legal/CDDLv1.0.txt.
16  * If applicable, add the following below the CDDL Header,
17  * with the fields enclosed by brackets [] replaced by
18  * you own identifying information:
19  * "Portions Copyrighted [year] [name of copyright owner]"
20  *
21  * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
22  */

23
24 package javax.resource.cci;
25
26
27 import javax.resource.ResourceException JavaDoc;
28
29 /** The interface <code>ConnectionMetaData</code> provides information
30  * about an EIS instance connected through a Connection instance. A
31  * component calls the method <code>Connection.getMetaData</code> to
32  * get a <code>ConnectionMetaData</code> instance.
33  *
34  * @version 0.8
35  * @author Rahul Sharma
36  * @see javax.resource.cci.Connection
37  * @see javax.resource.cci.ResultSetInfo
38 **/

39
40 public interface ConnectionMetaData {
41
42   /** Returns product name of the underlying EIS instance connected
43    * through the Connection that produced this metadata.
44    *
45    * @return Product name of the EIS instance
46    * @throws ResourceException Failed to get the information for
47    * the EIS instance
48   **/

49   public
50   String JavaDoc getEISProductName() throws ResourceException JavaDoc;
51
52   /** Returns product version of the underlying EIS instance.
53    *
54    * @return Product version of an EIS instance.
55    * @throws ResourceException Failed to get the information for
56    * the EIS instance
57   **/

58   public
59   String JavaDoc getEISProductVersion() throws ResourceException JavaDoc;
60
61   /** Returns the user name for an active connection as known to
62    * the underlying EIS instance. The name corresponds the resource
63    * principal under whose security context a connection to the
64    * EIS instance has been established.
65    *
66    * @return String representing the user name
67    * @throws ResourceException Failed to get the information for
68    * the EIS instance
69   **/

70   public
71   String JavaDoc getUserName() throws ResourceException JavaDoc;
72 }
73
Popular Tags