Save This Page
Home » activemq-parent-5.3.1-source-release » org.apache » activemq » [javadoc | source]
    1   /**
    2    * Licensed to the Apache Software Foundation (ASF) under one or more
    3    * contributor license agreements.  See the NOTICE file distributed with
    4    * this work for additional information regarding copyright ownership.
    5    * The ASF licenses this file to You under the Apache License, Version 2.0
    6    * (the "License"); you may not use this file except in compliance with
    7    * the License.  You may obtain a copy of the License at
    8    *
    9    *      http://www.apache.org/licenses/LICENSE-2.0
   10    *
   11    * Unless required by applicable law or agreed to in writing, software
   12    * distributed under the License is distributed on an "AS IS" BASIS,
   13    * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   14    * See the License for the specific language governing permissions and
   15    * limitations under the License.
   16    */
   17   package org.apache.activemq;
   18   
   19   import javax.jms.JMSException;
   20   
   21   /**
   22    * Provides a uniform interface that can be used to close all the JMS obejcts
   23    * that provide a close() method. Useful for when you want to collect a
   24    * heterogeous set of JMS object in a collection to be closed at a later time.
   25    * 
   26    * @version $Revision: 1.2 $
   27    */
   28   public interface Closeable {
   29   
   30       /**
   31        * Closes a JMS object.
   32        * <P>
   33        * Many JMS objects are closeable such as Connections, Sessions, Consumers
   34        * and Producers.
   35        * 
   36        * @throws JMSException if the JMS provider fails to close the object due to
   37        *                 some internal error.
   38        */
   39       void close() throws JMSException;
   40   }

Save This Page
Home » activemq-parent-5.3.1-source-release » org.apache » activemq » [javadoc | source]