1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3 *
4 * Copyright 2000-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 may
9 * 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 mq/legal/LICENSE.txt. See the License for the specific language
12 * 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 mq/legal/LICENSE.txt. Sun designates
16 * this particular file as subject to the "Classpath" exception as provided by
17 * Sun in the GPL Version 2 section of the License file that accompanied this
18 * code. If applicable, add the following below the License Header, with the
19 * fields enclosed by brackets [] replaced by your own identifying information:
20 * "Portions Copyrighted [year] [name of copyright owner]"
21 *
22 * Contributor(s):
23 *
24 * If you wish your version of this file to be governed by only the CDDL or
25 * only the GPL Version 2, indicate your decision by adding "[Contributor]
26 * elects to include this software in this distribution under the [CDDL or GPL
27 * Version 2] license." If you don't indicate a single choice of license, a
28 * recipient has the option to distribute your version of this file under
29 * either the CDDL, the GPL Version 2 or to extend the choice of license to
30 * its licensees as provided above. However, if you add GPL Version 2 code
31 * and therefore, elected the GPL Version 2 license, then the option applies
32 * only if the new code is made subject to such option by the copyright holder.
33 */
34
35 /*
36 * @(#)ConnectionMetaData.java 1.13 07/02/07
37 */
38
39 package javax.jms;
40
41 import java.util.Enumeration;
42
43 /** A <CODE>ConnectionMetaData</CODE> object provides information describing the
44 * <CODE>Connection</CODE> object.
45 */
46
47 public interface ConnectionMetaData {
48
49 /** Gets the JMS API version.
50 *
51 * @return the JMS API version
52 *
53 * @exception JMSException if the JMS provider fails to retrieve the
54 * metadata due to some internal error.
55 */
56
57 String
58 getJMSVersion() throws JMSException;
59
60
61 /** Gets the JMS major version number.
62 *
63 * @return the JMS API major version number
64 *
65 * @exception JMSException if the JMS provider fails to retrieve the
66 * metadata due to some internal error.
67 */
68
69 int
70 getJMSMajorVersion() throws JMSException;
71
72
73 /** Gets the JMS minor version number.
74 *
75 * @return the JMS API minor version number
76 *
77 * @exception JMSException if the JMS provider fails to retrieve the
78 * metadata due to some internal error.
79 */
80
81 int
82 getJMSMinorVersion() throws JMSException;
83
84
85 /** Gets the JMS provider name.
86 *
87 * @return the JMS provider name
88 *
89 * @exception JMSException if the JMS provider fails to retrieve the
90 * metadata due to some internal error.
91 */
92
93 String
94 getJMSProviderName() throws JMSException;
95
96
97 /** Gets the JMS provider version.
98 *
99 * @return the JMS provider version
100 *
101 * @exception JMSException if the JMS provider fails to retrieve the
102 * metadata due to some internal error.
103 */
104
105 String
106 getProviderVersion() throws JMSException;
107
108
109 /** Gets the JMS provider major version number.
110 *
111 * @return the JMS provider major version number
112 *
113 * @exception JMSException if the JMS provider fails to retrieve the
114 * metadata due to some internal error.
115 */
116
117 int
118 getProviderMajorVersion() throws JMSException;
119
120
121 /** Gets the JMS provider minor version number.
122 *
123 * @return the JMS provider minor version number
124 *
125 * @exception JMSException if the JMS provider fails to retrieve the
126 * metadata due to some internal error.
127 */
128
129 int
130 getProviderMinorVersion() throws JMSException;
131
132
133 /** Gets an enumeration of the JMSX property names.
134 *
135 * @return an Enumeration of JMSX property names
136 *
137 * @exception JMSException if the JMS provider fails to retrieve the
138 * metadata due to some internal error.
139 */
140
141 Enumeration
142 getJMSXPropertyNames() throws JMSException;
143 }