# Package org.apache.commons.compress.archivers.dump

package org.apache.commons.compress.archivers.dump
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.

- Related Packages
  Package
  Description
  org.apache.commons.compress.archivers
  Provides a unified API and factories for dealing with archives in different formats.
- Class
  Description
  DumpArchiveConstants
  Various constants associated with dump archives.
  DumpArchiveConstants.COMPRESSION_TYPE
  Enumerates compression types.
  DumpArchiveConstants.SEGMENT_TYPE
  Enumerates the types of tape segment.
  DumpArchiveEntry
  This class represents an entry in a Dump archive.
  DumpArchiveEntry.PERMISSION
  Enumerates permissions with values.
  DumpArchiveEntry.TYPE
  Enumerates types.
  DumpArchiveException
  Signals that an dump archive exception of some sort has occurred.
  DumpArchiveInputStream
  The DumpArchiveInputStream reads a Unix dump archive as an InputStream.
  DumpArchiveSummary
  This class represents identifying information about a Dump archive volume.
  InvalidFormatException
  Invalid Format Exception.
  ShortFileException
  Short File Exception.
  UnrecognizedFormatException
  Unrecognized Format Exception.
  UnsupportedCompressionAlgorithmException
  Unsupported compression algorithm.