Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
   * Copyright (c) 2010-2012 Oracle and/or its affiliates. All rights reserved.
   * The contents of this file are subject to the terms of either the GNU
   * General Public License Version 2 only ("GPL") or the Common Development
   * and Distribution License("CDDL") (collectively, the "License").  You
   * may not use this file except in compliance with the License.  You can
  * obtain a copy of the License at
  * or packager/legal/LICENSE.txt.  See the License for the specific
  * language governing permissions and limitations under the License.
  * When distributing the software, include this License Header Notice in each
  * file and include the License file at packager/legal/LICENSE.txt.
  * GPL Classpath Exception:
  * Oracle designates this particular file as subject to the "Classpath"
  * exception as provided by Oracle in the GPL Version 2 section of the License
  * file that accompanied this code.
  * Modifications:
  * If applicable, add the following below the License Header, with the fields
  * enclosed by brackets [] replaced by your own identifying information:
  * "Portions Copyright [year] [name of copyright owner]"
  * Contributor(s):
  * If you wish your version of this file to be governed by only the CDDL or
  * only the GPL Version 2, indicate your decision by adding "[Contributor]
  * elects to include this software in this distribution under the [CDDL or GPL
  * Version 2] license."  If you don't indicate a single choice of license, a
  * recipient has the option to distribute your version of this file under
  * either the CDDL, the GPL Version 2 or to extend the choice of license to
  * its licensees as provided above.  However, if you add GPL Version 2 code
  * and therefore, elected the GPL Version 2 license, then the option applies
  * only if the new code is made subject to such option by the copyright
  * holder.
 package com.sun.jersey.api.container.filter;
A GZIP content encoding filter.

If the request contains a Content-Encoding header of "gzip" then the request entity (if any) is uncompressed using gzip. If the request contains an Accept-Encoding header containing "gzip" and an "If-None-Match" Header, entitytag value is checked: if it contains the -gzip suffix, remove this suffix, otherwise, completely remove the "if-none-match" header.

If the request contains a Accept-Encoding header that contains "gzip" then the response entity (if any) is compressed using gzip and a Content-Encoding header of "gzip" is added to the response. As this filter is active, the resource representation can be compressed. the value "Accept-Encoding" is so added to the Vary header. If any entityTag is used and content may be gzipped, the "-gzip" suffix is added to entitytag value.

When an application is deployed as a Servlet or Filter this Jersey filter can be registered using the following initialization parameters:

Note that if you're using Entitag for cache control and want to use this filter, you shoud add this filter to both ContainerFilters (Request and Response).

Paul Sandoz
Edouard Chevalier
See also:
     private static final String ENTITY_TAG_GZIP_SUFFIX_VALUE = "-gzip";
     private static final String ENTITY_TAG_GZIP_SUFFIX_HEADER_VALUE = "-gzip\""// Entity tag raw values always finish with a quotation mark within http headers.
     public ContainerRequest filter(ContainerRequest request) {
         String contentEncoding = request.getRequestHeaders().getFirst(.);
         if (contentEncoding != null && contentEncoding.trim().equals("gzip")) {
             try {
                        new GZIPInputStream(request.getEntityInputStream()));
            } catch (IOException ex) {
                throw new ContainerException(ex);
        // Check for entity tag header 'If-None-Match' in case of accept-encoding = gzip
        String acceptEncoding = request.getRequestHeaders().getFirst(.);
        String entityTag = request.getRequestHeaders().getFirst(.);
        if (acceptEncoding != null && acceptEncoding.contains("gzip") && entityTag != null) {
            // normalize entitytag (Note: maybe it should check whether it ends with a quotation mark ?)
            if (entityTag.endsWith()) {
                final int gzipsuffixbeginIndex = entityTag.lastIndexOf();
                final StringBuilder sb = new StringBuilder();
                sb.append(entityTag.substring(0, gzipsuffixbeginIndex));
            } else {
                // otherwise, remove if-none-match header
        return request;
    private static final class Adapter implements ContainerResponseWriter {
        private final ContainerResponseWriter crw;
        private GZIPOutputStream gos;
        Adapter(ContainerResponseWriter crw) {
            this. = crw;
        public OutputStream writeStatusAndHeaders(long contentLengthContainerResponse responsethrows IOException {
             = new GZIPOutputStream(.writeStatusAndHeaders(-1, response));
            return ;
        public void finish() throws IOException {
    public ContainerResponse filter(ContainerRequest requestContainerResponse response) {
        response.getHttpHeaders().add(..); // add vary header
        String acceptEncoding = request.getRequestHeaders().getFirst(.);
        String contentEncoding = (Stringresponse.getHttpHeaders().getFirst(.);
        if (acceptEncoding != null && contentEncoding == null && acceptEncoding.contains("gzip")) {
            // Check EntityTag header
            if (response.getHttpHeaders().containsKey(.)) {
                EntityTag entityTag = (EntityTagresponse.getHttpHeaders().getFirst(.);
                if (entityTag != null) {
                    response.getHttpHeaders().putSingle(.new EntityTag(entityTag.getValue()
                            + entityTag.isWeak()));
            // wrap entity with gzip
            if (response.getEntity() != null) {
                response.setContainerResponseWriter(new Adapter(response.getContainerResponseWriter()));
        return response;
New to GrepCode? Check out our FAQ X