001    /**
002     * Licensed to the Apache Software Foundation (ASF) under one or more
003     * contributor license agreements.  See the NOTICE file distributed with
004     * this work for additional information regarding copyright ownership.
005     * The ASF licenses this file to You under the Apache License, Version 2.0
006     * (the "License"); you may not use this file except in compliance with
007     * the License.  You may obtain a copy of the License at
008     *
009     *      http://www.apache.org/licenses/LICENSE-2.0
010     *
011     * Unless required by applicable law or agreed to in writing, software
012     * distributed under the License is distributed on an "AS IS" BASIS,
013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     * See the License for the specific language governing permissions and
015     * limitations under the License.
016     */
017    package org.apache.activemq;
018    
019    import javax.jms.JMSException;
020    
021    /**
022     * Provides a uniform interface that can be used to close all the JMS obejcts
023     * that provide a close() method. Useful for when you want to collect a
024     * heterogeous set of JMS object in a collection to be closed at a later time.
025     * 
026     * 
027     */
028    public interface Closeable {
029    
030        /**
031         * Closes a JMS object.
032         * <P>
033         * Many JMS objects are closeable such as Connections, Sessions, Consumers
034         * and Producers.
035         * 
036         * @throws JMSException if the JMS provider fails to close the object due to
037         *                 some internal error.
038         */
039        void close() throws JMSException;
040    }