001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one
003     * or more contributor license agreements.  See the NOTICE file
004     * distributed with this work for additional information
005     * regarding copyright ownership.  The ASF licenses this file
006     * to you under the Apache License, Version 2.0 (the
007     * "License"); you may not use this file except in compliance
008     * with the License.  You may obtain a copy of the License at
009     *
010     *     http://www.apache.org/licenses/LICENSE-2.0
011     *
012     * Unless required by applicable law or agreed to in writing,
013     * software distributed under the License is distributed on an
014     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015     * KIND, either express or implied.  See the License for the
016     * specific language governing permissions and limitations
017     * under the License.
018     */
019    package org.apache.shiro.util;
020    
021    /**
022     * Shiro container-agnostic interface that indicates that this object requires a callback during destruction.
023     *
024     * @author Les Hazlewood
025     * @author Jeremy Haile
026     * @since 0.2
027     */
028    public interface Destroyable {
029    
030        /**
031         * Called when this object is being destroyed, allowing any necessary cleanup of internal resources.
032         *
033         * @throws Exception if an exception occurs during object destruction.
034         */
035        void destroy() throws Exception;
036    
037    }