View Javadoc

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