Clover icon

Magnolia Module Cache 5.5.9

  1. Project Clover database Mon Nov 25 2019 16:46:50 CET
  2. Package info.magnolia.module.cache.filter

File CachedError.java

 

Coverage histogram

../../../../../img/srcFileCovDistChart9.png
24% of files have more coverage

Code metrics

2
7
2
1
97
45
3
0.43
3.5
2
1.5
42.1% of code in this file is excluded from these metrics.

Classes

Class Line # Actions
CachedError 52 7 42.1% 3 2
0.818181881.8%
 

Contributing tests

This file is covered by 3 tests. .

Source view

1    /**
2    * This file Copyright (c) 2008-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.filter;
35   
36    import java.io.IOException;
37    import java.io.Serializable;
38   
39    import javax.servlet.FilterChain;
40    import javax.servlet.ServletException;
41    import javax.servlet.http.HttpServletRequest;
42    import javax.servlet.http.HttpServletResponse;
43   
44    import org.slf4j.Logger;
45    import org.slf4j.LoggerFactory;
46   
47    /**
48    * Contract for cached errors providing access to the error codes.
49    * @author gjoseph
50    * @version $Revision: $ ($Author: $)
51    */
 
52    public class CachedError implements CachedEntry, Serializable {
53   
54    private static Logger log = LoggerFactory.getLogger(CachedError.class);
55   
56    private final int statusCode;
57    private String originalUrl;
58    private long timestamp;
59    private int timeToLiveInSeconds = -1;
60   
 
61  3 toggle public CachedError(int statusCode, String originalUrl, int timeToLiveInSeconds) {
62  3 this.statusCode = statusCode;
63  3 this.originalUrl = originalUrl;
64  3 this.timestamp = System.currentTimeMillis();
65  3 this.timeToLiveInSeconds = timeToLiveInSeconds;
66    }
67   
 
68    toggle public int getStatusCode() {
69    return statusCode;
70    }
71   
 
72  3 toggle @Override
73    public void replay(HttpServletRequest request, HttpServletResponse response, FilterChain chain) throws IOException, ServletException {
74  3 if (!response.isCommitted()) {
75  3 response.sendError(getStatusCode());
76    } else {
77    //this usually happens first time the error occurs and is put in cache - since setting page as error causes it to be committed
78    // TODO: is there a better work around to make sure we do not swallow some exception accidentally?
79  0 log.debug("Failed to serve cached error due to response already committed.");
80    }
81    }
82   
 
83    toggle @Override
84    public String getOriginalURL() {
85    return originalUrl;
86    }
87   
 
88    toggle @Override
89    public long getLastModificationTime() {
90    return timestamp;
91    }
92   
 
93    toggle @Override
94    public int getTimeToLiveInSeconds() {
95    return timeToLiveInSeconds;
96    }
97    }