1 /**
2 * This file Copyright (c) 2010-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.browsercachepolicy;
35
36 import info.magnolia.module.cache.BrowserCachePolicy;
37 import info.magnolia.module.cache.BrowserCachePolicyResult;
38 import info.magnolia.module.cache.CachePolicyResult;
39 import info.magnolia.voting.voters.VoterSet;
40
41
42 /**
43 * Uses a {@link VoterSet} to decided if the file should be cached in the browser. If no voters are configured it means that the content can be cached.
44 * @version $Id$
45 *
46 */
47 public abstract class AbstractVoterBased implements BrowserCachePolicy {
48
49 private VoterSet voters;
50
51 public VoterSet getVoters() {
52 return voters;
53 }
54
55 public void setVoters(VoterSet voters) {
56 this.voters = voters;
57 }
58
59 @Override
60 public BrowserCachePolicyResult canCacheOnClient(CachePolicyResult cachePolicyResult) {
61 if(voters == null || voters.vote(cachePolicyResult)>0){
62 return getPositiveVoteResult(cachePolicyResult);
63 }
64 return null;
65 }
66
67 protected abstract BrowserCachePolicyResult getPositiveVoteResult(CachePolicyResult cachePolicyResult);
68
69 }