View Javadoc
1   /**
2    * This file Copyright (c) 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.cachepolicy;
35  
36  import info.magnolia.cms.cache.CacheConstants;
37  import info.magnolia.module.cache.cachekey.CacheKeyGenerator;
38  import info.magnolia.objectfactory.Components;
39  
40  import javax.servlet.http.HttpServletRequest;
41  
42  import org.apache.commons.lang3.StringUtils;
43  import org.slf4j.Logger;
44  import org.slf4j.LoggerFactory;
45  
46  /**
47   * Request attribute with additional cache informations retrieved from {@link CacheConstants#HEADER_X_MAGNOLIA_CACHE}.
48   */
49  public class XMagnoliaCacheAttribute {
50  
51      private static Logger log = LoggerFactory.getLogger(XMagnoliaCacheAttribute.class);
52  
53      public static final String NAME = CacheConstants.HEADER_X_MAGNOLIA_CACHE;
54  
55      private Integer ttl;
56      private CacheKeyGenerator keyGenerator;
57  
58      public XMagnoliaCacheAttribute(HttpServletRequest request) {
59          String header = request.getHeader(CacheConstants.HEADER_X_MAGNOLIA_CACHE);
60          if (header != null) {
61              try {
62                  if (header.contains(CacheKeyGenerator.class.getSimpleName())) {
63                      String cacheKeyGeneratorClass = StringUtils.substringBetween(header, CacheKeyGenerator.class.getSimpleName() + "=", ",");
64                      if (StringUtils.isNotEmpty(cacheKeyGeneratorClass)) {
65                          Class clazz = Class.forName(cacheKeyGeneratorClass);
66                          if (CacheKeyGenerator.class.isAssignableFrom(clazz)) {
67                              keyGenerator = (CacheKeyGenerator) Components.newInstance(clazz);
68                          } else {
69                              log.error("Cannot use cache key generator: '{}'. Expected instance of '{}'", clazz, CacheKeyGenerator.class);
70                          }
71                      }
72                  }
73                  if (header.contains(CacheConstants.HEADER_VALUE_X_MAGNOLIA_TTL)) {
74                      ttl = Integer.parseInt(StringUtils.substringBetween(header, CacheConstants.HEADER_VALUE_X_MAGNOLIA_TTL + "=", ","));
75                  }
76              } catch (NumberFormatException e) {
77                  log.error("Unparsable TTL in '{}' header: {}", CacheConstants.HEADER_X_MAGNOLIA_CACHE, header);
78              } catch (ClassNotFoundException e) {
79                  log.warn("Cannot use custom cache key generator class:", e);
80              }
81          }
82      }
83  
84      public Integer getTtl() {
85          return ttl;
86      }
87  
88      public CacheKeyGenerator getKeyGenerator() {
89          return keyGenerator;
90      }
91  }