src/org/jsecurity/util/Destroyable.java

/*
 * Copyright 2005-2008 Les Hazlewood, Jeremy Haile
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.jsecurity.util;

/**
 * JSecurity container-agnostic interface that indicates that this object requires a callback during destruction.
 *
 * @see org.jsecurity.spring.LifecycleBeanPostProcessor
 *
 * @since 0.2
 * @author Les Hazlewood
 * @author Jeremy Haile
 */
public interface Destroyable {

    /**
     * Called when this object is being destroyed, allowing any necessary cleanup of internal resources.
     * @throws Exception if an exception occurs during object destruction.
     */
    void destroy() throws Exception;
    
}