nonapi.io.github.classgraph.fastzipfilereader

Class NestedJarHandler

java.lang.Object

nonapi.io.github.classgraph.fastzipfilereader.NestedJarHandler

public class NestedJarHandler
extends java.lang.Object

Open and read jarfiles, which may be nested within other jarfiles.

Field Summary

Fields

Modifier and Type	Field and Description
InterruptionChecker	interruptionChecker The interruption checker.
SingletonMap<ModuleRef,Recycler<ModuleReaderProxy,java.io.IOException>,java.io.IOException>	moduleRefToModuleReaderProxyRecyclerMap A singleton map from a ModuleRef to a ModuleReaderProxy recycler for the module.
SingletonMap<java.lang.String,java.util.Map.Entry<LogicalZipFile,java.lang.String>,java.io.IOException>	nestedPathToLogicalZipFileAndPackageRootMap A singleton map from nested jarfile path to a tuple of the logical zipfile for the path, and the package root within the logical zipfile.
ScanSpec	scanSpec The ScanSpec.
static java.lang.String	TEMP_FILENAME_LEAF_SEPARATOR The separator between random temp filename part and leafname.

Constructor Summary

Constructors

Constructor and Description
NestedJarHandler(ScanSpec scanSpec, InterruptionChecker interruptionChecker) A handler for nested jars.

Method Summary

Modifier and Type	Method and Description
void	close(LogNode log) Close zipfiles, modules, and recyclers, and delete temporary files.
java.io.File	makeTempFile(java.lang.String filePathBase, boolean onlyUseLeafname) Create a temporary file, and mark it for deletion on exit.
void	markSliceAsClosed(Slice slice) Mark a Slice as closed.
void	markSliceAsOpen(Slice slice) Mark a Slice as open, so it can be closed when the ScanResult is closed.
java.io.InputStream	openInflaterInputStream(java.io.InputStream rawInputStream) Wrap an InputStream with an InflaterInputStream, recycling the Inflater instance.
static byte[]	readAllBytesAsArray(java.io.InputStream inputStream, long uncompressedLengthHint) Read all the bytes in an InputStream.
Slice	readAllBytesWithSpilloverToDisk(java.io.InputStream inputStream, java.lang.String tempFileBaseName, long inputStreamLengthHint, LogNode log) Read all the bytes in an InputStream, with spillover to a temporary file on disk if a maximum buffer size is exceeded.

Methods inherited from class java.lang.Object

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

Field Detail

scanSpec

public final ScanSpec scanSpec

The ScanSpec.

nestedPathToLogicalZipFileAndPackageRootMap

public SingletonMap<java.lang.String,java.util.Map.Entry<LogicalZipFile,java.lang.String>,java.io.IOException> nestedPathToLogicalZipFileAndPackageRootMap

A singleton map from nested jarfile path to a tuple of the logical zipfile for the path, and the package root within the logical zipfile.

moduleRefToModuleReaderProxyRecyclerMap

public SingletonMap<ModuleRef,Recycler<ModuleReaderProxy,java.io.IOException>,java.io.IOException> moduleRefToModuleReaderProxyRecyclerMap

A singleton map from a ModuleRef to a ModuleReaderProxy recycler for the module.

TEMP_FILENAME_LEAF_SEPARATOR

public static final java.lang.String TEMP_FILENAME_LEAF_SEPARATOR

The separator between random temp filename part and leafname.

See Also:

Constant Field Values

interruptionChecker

public InterruptionChecker interruptionChecker

The interruption checker.

Constructor Detail

NestedJarHandler

public NestedJarHandler(ScanSpec scanSpec,
                        InterruptionChecker interruptionChecker)

A handler for nested jars.

Parameters:

scanSpec - The ScanSpec.

interruptionChecker - the interruption checker

Method Detail

makeTempFile

public java.io.File makeTempFile(java.lang.String filePathBase,
                                 boolean onlyUseLeafname)
                          throws java.io.IOException

Create a temporary file, and mark it for deletion on exit.

Parameters:

filePathBase - The path to derive the temporary filename from.

onlyUseLeafname - If true, only use the leafname of filePath to derive the temporary filename.

Returns:

The temporary File.

Throws:

java.io.IOException - If the temporary file could not be created.

markSliceAsOpen

public void markSliceAsOpen(Slice slice)
                     throws java.io.IOException

Mark a Slice as open, so it can be closed when the ScanResult is closed.

Parameters:

slice - the Slice that was just opened.

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

markSliceAsClosed

public void markSliceAsClosed(Slice slice)

Mark a Slice as closed.

Parameters:

slice - the Slice to close.

openInflaterInputStream

public java.io.InputStream openInflaterInputStream(java.io.InputStream rawInputStream)
                                            throws java.io.IOException

Wrap an InputStream with an InflaterInputStream, recycling the Inflater instance.

Parameters:

rawInputStream - the raw input stream

Returns:

the inflater input stream

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

readAllBytesWithSpilloverToDisk

public Slice readAllBytesWithSpilloverToDisk(java.io.InputStream inputStream,
                                             java.lang.String tempFileBaseName,
                                             long inputStreamLengthHint,
                                             LogNode log)
                                      throws java.io.IOException

Read all the bytes in an InputStream, with spillover to a temporary file on disk if a maximum buffer size is exceeded.

Parameters:

inputStream - the InputStream to read from.

tempFileBaseName - the source URL or zip entry that inputStream was opened from (used to name temporary file, if needed).

inputStreamLengthHint - the length of inputStream if known, else -1L.

log - the log.

Returns:

if the InputStream could be read into a byte array, an ArraySlice will be returned. If this fails and the InputStream is spilled over to disk, a FileSlice will be returned.

Throws:

java.io.IOException - If the contents could not be read.

readAllBytesAsArray

public static byte[] readAllBytesAsArray(java.io.InputStream inputStream,
                                         long uncompressedLengthHint)
                                  throws java.io.IOException

Read all the bytes in an InputStream.

Parameters:

inputStream - The InputStream.

uncompressedLengthHint - The length of the data once inflated from the InputStream, if known, otherwise -1L.

Returns:

The contents of the InputStream as a byte array.

Throws:

java.io.IOException - If the contents could not be read.

close

public void close(LogNode log)

Close zipfiles, modules, and recyclers, and delete temporary files. Called by ScanResult.close().

Parameters:

log - The log.