Class DumpArchiveInputStream
java.lang.Object
java.io.InputStream
org.apache.commons.compress.archivers.ArchiveInputStream
org.apache.commons.compress.archivers.dump.DumpArchiveInputStream
- All Implemented Interfaces:
Closeable
,AutoCloseable
The DumpArchiveInputStream reads a UNIX dump archive as an InputStream.
Methods are provided to position at each successive entry in
the archive, and the read each entry as a normal input stream
using read().
There doesn't seem to exist a hint on the encoding of string values
in any piece documentation. Given the main purpose of dump/restore
is backing up a system it seems very likely the format uses the
current default encoding of the system.
- This class is not thread-safe
-
Field Summary
Modifier and TypeFieldDescriptionprotected org.apache.commons.compress.archivers.dump.TapeInputStream
-
Constructor Summary
ConstructorDescriptionConstructor using the platform's default encoding for file names.DumpArchiveInputStream
(InputStream is, String encoding) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Closes the stream for this entry.long
Returns the current number of bytes read from this stream.int
getCount()
Deprecated.Read the next entry.Returns the next Archive Entry in this Stream.Return the archive summary information.static boolean
matches
(byte[] buffer, int length) Look at the first few bytes of the file to decide if it's a dump archive.int
read
(byte[] buf, int off, int len) Reads bytes from the current dump archive entry.Methods inherited from class org.apache.commons.compress.archivers.ArchiveInputStream
canReadEntryData, count, count, pushedBackBytes, read
Methods inherited from class java.io.InputStream
available, mark, markSupported, read, reset, skip
-
Field Details
-
raw
-
-
Constructor Details
-
DumpArchiveInputStream
Constructor using the platform's default encoding for file names.- Parameters:
is
- stream to read from- Throws:
ArchiveException
- on error
-
DumpArchiveInputStream
Constructor.- Parameters:
is
- stream to read fromencoding
- the encoding to use for file names, use null for the platform's default encoding- Throws:
ArchiveException
- on error- Since:
- 1.6
-
-
Method Details
-
matches
Look at the first few bytes of the file to decide if it's a dump archive. With 32 bytes we can look at the magic value, with a full 1k we can verify the checksum.- Parameters:
buffer
- data to matchlength
- length of data- Returns:
- whether the buffer seems to contain dump data
-
close
Closes the stream for this entry.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Overrides:
close
in classInputStream
- Throws:
IOException
-
getBytesRead
Description copied from class:ArchiveInputStream
Returns the current number of bytes read from this stream.- Overrides:
getBytesRead
in classArchiveInputStream
- Returns:
- the number of read bytes
-
getCount
Deprecated.Description copied from class:ArchiveInputStream
Returns the current number of bytes read from this stream.- Overrides:
getCount
in classArchiveInputStream
- Returns:
- the number of read bytes
-
getNextDumpEntry
Read the next entry.- Returns:
- the next entry
- Throws:
IOException
- on error
-
getNextEntry
Description copied from class:ArchiveInputStream
Returns the next Archive Entry in this Stream.- Specified by:
getNextEntry
in classArchiveInputStream
- Returns:
- the next entry,
or
null
if there are no more entries - Throws:
IOException
- if the next entry could not be read
-
getSummary
Return the archive summary information.- Returns:
- the summary
-
read
Reads bytes from the current dump archive entry. This method is aware of the boundaries of the current entry in the archive and will deal with them as if they were this stream's start and EOF.- Overrides:
read
in classInputStream
- Parameters:
buf
- The buffer into which to place bytes read.off
- The offset at which to place bytes read.len
- The number of bytes to read.- Returns:
- The number of bytes read, or -1 at EOF.
- Throws:
IOException
- on error
-