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 */
019package org.apache.shiro.cache;
020
021/**
022 * Interface implemented by components that utilize a CacheManager and wish that CacheManager to be supplied if
023 * one is available.
024 *
025 * <p>This is used so internal security components that use a CacheManager can be injected with it instead of having
026 * to create one on their own.
027 *
028 * @since 0.9
029 */
030public interface CacheManagerAware {
031
032    /**
033     * Sets the available CacheManager instance on this component.
034     *
035     * @param cacheManager the CacheManager instance to set on this component.
036     */
037    void setCacheManager(CacheManager cacheManager);
038}