ConnectionMetaData.java

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

package javax.jms;

import java.util.Enumeration;

/** A <CODE>ConnectionMetaData</CODE> object provides information describing the
 * <CODE>Connection</CODE> object.
 *
 * @version     1.0 - 13 March 1998
 * @author      Mark Hapner
 * @author      Rich Burridge
 */

public interface ConnectionMetaData
{

  /** Gets the JMS API version.
    *
    * @return the JMS API version
    *
    * @exception JMSException if the JMS provider fails to retrieve the
    *                         metadata due to some internal error.
    */

  String getJMSVersion() throws JMSException;

  /** Gets the JMS major version number.
    *
    * @return the JMS API major version number
    *
    * @exception JMSException if the JMS provider fails to retrieve the
    *                         metadata due to some internal error.
    */

  int getJMSMajorVersion() throws JMSException;

  /** Gets the JMS minor version number.
    *
    * @return the JMS API minor version number
    *
    * @exception JMSException if the JMS provider fails to retrieve the
    *                         metadata due to some internal error.
    */

  int getJMSMinorVersion() throws JMSException;

  /** Gets the JMS provider name.
    *
    * @return the JMS provider name
    *
    * @exception JMSException if the JMS provider fails to retrieve the
    *                         metadata due to some internal error.
    */

  String getJMSProviderName() throws JMSException;

  /** Gets the JMS provider version.
    *
    * @return the JMS provider version
    *
    * @exception JMSException if the JMS provider fails to retrieve the
    *                         metadata due to some internal error.
    */

  String getProviderVersion() throws JMSException;

  /** Gets the JMS provider major version number.
    *
    * @return the JMS provider major version number
    *
    * @exception JMSException if the JMS provider fails to retrieve the
    *                         metadata due to some internal error.
    */

  int getProviderMajorVersion() throws JMSException;

  /** Gets the JMS provider minor version number.
    *
    * @return the JMS provider minor version number
    *
    * @exception JMSException if the JMS provider fails to retrieve the
    *                         metadata due to some internal error.
    */

  int getProviderMinorVersion() throws JMSException;

  /** Gets an enumeration of the JMSX property names.
    *
    * @return an Enumeration of JMSX property names
    *
    * @exception JMSException if the JMS provider fails to retrieve the
    *                         metadata due to some internal error.
    */

  Enumeration getJMSXPropertyNames() throws JMSException;
}