| /* |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| */ |
| package org.apache.commons.compress.compressors; |
| |
| import java.io.IOException; |
| import java.io.InputStream; |
| import java.io.OutputStream; |
| |
| import org.apache.commons.compress.compressors.bzip2.BZip2CompressorInputStream; |
| import org.apache.commons.compress.compressors.bzip2.BZip2CompressorOutputStream; |
| import org.apache.commons.compress.compressors.deflate.DeflateCompressorInputStream; |
| import org.apache.commons.compress.compressors.deflate.DeflateCompressorOutputStream; |
| import org.apache.commons.compress.compressors.gzip.GzipCompressorInputStream; |
| import org.apache.commons.compress.compressors.gzip.GzipCompressorOutputStream; |
| import org.apache.commons.compress.compressors.lzma.LZMACompressorInputStream; |
| import org.apache.commons.compress.compressors.xz.XZCompressorInputStream; |
| import org.apache.commons.compress.compressors.xz.XZCompressorOutputStream; |
| import org.apache.commons.compress.compressors.xz.XZUtils; |
| import org.apache.commons.compress.compressors.pack200.Pack200CompressorInputStream; |
| import org.apache.commons.compress.compressors.pack200.Pack200CompressorOutputStream; |
| import org.apache.commons.compress.compressors.snappy.FramedSnappyCompressorInputStream; |
| import org.apache.commons.compress.compressors.snappy.SnappyCompressorInputStream; |
| import org.apache.commons.compress.compressors.z.ZCompressorInputStream; |
| import org.apache.commons.compress.utils.IOUtils; |
| |
| /** |
| * <p>Factory to create Compressor[In|Out]putStreams from names. To add other |
| * implementations you should extend CompressorStreamFactory and override the |
| * appropriate methods (and call their implementation from super of course).</p> |
| * |
| * Example (Compressing a file): |
| * |
| * <pre> |
| * final OutputStream out = new FileOutputStream(output); |
| * CompressorOutputStream cos = |
| * new CompressorStreamFactory().createCompressorOutputStream(CompressorStreamFactory.BZIP2, out); |
| * IOUtils.copy(new FileInputStream(input), cos); |
| * cos.close(); |
| * </pre> |
| * |
| * Example (Decompressing a file): |
| * <pre> |
| * final InputStream is = new FileInputStream(input); |
| * CompressorInputStream in = |
| * new CompressorStreamFactory().createCompressorInputStream(CompressorStreamFactory.BZIP2, is); |
| * IOUtils.copy(in, new FileOutputStream(output)); |
| * in.close(); |
| * </pre> |
| * @Immutable provided that the deprecated method setDecompressConcatenated is not used. |
| */ |
| public class CompressorStreamFactory { |
| |
| /** |
| * Constant (value {@value}) used to identify the BZIP2 compression algorithm. |
| * @since 1.1 |
| */ |
| public static final String BZIP2 = "bzip2"; |
| |
| /** |
| * Constant (value {@value}) used to identify the GZIP compression algorithm. |
| * Not supported as an output stream type. |
| * @since 1.1 |
| */ |
| public static final String GZIP = "gz"; |
| /** |
| * Constant (value {@value}) used to identify the PACK200 compression algorithm. |
| * @since 1.3 |
| */ |
| public static final String PACK200 = "pack200"; |
| |
| /** |
| * Constant (value {@value}) used to identify the XZ compression method. |
| * @since 1.4 |
| */ |
| public static final String XZ = "xz"; |
| |
| /** |
| * Constant (value {@value}) used to identify the LZMA compression method. |
| * Not supported as an output stream type. |
| * @since 1.6 |
| */ |
| public static final String LZMA = "lzma"; |
| |
| /** |
| * Constant (value {@value}) used to identify the "framed" Snappy compression method. |
| * Not supported as an output stream type. |
| * @since 1.7 |
| */ |
| public static final String SNAPPY_FRAMED = "snappy-framed"; |
| |
| /** |
| * Constant (value {@value}) used to identify the "raw" Snappy compression method. |
| * Not supported as an output stream type. |
| * @since 1.7 |
| */ |
| public static final String SNAPPY_RAW = "snappy-raw"; |
| |
| /** |
| * Constant (value {@value}) used to identify the traditional Unix compress method. |
| * Not supported as an output stream type. |
| * @since 1.7 |
| */ |
| public static final String Z = "z"; |
| |
| /** |
| * Constant (value {@value}) used to identify the Deflate compress method. |
| * @since 1.9 |
| */ |
| public static final String DEFLATE = "deflate"; |
| |
| /** |
| * If true, decompress until the end of the input. |
| * If false, stop after the first stream and leave the |
| * input position to point to the next byte after the stream |
| */ |
| private final Boolean decompressUntilEOF; |
| // This is Boolean so setDecompressConcatenated can determine whether it has been set by the ctor |
| // once the setDecompressConcatenated method has been removed, it can revert to boolean |
| |
| /** |
| * If true, decompress until the end of the input. |
| * If false, stop after the first stream and leave the |
| * input position to point to the next byte after the stream |
| */ |
| |
| private volatile boolean decompressConcatenated = false; |
| |
| /** |
| * Create an instance with the decompress Concatenated option set to false. |
| */ |
| public CompressorStreamFactory() { |
| this.decompressUntilEOF = null; |
| } |
| |
| /** |
| * Create an instance with the provided decompress Concatenated option. |
| * @param decompressUntilEOF |
| * if true, decompress until the end of the |
| * input; if false, stop after the first |
| * stream and leave the input position to point |
| * to the next byte after the stream. |
| * This setting applies to the gzip, bzip2 and xz formats only. |
| * @since 1.10 |
| */ |
| public CompressorStreamFactory(boolean decompressUntilEOF) { |
| this.decompressUntilEOF = Boolean.valueOf(decompressUntilEOF); |
| // Also copy to existing variable so can continue to use that as the current value |
| this.decompressConcatenated = decompressUntilEOF; |
| } |
| |
| /** |
| * Whether to decompress the full input or only the first stream |
| * in formats supporting multiple concatenated input streams. |
| * |
| * <p>This setting applies to the gzip, bzip2 and xz formats only.</p> |
| * |
| * @param decompressConcatenated |
| * if true, decompress until the end of the |
| * input; if false, stop after the first |
| * stream and leave the input position to point |
| * to the next byte after the stream |
| * @since 1.5 |
| * @deprecated 1.10 use the {@link #CompressorStreamFactory(boolean)} constructor instead |
| * @throws IllegalStateException if the constructor {@link #CompressorStreamFactory(boolean)} |
| * was used to create the factory |
| */ |
| @Deprecated |
| public void setDecompressConcatenated(boolean decompressConcatenated) { |
| if (this.decompressUntilEOF != null) { |
| throw new IllegalStateException("Cannot override the setting defined by the constructor"); |
| } |
| this.decompressConcatenated = decompressConcatenated; |
| } |
| |
| /** |
| * Create an compressor input stream from an input stream, autodetecting |
| * the compressor type from the first few bytes of the stream. The InputStream |
| * must support marks, like BufferedInputStream. |
| * |
| * @param in the input stream |
| * @return the compressor input stream |
| * @throws CompressorException if the compressor name is not known |
| * @throws IllegalArgumentException if the stream is null or does not support mark |
| * @since 1.1 |
| */ |
| public CompressorInputStream createCompressorInputStream(final InputStream in) |
| throws CompressorException { |
| if (in == null) { |
| throw new IllegalArgumentException("Stream must not be null."); |
| } |
| |
| if (!in.markSupported()) { |
| throw new IllegalArgumentException("Mark is not supported."); |
| } |
| |
| final byte[] signature = new byte[12]; |
| in.mark(signature.length); |
| try { |
| int signatureLength = IOUtils.readFully(in, signature); |
| in.reset(); |
| |
| if (BZip2CompressorInputStream.matches(signature, signatureLength)) { |
| return new BZip2CompressorInputStream(in, decompressConcatenated); |
| } |
| |
| if (GzipCompressorInputStream.matches(signature, signatureLength)) { |
| return new GzipCompressorInputStream(in, decompressConcatenated); |
| } |
| |
| if (Pack200CompressorInputStream.matches(signature, signatureLength)) { |
| return new Pack200CompressorInputStream(in); |
| } |
| |
| if (FramedSnappyCompressorInputStream.matches(signature, signatureLength)) { |
| return new FramedSnappyCompressorInputStream(in); |
| } |
| |
| if (ZCompressorInputStream.matches(signature, signatureLength)) { |
| return new ZCompressorInputStream(in); |
| } |
| |
| if (XZUtils.matches(signature, signatureLength) && |
| XZUtils.isXZCompressionAvailable()) { |
| return new XZCompressorInputStream(in, decompressConcatenated); |
| } |
| |
| } catch (IOException e) { |
| throw new CompressorException("Failed to detect Compressor from InputStream.", e); |
| } |
| |
| throw new CompressorException("No Compressor found for the stream signature."); |
| } |
| |
| /** |
| * Create a compressor input stream from a compressor name and an input stream. |
| * |
| * @param name of the compressor, |
| * i.e. {@value #GZIP}, {@value #BZIP2}, {@value #XZ}, {@value #LZMA}, |
| * {@value #PACK200}, {@value #SNAPPY_RAW}, {@value #SNAPPY_FRAMED}, |
| * {@value #Z} or {@value #DEFLATE} |
| * @param in the input stream |
| * @return compressor input stream |
| * @throws CompressorException if the compressor name is not known |
| * @throws IllegalArgumentException if the name or input stream is null |
| */ |
| public CompressorInputStream createCompressorInputStream(final String name, |
| final InputStream in) throws CompressorException { |
| if (name == null || in == null) { |
| throw new IllegalArgumentException( |
| "Compressor name and stream must not be null."); |
| } |
| |
| try { |
| |
| if (GZIP.equalsIgnoreCase(name)) { |
| return new GzipCompressorInputStream(in, decompressConcatenated); |
| } |
| |
| if (BZIP2.equalsIgnoreCase(name)) { |
| return new BZip2CompressorInputStream(in, decompressConcatenated); |
| } |
| |
| if (XZ.equalsIgnoreCase(name)) { |
| return new XZCompressorInputStream(in, decompressConcatenated); |
| } |
| |
| if (LZMA.equalsIgnoreCase(name)) { |
| return new LZMACompressorInputStream(in); |
| } |
| |
| if (PACK200.equalsIgnoreCase(name)) { |
| return new Pack200CompressorInputStream(in); |
| } |
| |
| if (SNAPPY_RAW.equalsIgnoreCase(name)) { |
| return new SnappyCompressorInputStream(in); |
| } |
| |
| if (SNAPPY_FRAMED.equalsIgnoreCase(name)) { |
| return new FramedSnappyCompressorInputStream(in); |
| } |
| |
| if (Z.equalsIgnoreCase(name)) { |
| return new ZCompressorInputStream(in); |
| } |
| |
| if (DEFLATE.equalsIgnoreCase(name)) { |
| return new DeflateCompressorInputStream(in); |
| } |
| |
| } catch (IOException e) { |
| throw new CompressorException( |
| "Could not create CompressorInputStream.", e); |
| } |
| throw new CompressorException("Compressor: " + name + " not found."); |
| } |
| |
| /** |
| * Create an compressor output stream from an compressor name and an output stream. |
| * |
| * @param name the compressor name, |
| * i.e. {@value #GZIP}, {@value #BZIP2}, {@value #XZ}, |
| * {@value #PACK200} or {@value #DEFLATE} |
| * @param out the output stream |
| * @return the compressor output stream |
| * @throws CompressorException if the archiver name is not known |
| * @throws IllegalArgumentException if the archiver name or stream is null |
| */ |
| public CompressorOutputStream createCompressorOutputStream( |
| final String name, final OutputStream out) |
| throws CompressorException { |
| if (name == null || out == null) { |
| throw new IllegalArgumentException( |
| "Compressor name and stream must not be null."); |
| } |
| |
| try { |
| |
| if (GZIP.equalsIgnoreCase(name)) { |
| return new GzipCompressorOutputStream(out); |
| } |
| |
| if (BZIP2.equalsIgnoreCase(name)) { |
| return new BZip2CompressorOutputStream(out); |
| } |
| |
| if (XZ.equalsIgnoreCase(name)) { |
| return new XZCompressorOutputStream(out); |
| } |
| |
| if (PACK200.equalsIgnoreCase(name)) { |
| return new Pack200CompressorOutputStream(out); |
| } |
| |
| if (DEFLATE.equalsIgnoreCase(name)) { |
| return new DeflateCompressorOutputStream(out); |
| } |
| |
| } catch (IOException e) { |
| throw new CompressorException( |
| "Could not create CompressorOutputStream", e); |
| } |
| throw new CompressorException("Compressor: " + name + " not found."); |
| } |
| |
| // For Unit tests |
| boolean getDecompressConcatenated() { |
| return decompressConcatenated; |
| } |
| } |