org.apache.commons.compress.archivers.dump.package-info Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of commons-compress Show documentation

Apache Commons Compress software defines an API for working with compression and archive formats. These include: bzip2, gzip, pack200, lzma, xz, Snappy, traditional Unix Compress, DEFLATE, DEFLATE64, LZ4, Brotli, Zstandard and ar, cpio, jar, tar, zip, dump, 7z, arj.

There is a newer version: 1.27.1

Show newest version

/*
 * 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.
 */

/**
 * This package provides stream classes for reading archives using the UNIX DUMP format.
 * 
 * This format is similar to (and contemporary with) TAR but reads the raw filesystem directly. This means that writers are filesystem-specific even though the
 * created archives are filesystem-agnostic.
 * 
 *
 * 
 * Unlike other formats DUMP offers clean support for sparse files, extended attributes, and other file metadata. In addition DUMP supports incremental dump
 * files can capture (most) file deletion. It also provides a native form of compression and will soon support native encryption as well.
 * 
 * 
 * In practice TAR archives are used for both distribution and backups. DUMP archives are used exclusively for backups.
 * 
 * 
 * Like any 30+-year-old application there are a number of variants. For pragmatic reasons we will only support archives with the 'new' tape header and inode
 * formats. Other restrictions:
 * 
 * 
 * We only support ZLIB compression. The format also permits LZO and BZLIB compression.
 * Sparse files will have the holes filled.
 * MacOS finder and resource streams are ignored.
 * Extended attributes are not currently provided.
 * SELinux labels are not currently provided.
 * 
 * 
 * As of Apache Commons Compress 1.3 support for the dump format is read-only.
 * 
 */
package org.apache.commons.compress.archivers.dump;