View Javadoc
1   /**
2    * This file Copyright (c) 2010-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.filter;
35  
36  import info.magnolia.module.cache.util.GZipUtil;
37  
38  import java.io.IOException;
39  import java.util.Collection;
40  
41  import javax.servlet.FilterChain;
42  import javax.servlet.http.HttpServletRequest;
43  import javax.servlet.http.HttpServletResponse;
44  
45  import org.apache.commons.collections.MultiMap;
46  
47  
48  /**
49   * Cache entry keeping the content in memory. Stores a gzipped and non-gzipped version.
50   * @author pbaerfuss
51   * @version $Id$
52   *
53   */
54  public class InMemoryCachedEntry extends ContentCachedEntry {
55  
56      private final byte[] gzippedContent;
57      private final byte[] plainContent;
58  
59      public InMemoryCachedEntry(byte[] out, String contentType, String characterEncoding, int statusCode, MultiMap headers, long modificationDate, String originalUrl, int timeToLiveInSeconds) throws IOException {
60          super(contentType, characterEncoding, statusCode, headers, modificationDate, originalUrl, timeToLiveInSeconds);
61          // content which is actually of a compressed type must stay that way
62          if (GZipUtil.isGZipped(out)) {
63              this.gzippedContent = out;
64              boolean isGzippedResponse = headers.containsKey("Content-Encoding") && ((Collection)headers.get("Content-Encoding")).contains("gzip");
65              if(isGzippedResponse){
66                  this.plainContent = GZipUtil.ungzip(out);
67              }
68              // in case of serving a gzip file (gif for instance)
69              else{
70                  this.plainContent = null;
71              }
72          } else {
73              this.gzippedContent = GZipUtil.gzip(out);
74              this.plainContent = out;
75          }
76      }
77  
78      @Override
79      protected boolean canServeGzipContent() {
80          return true;
81      }
82  
83      @Override
84      protected void writeContent(HttpServletRequest request, HttpServletResponse response, FilterChain chain, boolean acceptsGzipEncoding) throws IOException {
85          final byte[] body;
86          if (acceptsGzipEncoding || getPlainContent() == null) {
87              body = getGzippedContent();
88          } else {
89              body = getPlainContent();
90          }
91  
92          response.setContentLength(body.length);
93          response.getOutputStream().write(body);
94      }
95  
96  
97      public byte[] getPlainContent() {
98          return plainContent;
99      }
100 
101     public byte[] getGzippedContent() {
102         return gzippedContent;
103     }
104 
105 }