Thu, 22 Jan 2015 13:21:57 +0100
Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6
michael@0 | 1 | /* |
michael@0 | 2 | * ==================================================================== |
michael@0 | 3 | * |
michael@0 | 4 | * Licensed to the Apache Software Foundation (ASF) under one or more |
michael@0 | 5 | * contributor license agreements. See the NOTICE file distributed with |
michael@0 | 6 | * this work for additional information regarding copyright ownership. |
michael@0 | 7 | * The ASF licenses this file to You under the Apache License, Version 2.0 |
michael@0 | 8 | * (the "License"); you may not use this file except in compliance with |
michael@0 | 9 | * the License. You may obtain a copy of the License at |
michael@0 | 10 | * |
michael@0 | 11 | * http://www.apache.org/licenses/LICENSE-2.0 |
michael@0 | 12 | * |
michael@0 | 13 | * Unless required by applicable law or agreed to in writing, software |
michael@0 | 14 | * distributed under the License is distributed on an "AS IS" BASIS, |
michael@0 | 15 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
michael@0 | 16 | * See the License for the specific language governing permissions and |
michael@0 | 17 | * limitations under the License. |
michael@0 | 18 | * ==================================================================== |
michael@0 | 19 | * |
michael@0 | 20 | * This software consists of voluntary contributions made by many |
michael@0 | 21 | * individuals on behalf of the Apache Software Foundation. For more |
michael@0 | 22 | * information on the Apache Software Foundation, please see |
michael@0 | 23 | * <http://www.apache.org/>. |
michael@0 | 24 | * |
michael@0 | 25 | */ |
michael@0 | 26 | |
michael@0 | 27 | package ch.boye.httpclientandroidlib.client.protocol; |
michael@0 | 28 | |
michael@0 | 29 | import java.io.IOException; |
michael@0 | 30 | import java.util.Locale; |
michael@0 | 31 | |
michael@0 | 32 | import ch.boye.httpclientandroidlib.Header; |
michael@0 | 33 | import ch.boye.httpclientandroidlib.HeaderElement; |
michael@0 | 34 | import ch.boye.httpclientandroidlib.HttpEntity; |
michael@0 | 35 | import ch.boye.httpclientandroidlib.HttpException; |
michael@0 | 36 | import ch.boye.httpclientandroidlib.HttpResponse; |
michael@0 | 37 | import ch.boye.httpclientandroidlib.HttpResponseInterceptor; |
michael@0 | 38 | import ch.boye.httpclientandroidlib.annotation.Immutable; |
michael@0 | 39 | import ch.boye.httpclientandroidlib.client.entity.DeflateDecompressingEntity; |
michael@0 | 40 | import ch.boye.httpclientandroidlib.client.entity.GzipDecompressingEntity; |
michael@0 | 41 | import ch.boye.httpclientandroidlib.protocol.HttpContext; |
michael@0 | 42 | |
michael@0 | 43 | /** |
michael@0 | 44 | * {@link HttpResponseInterceptor} responsible for processing Content-Encoding |
michael@0 | 45 | * responses. |
michael@0 | 46 | * <p> |
michael@0 | 47 | * Instances of this class are stateless and immutable, therefore threadsafe. |
michael@0 | 48 | * |
michael@0 | 49 | * @since 4.1 |
michael@0 | 50 | * |
michael@0 | 51 | */ |
michael@0 | 52 | @Immutable |
michael@0 | 53 | public class ResponseContentEncoding implements HttpResponseInterceptor { |
michael@0 | 54 | |
michael@0 | 55 | /** |
michael@0 | 56 | * Handles the following {@code Content-Encoding}s by |
michael@0 | 57 | * using the appropriate decompressor to wrap the response Entity: |
michael@0 | 58 | * <ul> |
michael@0 | 59 | * <li>gzip - see {@link GzipDecompressingEntity}</li> |
michael@0 | 60 | * <li>deflate - see {@link DeflateDecompressingEntity}</li> |
michael@0 | 61 | * <li>identity - no action needed</li> |
michael@0 | 62 | * </ul> |
michael@0 | 63 | * |
michael@0 | 64 | * @param response the response which contains the entity |
michael@0 | 65 | * @param context not currently used |
michael@0 | 66 | * |
michael@0 | 67 | * @throws HttpException if the {@code Content-Encoding} is none of the above |
michael@0 | 68 | */ |
michael@0 | 69 | public void process( |
michael@0 | 70 | final HttpResponse response, |
michael@0 | 71 | final HttpContext context) throws HttpException, IOException { |
michael@0 | 72 | HttpEntity entity = response.getEntity(); |
michael@0 | 73 | |
michael@0 | 74 | // It wasn't a 304 Not Modified response, 204 No Content or similar |
michael@0 | 75 | if (entity != null) { |
michael@0 | 76 | Header ceheader = entity.getContentEncoding(); |
michael@0 | 77 | if (ceheader != null) { |
michael@0 | 78 | HeaderElement[] codecs = ceheader.getElements(); |
michael@0 | 79 | for (HeaderElement codec : codecs) { |
michael@0 | 80 | String codecname = codec.getName().toLowerCase(Locale.US); |
michael@0 | 81 | if ("gzip".equals(codecname) || "x-gzip".equals(codecname)) { |
michael@0 | 82 | response.setEntity(new GzipDecompressingEntity(response.getEntity())); |
michael@0 | 83 | return; |
michael@0 | 84 | } else if ("deflate".equals(codecname)) { |
michael@0 | 85 | response.setEntity(new DeflateDecompressingEntity(response.getEntity())); |
michael@0 | 86 | return; |
michael@0 | 87 | } else if ("identity".equals(codecname)) { |
michael@0 | 88 | |
michael@0 | 89 | /* Don't need to transform the content - no-op */ |
michael@0 | 90 | return; |
michael@0 | 91 | } else { |
michael@0 | 92 | throw new HttpException("Unsupported Content-Coding: " + codec.getName()); |
michael@0 | 93 | } |
michael@0 | 94 | } |
michael@0 | 95 | } |
michael@0 | 96 | } |
michael@0 | 97 | } |
michael@0 | 98 | |
michael@0 | 99 | } |