View Javadoc

1   /**
2    * This file Copyright (c) 2008-2011 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.module.cache;
35  
36  import java.util.HashMap;
37  import java.util.Map;
38  
39  /**
40   * Each CacheConfiguration holds a CachePolicy, a FlushPolicy and a
41   * BrowserCachePolicy. Based on the outcome of the cachePolicy the defined
42   * executors will be called.
43   *
44   * @see CachePolicy
45   * @see FlushPolicy
46   *
47   * @author gjoseph
48   * @version $Revision: $ ($Author: $)
49   */
50  public class CacheConfiguration {
51  
52      private String name;
53      private CachePolicy cachePolicy;
54      private FlushPolicy flushPolicy;
55      private BrowserCachePolicy browserCachePolicy;
56  
57      private Map executors = new HashMap();
58  
59      public CacheConfiguration() {
60      }
61  
62      /**
63       * This constructor is intended for tests only. For regular use, instantiate this class from its repository configuration using content2bean.
64       */
65      CacheConfiguration(String name, CachePolicy cachePolicy, FlushPolicy flushPolicy) {
66          this.name = name;
67          this.cachePolicy = cachePolicy;
68          this.flushPolicy = flushPolicy;
69      }
70  
71      public String getName() {
72          return name;
73      }
74  
75      public void setName(String name) {
76          this.name = name;
77      }
78  
79      public CachePolicy getCachePolicy() {
80          return cachePolicy;
81      }
82  
83      public void setCachePolicy(CachePolicy cachePolicy) {
84          this.cachePolicy = cachePolicy;
85      }
86  
87      public FlushPolicy getFlushPolicy() {
88          return flushPolicy;
89      }
90  
91      public void setFlushPolicy(FlushPolicy flushPolicy) {
92          this.flushPolicy = flushPolicy;
93      }
94  
95      public CachePolicyExecutor getExecutor(CachePolicyResult.CachePolicyBehaviour behaviour) {
96          return (CachePolicyExecutor) executors.get(behaviour.getName());
97      }
98  
99      public BrowserCachePolicy getBrowserCachePolicy() {
100         return browserCachePolicy;
101     }
102 
103     public void setBrowserCachePolicy(BrowserCachePolicy browserCachePolicy) {
104         this.browserCachePolicy = browserCachePolicy;
105     }
106 
107     public Map getExecutors() {
108         return executors;
109     }
110 
111     public void setExecutors(Map executors) {
112         this.executors = executors;
113     }
114 
115     public void addExecutor(String name, CachePolicyExecutor executor){
116         executor.setCacheConfiguration(this);
117         this.executors.put(name, executor);
118     }
119 
120 }