Class Archive

java.lang.Object

com.github.junrar.Archive

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<FileHeader>

public class Archive
extends Object
implements Closeable, Iterable<FileHeader>

The Main Rar Class; represents a rar Archive

Version:

$LastChangedRevision$

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	Archive.EmptyInputStream	An empty InputStream.
private static final class	Archive.ExtractorExecutorHolder	Class to ensure the lazy initialization of the ThreadPoolExecutor upon first usage.

Field Summary

Fields

Modifier and Type	Field	Description
private SeekableReadOnlyByteChannel	channel
private int	currentHeaderIndex
private final ComprDataIO	dataIO
private final List<BaseBlock>	headers
private static final org.slf4j.Logger	logger
private MarkHeader	markHead
private static final int	MAX_HEADER_SIZE
private MainHeader	newMhd
private FileHeader	nextFileHeader
private String	password
private static final int	PIPE_BUFFER_SIZE
private long	totalPackedRead	Number of bytes of compressed data read from current file.
private long	totalPackedSize	Size of packed data in current file.
private Unpack	unpack
private final UnrarCallback	unrarCallback
private static final boolean	USE_EXECUTOR
private Volume	volume
private VolumeManager	volumeManager

Constructor Summary

Constructors

Constructor	Description
Archive(VolumeManager volumeManager, UnrarCallback unrarCallback, String password)
Archive(File firstVolume)
Archive(File firstVolume, UnrarCallback unrarCallback)
Archive(File firstVolume, UnrarCallback unrarCallback, String password)
Archive(File firstVolume, String password)
Archive(InputStream rarAsStream)
Archive(InputStream rarAsStream, UnrarCallback unrarCallback)
Archive(InputStream rarAsStream, UnrarCallback unrarCallback, String password)
Archive(InputStream rarAsStream, String password)

Method Summary

Modifier and Type	Method	Description
void	bytesReadRead(int count)
void	close()	Close the underlying compressed file.
private void	doExtractFile(FileHeader hd, OutputStream os)
void	extractFile(FileHeader hd, OutputStream os)	Extract the file specified by the given header and write it to the supplied output stream
SeekableReadOnlyByteChannel	getChannel()
List<FileHeader>	getFileHeaders()
List<BaseBlock>	getHeaders()	Gets all of the headers in the archive.
InputStream	getInputStream(FileHeader hd)	Returns an InputStream that will allow to read the file and stream it.
MainHeader	getMainHeader()
String	getPassword()
private static <T> T	getPropertyAs(String key, Function<String,T> function, T defaultValue)
UnrarCallback	getUnrarCallback()
Volume	getVolume()
VolumeManager	getVolumeManager()
boolean	isEncrypted()
boolean	isOldFormat()
boolean	isPasswordProtected()
Iterator<FileHeader>	iterator()
FileHeader	nextFileHeader()
private void	readHeaders(long fileLength)	Read the headers of the archive
private static byte[]	safelyAllocate(long len, int maxSize)
private void	setChannel(SeekableReadOnlyByteChannel channel, long length)
void	setPassword(String password)
void	setVolume(Volume volume)
void	setVolumeManager(VolumeManager volumeManager)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Iterable

forEach, spliterator

Field Details

logger

private static final org.slf4j.Logger logger

MAX_HEADER_SIZE

private static final int MAX_HEADER_SIZE

See Also:

• Constant Field Values

PIPE_BUFFER_SIZE

private static final int PIPE_BUFFER_SIZE

USE_EXECUTOR

private static final boolean USE_EXECUTOR

channel

private SeekableReadOnlyByteChannel channel

unrarCallback

private final UnrarCallback unrarCallback

dataIO

private final ComprDataIO dataIO

headers

private final List<BaseBlock> headers

markHead

private MarkHeader markHead

newMhd

private MainHeader newMhd

unpack

private Unpack unpack

currentHeaderIndex

private int currentHeaderIndex

totalPackedSize

private long totalPackedSize

Size of packed data in current file.

totalPackedRead

private long totalPackedRead

Number of bytes of compressed data read from current file.

volumeManager

private VolumeManager volumeManager

volume

private Volume volume

nextFileHeader

private FileHeader nextFileHeader

password

private String password

Constructor Details

Archive

public Archive(VolumeManager volumeManager,
 UnrarCallback unrarCallback,
 String password)
        throws RarException,
IOException

Throws:

RarException

IOException

Archive

public Archive(File firstVolume)
        throws RarException,
IOException

Throws:

RarException

IOException

Archive

public Archive(File firstVolume,
 UnrarCallback unrarCallback)
        throws RarException,
IOException

Throws:

RarException

IOException

Archive

public Archive(File firstVolume,
 String password)
        throws RarException,
IOException

Throws:

RarException

IOException

Archive

public Archive(File firstVolume,
 UnrarCallback unrarCallback,
 String password)
        throws RarException,
IOException

Throws:

RarException

IOException

Archive

public Archive(InputStream rarAsStream)
        throws RarException,
IOException

Throws:

RarException

IOException

Archive

public Archive(InputStream rarAsStream,
 UnrarCallback unrarCallback)
        throws RarException,
IOException

Throws:

RarException

IOException

Archive

public Archive(InputStream rarAsStream,
 String password)
        throws IOException,
RarException

Throws:

IOException

RarException

Archive

public Archive(InputStream rarAsStream,
 UnrarCallback unrarCallback,
 String password)
        throws IOException,
RarException

Throws:

IOException

RarException

Method Details

setChannel

private void setChannel(SeekableReadOnlyByteChannel channel,
 long length)
                 throws IOException,
RarException

Throws:

IOException

RarException

bytesReadRead

public void bytesReadRead(int count)

getChannel

public SeekableReadOnlyByteChannel getChannel()

getHeaders

public List<BaseBlock> getHeaders()

Gets all of the headers in the archive.

Returns:

returns the headers.

getFileHeaders

public List<FileHeader> getFileHeaders()

Returns:

returns all file headers of the archive

nextFileHeader

public FileHeader nextFileHeader()

getUnrarCallback

public UnrarCallback getUnrarCallback()

isEncrypted

public boolean isEncrypted()
                    throws RarException

Returns:

whether the archive is encrypted

Throws:

RarException - when the main header is not present

isPasswordProtected

public boolean isPasswordProtected()
                            throws RarException

Returns:

whether the archive content is password protected

Throws:

RarException - when the main header is not present

readHeaders

private void readHeaders(long fileLength)
                  throws IOException,
RarException

Read the headers of the archive

Parameters:

fileLength - Length of file.

Throws:

IOException

RarException

safelyAllocate

private static byte[] safelyAllocate(long len,
 int maxSize)
                              throws RarException

Throws:

RarException

extractFile

public void extractFile(FileHeader hd,
 OutputStream os)
                 throws RarException

Extract the file specified by the given header and write it to the supplied output stream

Parameters:

hd - the header to be extracted

os - the outputstream

Throws:

RarException - .

getPropertyAs

private static <T> T getPropertyAs(String key,
 Function<String,T> function,
 T defaultValue)

getInputStream

public InputStream getInputStream(FileHeader hd)
                           throws IOException

Returns an InputStream that will allow to read the file and stream it.
Please note that this method will create a pair of Pipe streams and either:

• delegate the work to a ThreadPoolExecutor, via Archive.ExtractorExecutorHolder; or
• delegate the work to a newly created thread on each call

You can choose which strategy to use by setting the junrar.extractor.use-executor system property.
Defaults to using the ThreadPoolExecutor.

Parameters:

hd - the header to be extracted

Returns:

an InputStream from which you can read the uncompressed bytes

Throws:

IOException - if any I/O error occur

See Also:

• Archive.ExtractorExecutorHolder

doExtractFile

private void doExtractFile(FileHeader hd,
 OutputStream os)
                    throws RarException,
IOException

Throws:

RarException

IOException

getMainHeader

public MainHeader getMainHeader()

Returns:

returns the main header of this archive

isOldFormat

public boolean isOldFormat()

Returns:

whether the archive is old format

close

public void close()
           throws IOException

Close the underlying compressed file.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

getVolumeManager

public VolumeManager getVolumeManager()

Returns:

the volumeManager

setVolumeManager

public void setVolumeManager(VolumeManager volumeManager)

Parameters:

volumeManager - the volumeManager to set

getVolume

public Volume getVolume()

Returns:

the volume

getPassword

public String getPassword()

setPassword

public void setPassword(String password)

setVolume

public void setVolume(Volume volume)
               throws IOException,
RarException

Parameters:

volume - the volume to set

Throws:

IOException - .

RarException - .

iterator

public Iterator<FileHeader> iterator()

Specified by:

iterator in interface Iterable<FileHeader>