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  
25  package javax.jms;
26  
27  import java.util.Enumeration  ;
28  
29  /** A <CODE>ConnectionMetaData</CODE> object provides information describing the 
30    * <CODE>Connection</CODE> object.
31    *
32    * @version     1.0 - 13 March 1998
33    * @author      Mark Hapner
34    * @author      Rich Burridge
35    */
36  
37  public interface ConnectionMetaData {
38  
39      /** Gets the JMS API version.
40        *
41        * @return the JMS API version
42        *  
43        * @exception JMSException if the JMS provider fails to retrieve the
44        *                         metadata due to some internal error.
45        */
46  
47      String   
48      getJMSVersion() throws JMSException  ;
49  
50  
51      /** Gets the JMS major version number.
52        *  
53        * @return the JMS API major version number
54        *  
55        * @exception JMSException if the JMS provider fails to retrieve the
56        *                         metadata due to some internal error.
57        */
58  
59      int 
60      getJMSMajorVersion() throws JMSException  ; 
61   
62  
63      /** Gets the JMS minor version number.
64        *  
65        * @return the JMS API minor version number
66        *  
67        * @exception JMSException if the JMS provider fails to retrieve the
68        *                         metadata due to some internal error.
69        */
70  
71      int  
72      getJMSMinorVersion() throws JMSException  ;
73  
74  
75      /** Gets the JMS provider name.
76        *
77        * @return the JMS provider name
78        *  
79        * @exception JMSException if the JMS provider fails to retrieve the
80        *                         metadata due to some internal error.
81        */ 
82  
83      String   
84      getJMSProviderName() throws JMSException  ;
85  
86  
87      /** Gets the JMS provider version.
88        *
89        * @return the JMS provider version
90        *  
91        * @exception JMSException if the JMS provider fails to retrieve the
92        *                         metadata due to some internal error.
93        */ 
94  
95      String   
96      getProviderVersion() throws JMSException  ;
97  
98  
99      /** Gets the JMS provider major version number.
100       *  
101       * @return the JMS provider major version number
102       *  
103       * @exception JMSException if the JMS provider fails to retrieve the
104       *                         metadata due to some internal error.
105       */
106 
107     int
108     getProviderMajorVersion() throws JMSException  ; 
109 
110  
111     /** Gets the JMS provider minor version number.
112       *  
113       * @return the JMS provider minor version number
114       *  
115       * @exception JMSException if the JMS provider fails to retrieve the
116       *                         metadata due to some internal error.
117       */
118 
119     int  
120     getProviderMinorVersion() throws JMSException  ;
121 
122  
123     /** Gets an enumeration of the JMSX property names.
124       *  
125       * @return an Enumeration of JMSX property names
126       *  
127       * @exception JMSException if the JMS provider fails to retrieve the
128       *                         metadata due to some internal error.
129       */
130 
131     Enumeration  
132     getJMSXPropertyNames() throws JMSException  ;
133 }
134
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags