Clover icon

Magnolia Imaging Module 3.2.3

  1. Project Clover database Fri Nov 6 2015 14:54:03 CET
  2. Package info.magnolia.imaging.caching

File AbstractContentBasedCachingStrategy.java

 

Coverage histogram

../../../../img/srcFileCovDistChart7.png
65% of files have more coverage

Code metrics

4
11
2
1
95
34
5
0.45
5.5
2
2.5

Classes

Class Line # Actions
AbstractContentBasedCachingStrategy 53 11 0% 5 5
0.705882470.6%
 

Contributing tests

This file is covered by 3 tests. .

Source view

1    /**
2    * This file Copyright (c) 2009-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.imaging.caching;
35   
36    import info.magnolia.cms.core.Content;
37    import info.magnolia.cms.core.NodeData;
38    import info.magnolia.imaging.ImageGenerator;
39    import info.magnolia.imaging.ParameterProvider;
40   
41    import java.util.Calendar;
42   
43    import javax.jcr.RepositoryException;
44   
45   
46    /**
47    * Superclass for {@link Content} based {@link CachingStrategy}/ies.
48    *
49    * @param <P> type of ParameterProvider's parameter
50    * @deprecated since 3.2 use {@link AbstractNodeBasedCachingStrategy}
51    */
52    @Deprecated
 
53    public abstract class AbstractContentBasedCachingStrategy<P> implements CachingStrategy<P> {
54   
 
55  18 toggle @Override
56    public String getCachePath(ImageGenerator<ParameterProvider<P>> generator, ParameterProvider<P> parameterProvider) {
57  18 final P param = parameterProvider.getParameter();
58  18 return "/" + generator.getName() + "/" + getWorkspaceName(param) + getPathOf(param);
59    }
60   
61    /**
62    * The default implementation simply delegates this decision to ParameterProvider.
63    *
64    * @return true if the image should be regenerated.
65    */
 
66  10 toggle @Override
67    public boolean shouldRegenerate(NodeData cachedBinary, ParameterProvider<P> parameterProvider) {
68  10 try {
69    // this is assuming the cached node's metadata was updated, not just the binary
70  10 final Calendar cacheLastMod = cachedBinary.getParent().getMetaData().getModificationDate();
71   
72    // this is assuming our parameter's mgnl:metaData was updated when updating any of its properties/binaries
73  10 final Calendar srcLastMod = getContent(parameterProvider.getParameter()).getMetaData().getModificationDate();
74   
75    //we should always check for the other one anyway since getModificationDate() _can_ return null
76  10 if (srcLastMod == null) {
77    // no srcLastMod update, means likely also no source at all ...
78  0 return false;
79  10 } else if (cacheLastMod == null) {
80    // no cacheLstMod update, means that the copy is stale or not created properly
81  0 return true;
82    } else {
83  10 return cacheLastMod.before(srcLastMod);
84    }
85    } catch (RepositoryException e) {
86  0 throw new RuntimeException(e);
87    }
88    }
89   
90    abstract protected String getWorkspaceName(P param);
91   
92    abstract protected Content getContent(P param);
93   
94    abstract protected String getPathOf(P param);
95    }