001package org.apache.commons.jcs3.engine.behavior;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *   http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022/**
023 * This interface is required of all shutdown observers.  These observers
024 * can observer ShutdownObservable objects.  The CacheManager is the primary
025 * observable that this is intended for.
026 * <p>
027 * Most shutdown operations will occur outside this framework for now.  The initial
028 * goal is to allow background threads that are not reachable through any reference
029 * that the cache manager maintains to be killed on shutdown.
030 * </p>
031 */
032public interface IShutdownObserver
033{
034    /**
035     * Tells the observer that the observable has received a shutdown command.
036     *
037     */
038    void shutdown();
039}