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 DelegatingBlobCachedEntry.java

 

Coverage histogram

../../../../../img/srcFileCovDistChart6.png
59% of files have more coverage

Code metrics

6
22
6
1
127
64
9
0.41
3.67
6
1.5

Classes

Class Line # Actions
DelegatingBlobCachedEntry 64 22 0% 9 16
0.529411852.9%
 

Contributing tests

This file is covered by 1 test. .

Source view

1    /**
2    * This file Copyright (c) 2010-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.File;
37    import java.io.FileInputStream;
38    import java.io.IOException;
39   
40    import javax.servlet.FilterChain;
41    import javax.servlet.ServletException;
42    import javax.servlet.http.HttpServletRequest;
43    import javax.servlet.http.HttpServletResponse;
44   
45    import org.apache.commons.collections4.MultiMap;
46    import org.apache.commons.io.FileUtils;
47    import org.apache.commons.io.IOUtils;
48    import org.slf4j.Logger;
49    import org.slf4j.LoggerFactory;
50   
51   
52    /**
53    * Used for large responses. Typically we don't want to cache big responses as they are so costly to keep in memory and
54    * tend to evict so much from the cache where they're put in that net performance drops. This cache entry does not keep
55    * the response in memory, instead it serves it from a file on disk or if there's no file it proceeds with rendering.
56    * When it has used the file once it deletes it. The entry still remains in cache and serves as a token to prevent
57    * caching in the future.
58    *
59    * The file is created by {@link CacheResponseWrapper} when it reaches its set threshold.
60    *
61    * @version $Id$
62    * @see CacheResponseWrapper
63    */
 
64    public class DelegatingBlobCachedEntry extends ContentCachedEntry {
65   
66    private static Logger log = LoggerFactory.getLogger(DelegatingBlobCachedEntry.class);
67   
68   
69    public static final String CONTENT_FILE_ATTRIBUTE = DelegatingBlobCachedEntry.class.getName() + ".contentFile";
70   
71    private final long contentLength;
72   
 
73  1 toggle public DelegatingBlobCachedEntry(long contentLength, String contentType, String characterEncoding, int statusCode, MultiMap headers, long modificationDate, String originalUrl, int timeToLiveInSeconds) throws IOException {
74  1 super(contentType, characterEncoding, statusCode, headers, modificationDate, originalUrl, timeToLiveInSeconds);
75  1 this.contentLength = contentLength;
76    }
77   
 
78  0 toggle @Override
79    protected boolean canServeGzipContent() {
80  0 return false;
81    }
82   
 
83  0 toggle @Override
84    public void replay(HttpServletRequest request, HttpServletResponse response, FilterChain chain) throws IOException, ServletException {
85  0 File contentFile = getContentFileBoundToTheRequest(request);
86  0 if(contentFile != null){
87  0 log.debug("About to serve response from {}", contentFile.getAbsolutePath());
88  0 super.replay(request, response, chain);
89    }
90    else{
91  0 chain.doFilter(request, response);
92    }
93    }
94   
 
95  1 toggle @Override
96    protected void writeContent(HttpServletRequest request, HttpServletResponse response, FilterChain chain, boolean acceptsGzipEncoding) throws IOException, ServletException {
97  1 response.setContentLength((int) contentLength);
98   
99  1 File contentFile = getContentFileBoundToTheRequest(request);
100  1 if(contentFile != null){
101  1 log.debug("Streaming out output from {}", contentFile.getAbsolutePath());
102  1 FileInputStream contentStream = FileUtils.openInputStream(contentFile);
103  1 try{
104  1 IOUtils.copy(contentStream,response.getOutputStream());
105    }finally{
106  1 IOUtils.closeQuietly(contentStream);
107  1 log.debug("About to delete temp file {}", contentFile.getAbsolutePath());
108  1 if(!contentFile.delete()){
109  0 log.error("Can't delete file: " + contentFile);
110    }
111    }
112    }
113    else{
114    // should not happen as we delegate to the filter chain in replay in that case and ignore all cached data
115  0 throw new IllegalStateException("No content file attached to the request!");
116    }
117    }
118   
 
119  1 toggle private File getContentFileBoundToTheRequest(HttpServletRequest request) {
120  1 return (File) request.getAttribute(CONTENT_FILE_ATTRIBUTE);
121    }
122   
 
123  0 toggle public void bindContentFileToCurrentRequest(HttpServletRequest request, File contentFile){
124  0 request.setAttribute(DelegatingBlobCachedEntry.CONTENT_FILE_ATTRIBUTE, contentFile);
125    }
126   
127    }