1   /*
    2    * JBoss, Home of Professional Open Source
    3    * Copyright 2005, JBoss Inc., and individual contributors as indicated
    4    * by the @authors tag. See the copyright.txt in the distribution for a
    5    * full listing of individual contributors.
    6    *
    7    * This is free software; you can redistribute it and/or modify it
    8    * under the terms of the GNU Lesser General Public License as
    9    * published by the Free Software Foundation; either version 2.1 of
   10    * the License, or (at your option) any later version.
   11    *
   12    * This software is distributed in the hope that it will be useful,
   13    * but WITHOUT ANY WARRANTY; without even the implied warranty of
   14    * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
   15    * Lesser General Public License for more details.
   16    *
   17    * You should have received a copy of the GNU Lesser General Public
   18    * License along with this software; if not, write to the Free
   19    * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
   20    * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
   21    */
   22   package javax.jms;
   23   
   24   import java.util.Enumeration;
   25   
   26   /** A <CODE>ConnectionMetaData</CODE> object provides information describing the 
   27    * <CODE>Connection</CODE> object.
   28    */
   29   
   30   public interface ConnectionMetaData
   31   {
   32   
   33      /** Gets the JMS API version.
   34       *
   35       * @return the JMS API version
   36       *  
   37       * @exception JMSException if the JMS provider fails to retrieve the
   38       *                         metadata due to some internal error.
   39       */
   40      public String getJMSVersion() throws JMSException;
   41   
   42      /** Gets the JMS major version number.
   43       *  
   44       * @return the JMS API major version number
   45       *  
   46       * @exception JMSException if the JMS provider fails to retrieve the
   47       *                         metadata due to some internal error.
   48       */
   49      public int getJMSMajorVersion() throws JMSException;
   50   
   51      /** Gets the JMS minor version number.
   52       *  
   53       * @return the JMS API minor version number
   54       *  
   55       * @exception JMSException if the JMS provider fails to retrieve the
   56       *                         metadata due to some internal error.
   57       */
   58      public int getJMSMinorVersion() throws JMSException;
   59   
   60      /** Gets the JMS provider name.
   61       *
   62       * @return the JMS provider name
   63       *  
   64       * @exception JMSException if the JMS provider fails to retrieve the
   65       *                         metadata due to some internal error.
   66       */
   67      public String getJMSProviderName() throws JMSException;
   68   
   69      /** Gets the JMS provider version.
   70       *
   71       * @return the JMS provider version
   72       *  
   73       * @exception JMSException if the JMS provider fails to retrieve the
   74       *                         metadata due to some internal error.
   75       */
   76      public String getProviderVersion() throws JMSException;
   77   
   78      /** Gets the JMS provider major version number.
   79       *  
   80       * @return the JMS provider major version number
   81       *  
   82       * @exception JMSException if the JMS provider fails to retrieve the
   83       *                         metadata due to some internal error.
   84       */
   85      public int getProviderMajorVersion() throws JMSException;
   86   
   87      /** Gets the JMS provider minor version number.
   88       *  
   89       * @return the JMS provider minor version number
   90       *  
   91       * @exception JMSException if the JMS provider fails to retrieve the
   92       *                         metadata due to some internal error.
   93       */
   94      public int getProviderMinorVersion() throws JMSException;
   95   
   96      /** Gets an enumeration of the JMSX property names.
   97       *  
   98       * @return an Enumeration of JMSX property names
   99       *  
  100       * @exception JMSException if the JMS provider fails to retrieve the
  101       *                         metadata due to some internal error.
  102       */
  103      public Enumeration getJMSXPropertyNames() throws JMSException;
  104   }