View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.shiro.cache;
20  
21  /**
22   * Interface implemented by components that utilize a CacheManager and wish that CacheManager to be supplied if
23   * one is available.
24   *
25   * <p>This is used so internal security components that use a CacheManager can be injected with it instead of having
26   * to create one on their own.
27   *
28   * @since 0.9
29   */
30  public interface CacheManagerAware {
31  
32      /**
33       * Sets the available CacheManager instance on this component.
34       *
35       * @param cacheManager the CacheManager instance to set on this component.
36       */
37      void setCacheManager(CacheManager cacheManager);
38  }