Module kala.compress.archivers.tar
Package kala.compress.archivers.tar

Class TarArchiveEntry

  • All Implemented Interfaces:
    ArchiveEntry, EntryStreamOffsets, TarConstants
    public class TarArchiveEntry
extends java.lang.Object
implements ArchiveEntry, TarConstants, EntryStreamOffsets
    An entry in a Tar archive. It consists of the entry's header, as well as the entry's File. Entries can be instantiated in one of three ways, depending on how they are to be used.

    TarEntries that are created from the header bytes read from an archive are instantiated with the TarArchiveEntry(byte[]) constructor. These entries will be used when extracting from or listing the contents of an archive. These entries have their header filled in using the header bytes. They also set the File to null, since they reference an archive entry not a file.

    TarEntries that are created from Files that are to be written into an archive are instantiated with the TarArchiveEntry(Path) constructor. These entries have their header filled in using the File's information. They also keep a reference to the File for convenience when writing entries.

    Finally, TarEntries can be constructed from nothing but a name. This allows the programmer to construct the entry by hand, for instance when only an InputStream is available for writing to the archive, and the header information is constructed from other information. In this case the header fields are set to defaults and the File is set to null.

    The C structure for a Tar Entry's header is: 

     struct header {
   char name[100];     // TarConstants.NAMELEN    - offset   0
   char mode[8];       // TarConstants.MODELEN    - offset 100
   char uid[8];        // TarConstants.UIDLEN     - offset 108
   char gid[8];        // TarConstants.GIDLEN     - offset 116
   char size[12];      // TarConstants.SIZELEN    - offset 124
   char mtime[12];     // TarConstants.MODTIMELEN - offset 136
   char chksum[8];     // TarConstants.CHKSUMLEN  - offset 148
   char linkflag[1];   //                         - offset 156
   char linkname[100]; // TarConstants.NAMELEN    - offset 157
   // The following fields are only present in new-style POSIX tar archives:
   char magic[6];      // TarConstants.MAGICLEN   - offset 257
   char version[2];    // TarConstants.VERSIONLEN - offset 263
   char uname[32];     // TarConstants.UNAMELEN   - offset 265
   char gname[32];     // TarConstants.GNAMELEN   - offset 297
   char devmajor[8];   // TarConstants.DEVLEN     - offset 329
   char devminor[8];   // TarConstants.DEVLEN     - offset 337
   char prefix[155];   // TarConstants.PREFIXLEN  - offset 345
   // Used if "name" field is not long enough to hold the path
   char pad[12];       // NULs                    - offset 500
 } header;

    All unused bytes are set to null. New-style GNU tar files are slightly different from the above. For values of size larger than 077777777777L (11 7s) or uid and gid larger than 07777777L (7 7s) the sign bit of the first byte is set, and the rest of the field is the binary representation of the number. See TarUtils.parseOctalOrBinary(byte[], int, int).

    The C structure for a old GNU Tar Entry's header is: 

     struct oldgnu_header {
   char unused_pad1[345]; // TarConstants.PAD1LEN_GNU       - offset 0
   char atime[12];        // TarConstants.ATIMELEN_GNU      - offset 345
   char ctime[12];        // TarConstants.CTIMELEN_GNU      - offset 357
   char offset[12];       // TarConstants.OFFSETLEN_GNU     - offset 369
   char longnames[4];     // TarConstants.LONGNAMESLEN_GNU  - offset 381
   char unused_pad2;      // TarConstants.PAD2LEN_GNU       - offset 385
   struct sparse sp[4];   // TarConstants.SPARSELEN_GNU     - offset 386
   char isextended;       // TarConstants.ISEXTENDEDLEN_GNU - offset 482
   char realsize[12];     // TarConstants.REALSIZELEN_GNU   - offset 483
   char unused_pad[17];   // TarConstants.PAD3LEN_GNU       - offset 495
 };

    Whereas, "struct sparse" is: 

     struct sparse {
   char offset[12];   // offset 0
   char numbytes[12]; // offset 12
 };

    The C structure for a xstar (Jörg Schilling star) Tar Entry's header is: 

     struct star_header {
   char name[100];     // offset   0
   char mode[8];       // offset 100
   char uid[8];        // offset 108
   char gid[8];        // offset 116
   char size[12];      // offset 124
   char mtime[12];     // offset 136
   char chksum[8];     // offset 148
   char typeflag;      // offset 156
   char linkname[100]; // offset 157
   char magic[6];      // offset 257
   char version[2];    // offset 263
   char uname[32];     // offset 265
   char gname[32];     // offset 297
   char devmajor[8];   // offset 329
   char devminor[8];   // offset 337
   char prefix[131];   // offset 345
   char atime[12];     // offset 476
   char ctime[12];     // offset 488
   char mfill[8];      // offset 500
   char xmagic[4];     // offset 508  "tar\0"
 };

    which is identical to new-style POSIX up to the first 130 bytes of the prefix.

    The C structure for the xstar-specific parts of a xstar Tar Entry's header is: 

     struct xstar_in_header {
   char fill[345];         // offset 0     Everything before t_prefix
   char prefix[1];         // offset 345   Prefix for t_name
   char fill2;             // offset 346
   char fill3[8];          // offset 347
   char isextended;        // offset 355
   struct sparse sp[SIH];  // offset 356   8 x 12
   char realsize[12];      // offset 452   Real size for sparse data
   char offset[12];        // offset 464   Offset for multivolume data
   char atime[12];         // offset 476
   char ctime[12];         // offset 488
   char mfill[8];          // offset 500
   char xmagic[4];         // offset 508   "tar\0"
 };

    • Field Detail

      • EMPTY_TAR_ARCHIVE_ENTRY_ARRAY

        private static final TarArchiveEntry[] EMPTY_TAR_ARCHIVE_ENTRY_ARRAY

      • UNKNOWN

        public static final long UNKNOWN
        Value used to indicate unknown mode, user/groupids, device numbers and modTime when parsing a file in lenient mode and the archive contains illegal fields.
        Since:
        1.19
        See Also:
        Constant Field Values

      • MAX_NAMELEN

        public static final int MAX_NAMELEN
        Maximum length of a user's name in the tar file
        See Also:
        Constant Field Values

      • DEFAULT_DIR_MODE

        public static final int DEFAULT_DIR_MODE
        Default permissions bits for directories
        See Also:
        Constant Field Values

      • DEFAULT_FILE_MODE

        public static final int DEFAULT_FILE_MODE
        Default permissions bits for files
        See Also:
        Constant Field Values

      • PAX_EXTENDED_HEADER_FILE_TIMES_PATTERN

        private static final java.util.regex.Pattern PAX_EXTENDED_HEADER_FILE_TIMES_PATTERN
        Regular expression pattern for validating values in pax extended header file time fields. These fields contain two numeric values (seconds and sub-second values) as per this definition: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/pax.html#tag_20_92_13_05

        Since they are parsed into long values, maximum length of each is the same as Long.MAX_VALUE which is 19 digits.

      • name

        private java.lang.String name
        The entry's name.

      • preserveAbsolutePath

        private final boolean preserveAbsolutePath
        Whether to allow leading slashes or drive names inside the name

      • mode

        private int mode
        The entry's permission mode.

      • userId

        private long userId
        The entry's user id.

      • groupId

        private long groupId
        The entry's group id.

      • size

        private long size
        The entry's size.

      • mTime

        private java.nio.file.attribute.FileTime mTime
        The entry's modification time. Corresponds to the POSIX mtime attribute.

      • cTime

        private java.nio.file.attribute.FileTime cTime
        The entry's status change time. Corresponds to the POSIX ctime attribute.
        Since:
        1.22

      • aTime

        private java.nio.file.attribute.FileTime aTime
        The entry's last access time. Corresponds to the POSIX atime attribute.
        Since:
        1.22

      • birthTime

        private java.nio.file.attribute.FileTime birthTime
        The entry's creation time. Corresponds to the POSIX birthtime attribute.
        Since:
        1.22

      • checkSumOK

        private boolean checkSumOK
        If the header checksum is reasonably correct.

      • linkFlag

        private byte linkFlag
        The entry's link flag.

      • linkName

        private java.lang.String linkName
        The entry's link name.

      • magic

        private java.lang.String magic
        The entry's magic tag.

      • version

        private java.lang.String version
        The version of the format

      • userName

        private java.lang.String userName
        The entry's user name.

      • groupName

        private java.lang.String groupName
        The entry's group name.

      • devMajor

        private int devMajor
        The entry's major device number.

      • devMinor

        private int devMinor
        The entry's minor device number.

      • isExtended

        private boolean isExtended
        If an extension sparse header follows.

      • realSize

        private long realSize
        The entry's real size in case of a sparse file.

      • paxGNUSparse

        private boolean paxGNUSparse
        Is this entry a GNU sparse entry using one of the PAX formats?

      • paxGNU1XSparse

        private boolean paxGNU1XSparse
        is this entry a GNU sparse entry using 1.X PAX formats? the sparse headers of 1.x PAX Format is stored in file data block

      • starSparse

        private boolean starSparse
        Is this entry a star sparse entry using the PAX header?

      • file

        private final java.nio.file.Path file
        The entry's file reference

      • linkOptions

        private final java.nio.file.LinkOption[] linkOptions
        The entry's file linkOptions

      • extraPaxHeaders

        private final java.util.Map<java.lang.String,​java.lang.String> extraPaxHeaders
        Extra, user supplied pax headers

      • dataOffset

        private long dataOffset

    • Constructor Detail

      • TarArchiveEntry

        private TarArchiveEntry​(boolean preserveAbsolutePath)
        Constructs an empty entry and prepares the header values.

      • TarArchiveEntry

        public TarArchiveEntry​(byte[] headerBuf)
        Constructs an entry from an archive's header bytes. File is set to null.
        Parameters:
        headerBuf - The header bytes from a tar archive entry.
        Throws:
        java.lang.IllegalArgumentException - if any of the numeric fields have an invalid format

      • TarArchiveEntry

        public TarArchiveEntry​(byte[] headerBuf,
                       java.nio.charset.Charset encoding)
                throws java.io.IOException
        Constructs an entry from an archive's header bytes. File is set to null.
        Parameters:
        headerBuf - The header bytes from a tar archive entry.
        encoding - encoding to use for file names
        Throws:
        java.lang.IllegalArgumentException - if any of the numeric fields have an invalid format
        java.io.IOException - on error
        Since:
        1.27.1-0

      • TarArchiveEntry

        public TarArchiveEntry​(byte[] headerBuf,
                       java.nio.charset.Charset encoding,
                       boolean lenient)
                throws java.io.IOException
        Constructs an entry from an archive's header bytes. File is set to null.
        Parameters:
        headerBuf - The header bytes from a tar archive entry.
        encoding - encoding to use for file names
        lenient - when set to true illegal values for group/userid, mode, device numbers and timestamp will be ignored and the fields set to UNKNOWN. When set to false such illegal fields cause an exception instead.
        Throws:
        java.lang.IllegalArgumentException - if any of the numeric fields have an invalid format
        java.io.IOException - on error
        Since:
        1.27.1-0

      • TarArchiveEntry

        public TarArchiveEntry​(byte[] headerBuf,
                       java.nio.charset.Charset encoding,
                       boolean lenient,
                       long dataOffset)
                throws java.io.IOException
        Constructs an entry from an archive's header bytes for random access tar. File is set to null.
        Parameters:
        headerBuf - the header bytes from a tar archive entry.
        encoding - encoding to use for file names.
        lenient - when set to true illegal values for group/userid, mode, device numbers and timestamp will be ignored and the fields set to UNKNOWN. When set to false such illegal fields cause an exception instead.
        dataOffset - position of the entry data in the random access file.
        Throws:
        java.lang.IllegalArgumentException - if any of the numeric fields have an invalid format.
        java.io.IOException - on error.
        Since:
        1.27.1-0

      • TarArchiveEntry

        public TarArchiveEntry​(java.util.Map<java.lang.String,​java.lang.String> globalPaxHeaders,
                       byte[] headerBuf,
                       java.nio.charset.Charset encoding,
                       boolean lenient)
                throws java.io.IOException
        Constructs an entry from an archive's header bytes. File is set to null.
        Parameters:
        globalPaxHeaders - the parsed global PAX headers, or null if this is the first one.
        headerBuf - The header bytes from a tar archive entry.
        encoding - encoding to use for file names
        lenient - when set to true illegal values for group/userid, mode, device numbers and timestamp will be ignored and the fields set to UNKNOWN. When set to false such illegal fields cause an exception instead.
        Throws:
        java.lang.IllegalArgumentException - if any of the numeric fields have an invalid format
        java.io.IOException - on error
        Since:
        1.27.1-0

      • TarArchiveEntry

        public TarArchiveEntry​(java.util.Map<java.lang.String,​java.lang.String> globalPaxHeaders,
                       byte[] headerBuf,
                       java.nio.charset.Charset encoding,
                       boolean lenient,
                       long dataOffset)
                throws java.io.IOException
        Constructs an entry from an archive's header bytes for random access tar. File is set to null.
        Parameters:
        globalPaxHeaders - the parsed global PAX headers, or null if this is the first one.
        headerBuf - the header bytes from a tar archive entry.
        encoding - encoding to use for file names.
        lenient - when set to true illegal values for group/userid, mode, device numbers and timestamp will be ignored and the fields set to UNKNOWN. When set to false such illegal fields cause an exception instead.
        dataOffset - position of the entry data in the random access file.
        Throws:
        java.lang.IllegalArgumentException - if any of the numeric fields have an invalid format.
        java.io.IOException - on error.
        Since:
        1.27.1-0

      • TarArchiveEntry

        public TarArchiveEntry​(java.nio.file.Path file)
                throws java.io.IOException
        Constructs an entry for a file. File is set to file, and the header is constructed from information from the file. The name is set from the normalized file path.

        The entry's name will be the value of the file's path with all file separators replaced by forward slashes and leading slashes as well as Windows drive letters stripped. The name will end in a slash if the file represents a directory.

        Parameters:
        file - The file that the entry represents.
        Throws:
        java.io.IOException - if an I/O error occurs
        Since:
        1.21

      • TarArchiveEntry

        public TarArchiveEntry​(java.nio.file.Path file,
                       java.lang.String fileName,
                       java.nio.file.LinkOption... linkOptions)
                throws java.io.IOException
        Constructs an entry for a file. File is set to file, and the header is constructed from information from the file.

        The entry's name will be the value of the fileName argument with all file separators replaced by forward slashes and leading slashes as well as Windows drive letters stripped. The name will end in a slash if the file represents a directory.

        Parameters:
        file - The file that the entry represents.
        fileName - the name to be used for the entry.
        linkOptions - options indicating how symbolic links are handled.
        Throws:
        java.io.IOException - if an I/O error occurs
        Since:
        1.21

      • TarArchiveEntry

        public TarArchiveEntry​(java.lang.String name)
        Constructs an entry with only a name. This allows the programmer to construct the entry's header "by hand". File is set to null.

        The entry's name will be the value of the name argument with all file separators replaced by forward slashes and leading slashes as well as Windows drive letters stripped.

        Parameters:
        name - the entry name

      • TarArchiveEntry

        public TarArchiveEntry​(java.lang.String name,
                       boolean preserveAbsolutePath)
        Constructs an entry with only a name. This allows the programmer to construct the entry's header "by hand". File is set to null.

        The entry's name will be the value of the name argument with all file separators replaced by forward slashes. Leading slashes and Windows drive letters are stripped if preserveAbsolutePath is false.

        Parameters:
        name - the entry name
        preserveAbsolutePath - whether to allow leading slashes or drive letters in the name.
        Since:
        1.1

      • TarArchiveEntry

        public TarArchiveEntry​(java.lang.String name,
                       byte linkFlag)
        Constructs an entry with a name and a link flag.

        The entry's name will be the value of the name argument with all file separators replaced by forward slashes and leading slashes as well as Windows drive letters stripped.

        Parameters:
        name - the entry name
        linkFlag - the entry link flag.

      • TarArchiveEntry

        public TarArchiveEntry​(java.lang.String name,
                       byte linkFlag,
                       boolean preserveAbsolutePath)
        Constructs an entry with a name and a link flag.

        The entry's name will be the value of the name argument with all file separators replaced by forward slashes. Leading slashes and Windows drive letters are stripped if preserveAbsolutePath is false.

        Parameters:
        name - the entry name
        linkFlag - the entry link flag.
        preserveAbsolutePath - whether to allow leading slashes or drive letters in the name.
        Since:
        1.5

    • Method Detail

      • fileTimeFromOptionalSeconds

        private static java.nio.file.attribute.FileTime fileTimeFromOptionalSeconds​(long seconds)

      • normalizeFileName

        private static java.lang.String normalizeFileName​(java.lang.String fileName,
                                                  boolean preserveAbsolutePath)
        Strips Windows' drive letter as well as any leading slashes, turns path separators into forward slashes.

      • parseInstantFromDecimalSeconds

        private static java.time.Instant parseInstantFromDecimalSeconds​(java.lang.String value)
                                                         throws java.io.IOException
        Throws:
        java.io.IOException

      • addPaxHeader

        public void addPaxHeader​(java.lang.String name,
                         java.lang.String value)
        Adds a PAX header to this entry. If the header corresponds to an existing field in the entry, that field will be set; otherwise the header will be added to the extraPaxHeaders Map
        Parameters:
        name - The full name of the header to set.
        value - value of header.
        Since:
        1.15

      • clearExtraPaxHeaders

        public void clearExtraPaxHeaders()
        Clears all extra PAX headers.
        Since:
        1.15

      • equals

        public boolean equals​(java.lang.Object it)
        Determine if the two entries are equal. Equality is determined by the header names being equal.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        it - Entry to be checked for equality.
        Returns:
        True if the entries are equal.

      • equals

        public boolean equals​(TarArchiveEntry it)
        Determine if the two entries are equal. Equality is determined by the header names being equal.
        Parameters:
        it - Entry to be checked for equality.
        Returns:
        True if the entries are equal.

      • evaluateType

        private int evaluateType​(java.util.Map<java.lang.String,​java.lang.String> globalPaxHeaders,
                         byte[] header)
        Evaluates an entry's header format from a header buffer.
        Parameters:
        header - The tar entry header buffer to evaluate the format for.
        Returns:
        format type

      • fill

        private int fill​(byte value,
                 int offset,
                 byte[] outbuf,
                 int length)

      • fill

        private int fill​(int value,
                 int offset,
                 byte[] outbuf,
                 int length)

      • fillGNUSparse0xData

        void fillGNUSparse0xData​(java.util.Map<java.lang.String,​java.lang.String> headers)
                  throws java.io.IOException
        Throws:
        java.io.IOException

      • fillGNUSparse1xData

        void fillGNUSparse1xData​(java.util.Map<java.lang.String,​java.lang.String> headers)
                  throws java.io.IOException
        Throws:
        java.io.IOException

      • fillStarSparseData

        void fillStarSparseData​(java.util.Map<java.lang.String,​java.lang.String> headers)
                 throws java.io.IOException
        Throws:
        java.io.IOException

      • getCreationTime

        public java.nio.file.attribute.FileTime getCreationTime()
        Gets this entry's creation time.
        Returns:
        This entry's computed creation time.
        Since:
        1.22

      • getDataOffset

        public long getDataOffset()
        Gets the offset of data stream within the archive file,
        Specified by:
        getDataOffset in interface EntryStreamOffsets
        Returns:
        the offset of entry data stream, OFFSET_UNKNOWN if not known.
        Since:
        1.21

      • getDevMajor

        public int getDevMajor()
        Gets this entry's major device number.
        Returns:
        This entry's major device number.
        Since:
        1.4

      • getDevMinor

        public int getDevMinor()
        Gets this entry's minor device number.
        Returns:
        This entry's minor device number.
        Since:
        1.4

      • getDirectoryEntries

        public TarArchiveEntry[] getDirectoryEntries()
        If this entry represents a file, and the file is a directory, return an array of TarEntries for this entry's children.

        This method is only useful for entries created from a File or Path but not for entries read from an archive.

        Returns:
        An array of TarEntry's for this entry's children.

      • getExtraPaxHeader

        public java.lang.String getExtraPaxHeader​(java.lang.String name)
        Gets named extra PAX header
        Parameters:
        name - The full name of an extended PAX header to retrieve
        Returns:
        The value of the header, if any.
        Since:
        1.15

      • getExtraPaxHeaders

        public java.util.Map<java.lang.String,​java.lang.String> getExtraPaxHeaders()
        Gets extra PAX Headers
        Returns:
        read-only map containing any extra PAX Headers
        Since:
        1.15

      • getGroupName

        public java.lang.String getGroupName()
        Gets this entry's group name.
        Returns:
        This entry's group name.

      • getLastAccessTime

        public java.nio.file.attribute.FileTime getLastAccessTime()
        Gets this entry's last access time.
        Returns:
        This entry's last access time.
        Since:
        1.22

      • getLastModifiedTime

        public java.nio.file.attribute.FileTime getLastModifiedTime()
        Gets this entry's modification time.
        Specified by:
        getLastModifiedTime in interface ArchiveEntry
        Returns:
        This entry's modification time.
        Since:
        1.22

      • getLinkFlag

        public byte getLinkFlag()
        Gets this entry's link flag.
        Returns:
        this entry's link flag.
        Since:
        1.23

      • getLinkName

        public java.lang.String getLinkName()
        Gets this entry's link name.
        Returns:
        This entry's link name.

      • getGroupId

        public long getGroupId()
        Gets this entry's group id.
        Returns:
        This entry's group id.
        Since:
        1.27.1-0

      • getLongGroupId

        @Deprecated
public long getLongGroupId()
        Deprecated.
        See getGroupId()
        Gets this entry's group id.
        Returns:
        This entry's group id.
        Since:
        1.10

      • getUserId

        public long getUserId()
        Gets this entry's user id.
        Returns:
        This entry's user id.
        Since:
        1.27.1-0

      • getLongUserId

        @Deprecated
public long getLongUserId()
        Deprecated.
        See getUserId()
        Gets this entry's user id.
        Returns:
        This entry's user id.
        Since:
        1.10

      • getMode

        public int getMode()
        Gets this entry's mode.
        Returns:
        This entry's mode.

      • getModTime

        public java.nio.file.attribute.FileTime getModTime()
        Gets this entry's modification time. This is equivalent to getLastModifiedTime(), but precision is truncated to milliseconds.
        Returns:
        This entry's modification time.
        Since:
        1.27.1-0
        See Also:
        getLastModifiedTime()

      • getName

        public java.lang.String getName()
        Gets this entry's name.

        This method returns the raw name as it is stored inside of the archive.

        Specified by:
        getName in interface ArchiveEntry
        Returns:
        This entry's name.

      • getOrderedSparseHeaders

        public java.util.List<TarArchiveStructSparse> getOrderedSparseHeaders()
                                                               throws java.io.IOException
        Gets this entry's sparse headers ordered by offset with all empty sparse sections at the start filtered out.
        Returns:
        immutable list of this entry's sparse headers, never null
        Throws:
        java.io.IOException - if the list of sparse headers contains blocks that overlap
        Since:
        1.21

      • getPath

        public java.nio.file.Path getPath()
        Gets this entry's file.

        This method is only useful for entries created from a File or Path but not for entries read from an archive.

        Returns:
        this entry's file or null if the entry was not created from a file.
        Since:
        1.21

      • getRealSize

        public long getRealSize()
        Gets this entry's real file size in case of a sparse file.

        This is the size a file would take on disk if the entry was expanded.

        If the file is not a sparse file, return size instead of realSize.

        Returns:
        This entry's real file size, if the file is not a sparse file, return size instead of realSize.

      • getSize

        public long getSize()
        Gets this entry's file size.

        This is the size the entry's data uses inside the archive. Usually this is the same as getRealSize(), but it doesn't take the "holes" into account when the entry represents a sparse file.

        Specified by:
        getSize in interface ArchiveEntry
        Returns:
        This entry's file size.

      • getSparseHeaders

        public java.util.List<TarArchiveStructSparse> getSparseHeaders()
        Gets this entry's sparse headers
        Returns:
        This entry's sparse headers
        Since:
        1.20

      • getStatusChangeTime

        public java.nio.file.attribute.FileTime getStatusChangeTime()
        Gets this entry's status change time.
        Returns:
        This entry's status change time.
        Since:
        1.22

      • getUserName

        public java.lang.String getUserName()
        Gets this entry's user name.
        Returns:
        This entry's user name.

      • hashCode

        public int hashCode()
        Hash codes are based on entry names.
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        the entry hash code

      • isBlockDevice

        public boolean isBlockDevice()
        Tests whether this is a block device entry.
        Returns:
        whether this is a block device
        Since:
        1.2

      • isCharacterDevice

        public boolean isCharacterDevice()
        Tests whether this is a character device entry.
        Returns:
        whether this is a character device
        Since:
        1.2

      • isCheckSumOK

        public boolean isCheckSumOK()
        Tests whether this entry's checksum status.
        Returns:
        if the header checksum is reasonably correct
        Since:
        1.5
        See Also:
        TarUtils.verifyCheckSum(byte[])

      • isDescendent

        public boolean isDescendent​(TarArchiveEntry desc)
        Tests whether the given entry is a descendant of this entry. Descendancy is determined by the name of the descendant starting with this entry's name.
        Parameters:
        desc - Entry to be checked as a descendent of this.
        Returns:
        True if entry is a descendant of this.

      • isDirectory

        public boolean isDirectory()
        Tests whether or not this entry represents a directory.
        Specified by:
        isDirectory in interface ArchiveEntry
        Returns:
        True if this entry is a directory.

      • isExtended

        public boolean isExtended()
        Tests whether in case of an oldgnu sparse file if an extension sparse header follows.
        Returns:
        true if an extension oldgnu sparse header follows.

      • isFIFO

        public boolean isFIFO()
        Tests whether this is a FIFO (pipe) entry.
        Returns:
        whether this is a FIFO entry
        Since:
        1.2

      • isFile

        public boolean isFile()
        Tests whether this is a "normal file"
        Returns:
        whether this is a "normal file"
        Since:
        1.2

      • isGlobalPaxHeader

        public boolean isGlobalPaxHeader()
        Tests whether this is a Pax header.
        Returns:
        true if this is a Pax header.
        Since:
        1.1

      • isGNULongLinkEntry

        public boolean isGNULongLinkEntry()
        Tests whether this entry is a GNU long linkname block
        Returns:
        true if this is a long name extension provided by GNU tar

      • isGNULongNameEntry

        public boolean isGNULongNameEntry()
        Tests whether this entry is a GNU long name block
        Returns:
        true if this is a long name extension provided by GNU tar

      • isGNUSparse

        public boolean isGNUSparse()
        Tests whether this entry is a GNU sparse block.
        Returns:
        true if this is a sparse extension provided by GNU tar

      • isInvalidPrefix

        private boolean isInvalidPrefix​(byte[] header)

      • isInvalidXtarTime

        private boolean isInvalidXtarTime​(byte[] buffer,
                                  int offset,
                                  int length)

      • isLink

        public boolean isLink()
        Tests whether this is a link entry.
        Returns:
        whether this is a link entry
        Since:
        1.2

      • isOldGNUSparse

        public boolean isOldGNUSparse()
        Tests whether this entry is a GNU or star sparse block using the oldgnu format.
        Returns:
        true if this is a sparse extension provided by GNU tar or star
        Since:
        1.11

      • isPaxGNU1XSparse

        public boolean isPaxGNU1XSparse()
        Tests whether this entry is a sparse file with 1.X PAX Format or not
        Returns:
        True if this entry is a sparse file with 1.X PAX Format
        Since:
        1.20

      • isPaxGNUSparse

        public boolean isPaxGNUSparse()
        Tests whether this entry is a GNU sparse block using one of the PAX formats.
        Returns:
        true if this is a sparse extension provided by GNU tar
        Since:
        1.11

      • isPaxHeader

        public boolean isPaxHeader()
        Tests whether this is a Pax header.
        Returns:
        true if this is a Pax header.
        Since:
        1.1

      • isSparse

        public boolean isSparse()
        Tests whether this is a sparse entry.
        Returns:
        whether this is a sparse entry
        Since:
        1.11

      • isStarSparse

        public boolean isStarSparse()
        Tests whether this entry is a star sparse block using PAX headers.
        Returns:
        true if this is a sparse extension provided by star
        Since:
        1.11

      • isStreamContiguous

        public boolean isStreamContiguous()
        Tests whether the stream is contiguous, that is, not split among several archive parts, interspersed with control blocks, and so on.
        Specified by:
        isStreamContiguous in interface EntryStreamOffsets
        Returns:
        true if stream is contiguous, false otherwise.
        Since:
        1.21

      • isSymbolicLink

        public boolean isSymbolicLink()
        Tests whether this is a symbolic link entry.
        Returns:
        whether this is a symbolic link
        Since:
        1.2

      • isXstar

        private boolean isXstar​(java.util.Map<java.lang.String,​java.lang.String> globalPaxHeaders,
                        byte[] header)
        Tests whether the given header is in XSTAR / XUSTAR format. Use the same logic found in star version 1.6 in header.c, function isxmagic(TCB *ptb).

      • parseOctalOrBinary

        private long parseOctalOrBinary​(byte[] header,
                                int offset,
                                int length,
                                boolean lenient)

      • parseTarHeader

        public void parseTarHeader​(byte[] header)
        Parses an entry's header information from a header buffer.
        Parameters:
        header - The tar entry header buffer to get information from.
        Throws:
        java.lang.IllegalArgumentException - if any of the numeric fields have an invalid format

      • parseTarHeader

        public void parseTarHeader​(byte[] header,
                           java.nio.charset.Charset encoding)
                    throws java.io.IOException
        Parse an entry's header information from a header buffer.
        Parameters:
        header - The tar entry header buffer to get information from.
        encoding - encoding to use for file names
        Throws:
        java.lang.IllegalArgumentException - if any of the numeric fields have an invalid format
        java.io.IOException - on error
        Since:
        1.27.1-0

      • parseTarHeader

        private void parseTarHeader​(byte[] header,
                            java.nio.charset.Charset encoding,
                            boolean oldStyle,
                            boolean lenient)
                     throws java.io.IOException
        Throws:
        java.io.IOException

      • parseTarHeader

        private void parseTarHeader​(java.util.Map<java.lang.String,​java.lang.String> globalPaxHeaders,
                            byte[] header,
                            java.nio.charset.Charset encoding,
                            boolean oldStyle,
                            boolean lenient)
                     throws java.io.IOException
        Throws:
        java.io.IOException

      • parseTarHeaderUnwrapped

        private void parseTarHeaderUnwrapped​(java.util.Map<java.lang.String,​java.lang.String> globalPaxHeaders,
                                     byte[] header,
                                     java.nio.charset.Charset encoding,
                                     boolean oldStyle,
                                     boolean lenient)
                              throws java.io.IOException
        Throws:
        java.io.IOException

      • processPaxHeader

        private void processPaxHeader​(java.lang.String key,
                              java.lang.String val)
                       throws java.io.IOException
        Processes one pax header, using the entries extraPaxHeaders map as source for extra headers used when handling entries for sparse files.
        Parameters:
        key -
        val -
        Throws:
        java.io.IOException
        Since:
        1.15

      • processPaxHeader

        private void processPaxHeader​(java.lang.String key,
                              java.lang.String val,
                              java.util.Map<java.lang.String,​java.lang.String> headers)
                       throws java.io.IOException
        Processes one pax header, using the supplied map as source for extra headers to be used when handling entries for sparse files
        Parameters:
        key - the header name.
        val - the header value.
        headers - map of headers used for dealing with sparse file.
        Throws:
        java.lang.NumberFormatException - if encountered errors when parsing the numbers
        java.io.IOException
        Since:
        1.15

      • readFileMode

        private void readFileMode​(java.nio.file.Path file,
                          java.lang.String normalizedName,
                          java.nio.file.LinkOption... options)
                   throws java.io.IOException
        Throws:
        java.io.IOException

      • readOsSpecificProperties

        private void readOsSpecificProperties​(java.nio.file.Path file,
                                      java.nio.file.LinkOption... options)
                               throws java.io.IOException
        Throws:
        java.io.IOException

      • setCreationTime

        public void setCreationTime​(java.nio.file.attribute.FileTime time)
        Sets this entry's creation time.
        Parameters:
        time - This entry's new creation time.
        Since:
        1.22

      • setDataOffset

        public void setDataOffset​(long dataOffset)
        Sets the offset of the data for the tar entry.
        Parameters:
        dataOffset - the position of the data in the tar.
        Since:
        1.21

      • setDevMajor

        public void setDevMajor​(int devNo)
        Sets this entry's major device number.
        Parameters:
        devNo - This entry's major device number.
        Throws:
        java.lang.IllegalArgumentException - if the devNo is < 0.
        Since:
        1.4

      • setDevMinor

        public void setDevMinor​(int devNo)
        Sets this entry's minor device number.
        Parameters:
        devNo - This entry's minor device number.
        Throws:
        java.lang.IllegalArgumentException - if the devNo is < 0.
        Since:
        1.4

      • setGroupId

        public void setGroupId​(int groupId)
        Sets this entry's group id.
        Parameters:
        groupId - This entry's new group id.

      • setGroupId

        public void setGroupId​(long groupId)
        Sets this entry's group id.
        Parameters:
        groupId - This entry's new group id.
        Since:
        1.10

      • setGroupName

        public void setGroupName​(java.lang.String groupName)
        Sets this entry's group name.
        Parameters:
        groupName - This entry's new group name.

      • setIds

        public void setIds​(int userId,
                   int groupId)
        Convenience method to set this entry's group and user ids.
        Parameters:
        userId - This entry's new user id.
        groupId - This entry's new group id.

      • setLastAccessTime

        public void setLastAccessTime​(java.nio.file.attribute.FileTime time)
        Sets this entry's last access time.
        Parameters:
        time - This entry's new last access time.
        Since:
        1.22

      • setLastModifiedTime

        public void setLastModifiedTime​(java.nio.file.attribute.FileTime time)
        Sets this entry's modification time.
        Parameters:
        time - This entry's new modification time.
        Since:
        1.22

      • setLinkName

        public void setLinkName​(java.lang.String link)
        Sets this entry's link name.
        Parameters:
        link - the link name to use.
        Since:
        1.1

      • setMode

        public void setMode​(int mode)
        Sets the mode for this entry
        Parameters:
        mode - the mode for this entry

      • setModTime

        public void setModTime​(java.nio.file.attribute.FileTime time)
        Sets this entry's modification time.
        Parameters:
        time - This entry's new modification time.
        Since:
        1.21
        See Also:
        setLastModifiedTime(FileTime)

      • setModTime

        public void setModTime​(long time)
        Sets this entry's modification time. The parameter passed to this method is in "Java time".
        Parameters:
        time - This entry's new modification time.
        See Also:
        setLastModifiedTime(FileTime)

      • setName

        public void setName​(java.lang.String name)
        Sets this entry's name.
        Parameters:
        name - This entry's new name.

      • setNames

        public void setNames​(java.lang.String userName,
                     java.lang.String groupName)
        Convenience method to set this entry's group and user names.
        Parameters:
        userName - This entry's new user name.
        groupName - This entry's new group name.

      • setSize

        public void setSize​(long size)
        Sets this entry's file size.
        Parameters:
        size - This entry's new file size.
        Throws:
        java.lang.IllegalArgumentException - if the size is < 0.

      • setSparseHeaders

        public void setSparseHeaders​(java.util.List<TarArchiveStructSparse> sparseHeaders)
        Sets this entry's sparse headers
        Parameters:
        sparseHeaders - The new sparse headers
        Since:
        1.20

      • setStatusChangeTime

        public void setStatusChangeTime​(java.nio.file.attribute.FileTime time)
        Sets this entry's status change time.
        Parameters:
        time - This entry's new status change time.
        Since:
        1.22

      • setUserId

        public void setUserId​(int userId)
        Sets this entry's user id.
        Parameters:
        userId - This entry's new user id.

      • setUserId

        public void setUserId​(long userId)
        Sets this entry's user id.
        Parameters:
        userId - This entry's new user id.
        Since:
        1.10

      • setUserName

        public void setUserName​(java.lang.String userName)
        Sets this entry's user name.
        Parameters:
        userName - This entry's new user name.

      • updateEntryFromPaxHeaders

        void updateEntryFromPaxHeaders​(java.util.Map<java.lang.String,​java.lang.String> headers)
                        throws java.io.IOException
        Update the entry using a map of pax headers.
        Parameters:
        headers -
        Throws:
        java.io.IOException
        Since:
        1.15

      • writeEntryHeader

        public void writeEntryHeader​(byte[] outbuf)
        Writes an entry's header information to a header buffer.

        This method does not use the star/GNU tar/BSD tar extensions.

        Parameters:
        outbuf - The tar entry header buffer to fill in.

      • writeEntryHeader

        public void writeEntryHeader​(byte[] outbuf,
                             java.nio.charset.Charset encoding,
                             boolean starMode)
                      throws java.io.IOException
        Writes an entry's header information to a header buffer.
        Parameters:
        outbuf - The tar entry header buffer to fill in.
        encoding - encoding to use when writing the file name.
        starMode - whether to use the star/GNU tar/BSD tar extension for numeric fields if their value doesn't fit in the maximum size of standard tar archives
        Throws:
        java.io.IOException - on error
        Since:
        1.27.1-0

      • writeEntryHeaderField

        private int writeEntryHeaderField​(long value,
                                  byte[] outbuf,
                                  int offset,
                                  int length,
                                  boolean starMode)

      • writeEntryHeaderOptionalTimeField

        private int writeEntryHeaderOptionalTimeField​(java.nio.file.attribute.FileTime time,
                                              int offset,
                                              byte[] outbuf,
                                              int fieldLength)