View Javadoc
1   /**
2    * This file Copyright (c) 2008-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.executor;
35  
36  import info.magnolia.module.cache.CacheConfiguration;
37  import info.magnolia.module.cache.CachePolicyExecutor;
38  import info.magnolia.module.cache.ContentCachingConfiguration;
39  
40  import javax.servlet.http.HttpServletRequest;
41  
42  /**
43   * The cache configuration is passed to the executor.
44   *
45   * @author pbracher
46   * @version $Revision$ ($Author$)
47   */
48  public abstract class AbstractExecutor implements CachePolicyExecutor {
49  
50      private ContentCachingConfiguration contentCachingConfiguration;
51  
52      public ContentCachingConfiguration getContentCachingConfiguration() {
53          return contentCachingConfiguration;
54      }
55  
56      @Override
57      @Deprecated
58      public void setCacheConfiguration(CacheConfiguration cacheConfiguration) {
59          setContentCachingConfiguration(cacheConfiguration);
60      }
61  
62      @Override
63      public void setContentCachingConfiguration(ContentCachingConfiguration contentCachingConfiguration) {
64          this.contentCachingConfiguration = contentCachingConfiguration;
65      }
66  
67      /**
68       * Checks if server cache is newer than the client cache.
69       * @param request The servlet request we are processing
70       * @return boolean true if the server resource is newer
71       */
72      protected boolean ifModifiedSince(HttpServletRequest request, long cacheStorageTimestamp) {
73          try {
74              long headerValue = request.getDateHeader("If-Modified-Since");
75              if (headerValue != -1) {
76                  // If an If-None-Match header has been specified, If-Modified-Since is ignored.
77                  // The header defines only seconds, so we ignore the milliseconds.
78                  final long cacheStorageTimestampSeconds = cacheStorageTimestamp - (cacheStorageTimestamp % 1000);
79                  if (request.getHeader("If-None-Match") == null && cacheStorageTimestamp > 0 && (cacheStorageTimestampSeconds <= headerValue)) {
80                      return false;
81                  }
82              }
83          } catch (IllegalArgumentException e) {
84              // can happen per spec if the header value can't be converted to a date ...
85              return true;
86          }
87          return true;
88      }
89  
90  
91  }