Magnolia Module Cache 5.5.9
File XMagnoliaCacheAttribute.java
Coverage histogram
45% of files have more coverage
Classes
| Class | Line # | Actions | |||||
|---|---|---|---|---|---|---|---|
| XMagnoliaCacheAttribute | 52 | 14 | 13.8% | 8 | 8 |
Contributing tests
This file is covered by 1 test.
.
Source view
| 1 | /** | |
| 2 | * This file Copyright (c) 2015-2018 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 | * Retrieves cache information from {@link CacheConstants#HEADER_X_MAGNOLIA_CACHE} header. | |
| 48 | * | |
| 49 | * @deprecated since 5.5. Use {@link info.magnolia.module.cache.cachepolicy.instructor.CacheInstructor} instead. | |
| 50 | */ | |
| 51 | @Deprecated | |
| 52 | public class XMagnoliaCacheAttribute { | |
| 53 | ||
| 54 | private static Logger log = LoggerFactory.getLogger(XMagnoliaCacheAttribute.class); | |
| 55 | ||
| 56 | public static final String NAME = CacheConstants.HEADER_X_MAGNOLIA_CACHE; | |
| 57 | ||
| 58 | private Integer ttl; | |
| 59 | private CacheKeyGenerator keyGenerator; | |
| 60 | ||
| 61 | 1 |  public XMagnoliaCacheAttribute(HttpServletRequest request) { |
| 62 | 1 | String header = request.getHeader(CacheConstants.HEADER_X_MAGNOLIA_CACHE); |
| 63 | 1 | if (header != null) { |
| 64 | 1 | try { |
| 65 | 1 | if (header.contains(CacheKeyGenerator.class.getSimpleName())) { |
| 66 | 1 | String cacheKeyGeneratorClass = StringUtils.substringBetween(header, CacheKeyGenerator.class.getSimpleName() + "=", ","); |
| 67 | 1 | if (StringUtils.isNotEmpty(cacheKeyGeneratorClass)) { |
| 68 | 1 | Class clazz = Class.forName(cacheKeyGeneratorClass); |
| 69 | 1 | if (CacheKeyGenerator.class.isAssignableFrom(clazz)) { |
| 70 | 1 | keyGenerator = (CacheKeyGenerator) Components.newInstance(clazz); |
| 71 | } else { | |
| 72 | 0 | log.error("Cannot use cache key generator: '{}'. Expected instance of '{}'", clazz, CacheKeyGenerator.class); |
| 73 | } | |
| 74 | } | |
| 75 | } | |
| 76 | 1 | if (header.contains(CacheConstants.HEADER_VALUE_X_MAGNOLIA_TTL)) { |
| 77 | 1 | ttl = Integer.parseInt(StringUtils.substringBetween(header, CacheConstants.HEADER_VALUE_X_MAGNOLIA_TTL + "=", ",")); |
| 78 | } | |
| 79 | } catch (NumberFormatException e) { | |
| 80 | 0 | log.error("Unparsable TTL in '{}' header: {}", CacheConstants.HEADER_X_MAGNOLIA_CACHE, header); |
| 81 | } catch (ClassNotFoundException e) { | |
| 82 | 0 | log.warn("Cannot use custom cache key generator class:", e); |
| 83 | } | |
| 84 | } | |
| 85 | } | |
| 86 | ||
| 87 | public Integer getTtl() { |
|
| 88 | return ttl; | |
| 89 | } | |
| 90 | ||
| 91 | public CacheKeyGenerator getKeyGenerator() { |
|
| 92 | return keyGenerator; | |
| 93 | } | |
| 94 | } |