001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.juneau.encoders;
018
019import static org.apache.juneau.commons.utils.CollectionUtils.*;
020
021import java.io.*;
022import java.util.zip.*;
023
024/**
025 * Encoder for handling <js>"gzip"</js> encoding and decoding.
026 *
027 * <h5 class='section'>Notes:</h5><ul>
028 *    <li class='note'>This class is thread safe and reusable.
029 * </ul>
030 *
031 * <h5 class='section'>See Also:</h5><ul>
032 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/RestServerEncoders">Encoders</a>
033
034 * </ul>
035 */
036public class GzipEncoder extends Encoder {
037
038   private static class FinishableGZIPOutputStream extends GZIPOutputStream implements Finishable {
039      FinishableGZIPOutputStream(OutputStream out) throws IOException {
040         super(out);
041      }
042   }
043
044   /**
045    * Returns <code>[<js>"gzip"</js>]</code>.
046    */
047   @Override /* Overridden from Encoder */
048   public String[] getCodings() { return a("gzip"); }
049
050   @Override /* Overridden from Encoder */
051   public InputStream getInputStream(InputStream is) throws IOException {
052      return new GZIPInputStream(is);
053   }
054
055   @Override /* Overridden from Encoder */
056   public OutputStream getOutputStream(OutputStream os) throws IOException {
057      return new FinishableGZIPOutputStream(os);
058   }
059}