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 java.io.*;
020import java.util.zip.*;
021
022/**
023 * Encoder for handling <js>"gzip"</js> encoding and decoding.
024 *
025 * <h5 class='section'>Notes:</h5><ul>
026 *    <li class='note'>This class is thread safe and reusable.
027 * </ul>
028 *
029 * <h5 class='section'>See Also:</h5><ul>
030 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/RestServerEncoders">Encoders</a>
031
032 * </ul>
033 */
034public class GzipEncoder extends Encoder {
035
036   @Override /* Encoder */
037   public OutputStream getOutputStream(OutputStream os) throws IOException {
038      return new FinishableGZIPOutputStream(os);
039   }
040
041   @Override /* Encoder */
042   public InputStream getInputStream(InputStream is) throws IOException {
043      return new GZIPInputStream(is);
044   }
045
046   /**
047    * Returns <code>[<js>"gzip"</js>]</code>.
048    */
049   @Override /* Encoder */
050   public String[] getCodings() {
051      return new String[]{"gzip"};
052   }
053
054   private static class FinishableGZIPOutputStream extends GZIPOutputStream implements Finishable {
055      FinishableGZIPOutputStream(OutputStream out) throws IOException {
056         super(out);
057      }
058   }
059}