View Javadoc
1   /**
2    * This file Copyright (c) 2014-2015 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.listeners;
35  
36  import info.magnolia.module.cache.Cache;
37  import info.magnolia.module.cache.CacheModule;
38  import info.magnolia.module.cache.ContentCachingConfiguration;
39  
40  import java.util.Collections;
41  import java.util.List;
42  
43  import org.slf4j.Logger;
44  import org.slf4j.LoggerFactory;
45  
46  /**
47   * Cache wrapper which is responsible for calling of cache listeners.
48   */
49  public abstract class AbstractListeningCacheWrapper implements Cache {
50      private static final Logger log = LoggerFactory.getLogger(AbstractListeningCacheWrapper.class);
51  
52      private final CacheModule cacheModule;
53  
54      public AbstractListeningCacheWrapper(CacheModule cacheModule) {
55          this.cacheModule = cacheModule;
56      }
57  
58      @Override
59      public void put(Object key, Object value) {
60          for (AbstractCacheListener listener : getListeners()) {
61              listener.put(key, value);
62          }
63      }
64  
65      @Override
66      public void put(Object key, Object value, int timeToLiveInSeconds) {
67          for (AbstractCacheListener listener : getListeners()) {
68              listener.put(key, value, timeToLiveInSeconds);
69          }
70      }
71  
72      @Override
73      public Object get(Object key) {
74          for (AbstractCacheListener listener : getListeners()) {
75              listener.get(key);
76          }
77          return null;
78      }
79  
80      @Override
81      public Object getQuiet(Object key) {
82          for (AbstractCacheListener listener : getListeners()) {
83              listener.getQuiet(key);
84          }
85          return null;
86      }
87  
88      @Override
89      public void remove(Object key) {
90          for (AbstractCacheListener listener : getListeners()) {
91              listener.remove(key);
92          }
93      }
94  
95      @Override
96      public void clear() {
97          for (AbstractCacheListener listener : getListeners()) {
98              listener.clear();
99          }
100     }
101 
102     @Override
103     public abstract String getName();
104 
105     @Override
106     public abstract int getSize();
107 
108     private List<AbstractCacheListener> getListeners() {
109         ContentCachingConfiguration contentCachingConfiguration = this.cacheModule.getContentCaching(this.getName());
110         return contentCachingConfiguration == null ? Collections.<AbstractCacheListener>emptyList() : contentCachingConfiguration.getListeners();
111     }
112 
113 }