1 /*
2 * ====================================================================
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements. See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership. The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License. You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied. See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 * ====================================================================
20 *
21 * This software consists of voluntary contributions made by many
22 * individuals on behalf of the Apache Software Foundation. For more
23 * information on the Apache Software Foundation, please see
24 * <http://www.apache.org/>.
25 *
26 */
27 package org.apache.hc.client5.http.entity;
28
29 import java.io.IOException;
30 import java.io.InputStream;
31 import java.io.OutputStream;
32 import java.util.zip.GZIPOutputStream;
33
34 import org.apache.hc.core5.http.HttpEntity;
35 import org.apache.hc.core5.http.io.entity.HttpEntityWrapper;
36 import org.apache.hc.core5.util.Args;
37
38 /**
39 * Wrapping entity that compresses content when {@link #writeTo writing}.
40 *
41 *
42 * @since 4.0
43 */
44 public class GzipCompressingEntity extends HttpEntityWrapper {
45
46 private static final String GZIP_CODEC = "gzip";
47
48 public GzipCompressingEntity(final HttpEntity entity) {
49 super(entity);
50 }
51
52 @Override
53 public String getContentEncoding() {
54 return GZIP_CODEC;
55 }
56
57 @Override
58 public long getContentLength() {
59 return -1;
60 }
61
62 @Override
63 public boolean isChunked() {
64 // force content chunking
65 return true;
66 }
67
68 @Override
69 public InputStream getContent() throws IOException {
70 throw new UnsupportedOperationException();
71 }
72
73 @Override
74 public void writeTo(final OutputStream outStream) throws IOException {
75 Args.notNull(outStream, "Output stream");
76 final GZIPOutputStream gzip = new GZIPOutputStream(outStream);
77 super.writeTo(gzip);
78 // Only close output stream if the wrapped entity has been
79 // successfully written out
80 gzip.close();
81 }
82
83 }