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 info.magnolia.context.MgnlContext;
37  
38  /**
39   * CachePolicy returns instances of this class - depending on the value
40   * of the behaviour property, the cacheKey and cachedEntry values might
41   * be set or not.
42   *
43   * @author gjoseph
44   * @version $Revision: $ ($Author: $)
45   */
46  public class CachePolicyResult {
47      public static final CachePolicyBehaviour store = new CachePolicyBehaviour("store");
48      public static final CachePolicyBehaviour useCache = new CachePolicyBehaviour("useCache");
49      public static final CachePolicyBehaviour bypass = new CachePolicyBehaviour("bypass");
50  
51      private final CachePolicyBehaviour behaviour;
52      private final Object cacheKey;
53      private Object cachedEntry;
54  
55      public CachePolicyResult(CachePolicyBehaviour behaviour, Object cacheKey, Object cachedEntry) {
56          this.behaviour = behaviour;
57          this.cacheKey = cacheKey;
58          this.cachedEntry = cachedEntry;
59      }
60  
61      public CachePolicyBehaviour getBehaviour() {
62          return behaviour;
63      }
64  
65      public Object getCacheKey() {
66          return cacheKey;
67      }
68  
69      public Object getCachedEntry() {
70          return cachedEntry;
71      }
72  
73      public String toString() {
74          return "CachePolicyResult{" +
75                  "behaviour=" + behaviour +
76                  ", cacheKey=" + cacheKey +
77                  ", cachedEntry=" + cachedEntry +
78                  '}';
79      }
80  
81      /**
82       * Descriptor of the cache policy behavior used by this cache policy result.
83       */
84      public final static class CachePolicyBehaviour {
85          private final String name;
86  
87          private CachePolicyBehaviour(String name) {
88              this.name = name;
89          }
90  
91          public String toString() {
92              return name;
93          }
94  
95          public String getName() {
96              return name;
97          }
98      }
99  
100     public void setCachedEntry(Object entry) {
101         cachedEntry = entry;
102     }
103 
104     /**
105      * Saves the result in the context and makes it available by {@link #getCurrent()}.
106      */
107     public static void setCurrent(CachePolicyResult cachePolicyResult) {
108         MgnlContext.setAttribute(CachePolicyResult.class.getName(), cachePolicyResult);
109     }
110 
111     /**
112      * Returns the current {@link CachePolicyResult} which was set by the {@link CacheFilter}.
113      */
114     public static CachePolicyResult getCurrent(){
115         return (CachePolicyResult) MgnlContext.getAttribute(CachePolicyResult.class.getName());
116     }
117 
118 }