org.whitesource.agent.archive

Class ArchiveExtractor

java.lang.Object

org.whitesource.agent.archive.ArchiveExtractor

public class ArchiveExtractor
extends Object

Author:

anna.rozin

Field Summary

Fields

Modifier and Type	Field and Description
static String	BZ_SUFFIX
static String	CPIO
static String	DEPTH
static String	DEPTH_REGEX
static String	GEM_EXTENSION_PATTERN
static List<String>	GEM_EXTENSIONS
static String	GLOB_PATTERN_PREFIX
static String	GLOB_PREFIX
static String	GZ_SUFFIX
static String	LAYER_TAR
static int	LONG_BOUND
static String	LZMA
static String	NULL_HEADER
static String	PATTERN_PREFIX
static String	RAR_EXTENSION_PATTERN
static List<String>	RAR_EXTENSIONS
static String	RPM_EXTENSION_PATTERN
static List<String>	RPM_EXTENSIONS
static String	RUBY_DATA_FILE
static String	TAR_BZ2_SUFFIX
static String	TAR_EXTENSION_PATTERN
static List<String>	TAR_EXTENSIONS
static String	TAR_GZ_SUFFIX
static String	TAR_SUFFIX
static String	TGZ_SUFFIX
static String	UN_ARCHIVER_LOGGER
static String	XZ_SUFFIX
static String	XZ_UN_ARCHIVER_FILE_NAME
static String	ZIP_EXTENSION_PATTERN
static List<String>	ZIP_EXTENSIONS

Constructor Summary

Constructors

Constructor and Description
ArchiveExtractor(String[] archiveIncludes, String[] archiveExcludes, String[] filesExcludes)
ArchiveExtractor(String[] archiveIncludes, String[] archiveExcludes, String[] filesExcludes, boolean fastUnpack)

Method Summary

Modifier and Type	Method and Description
String	extractArchives(String scannerBaseDir, int archiveExtractionDepth, List<String> archiveDirectories) The Method extracts all the Archive files according to the archiveExtractionDepth.
void	extractDockerImageLayers(File imageTarFile, File imageExtractionDir)
Map<String,String>	processCollections(Collection<Pair> unitsOfWork)
boolean	unXz(File srcFileToArchive, String destFilePath)

Methods inherited from class java.lang.Object

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

Field Detail

LAYER_TAR

public static final String LAYER_TAR

See Also:

Constant Field Values

LONG_BOUND

public static final int LONG_BOUND

See Also:

Constant Field Values

DEPTH

public static final String DEPTH

See Also:

Constant Field Values

DEPTH_REGEX

public static final String DEPTH_REGEX

See Also:

Constant Field Values

GLOB_PREFIX

public static final String GLOB_PREFIX

See Also:

Constant Field Values

NULL_HEADER

public static final String NULL_HEADER

See Also:

Constant Field Values

ZIP_EXTENSIONS

public static final List<String> ZIP_EXTENSIONS

GEM_EXTENSIONS

public static final List<String> GEM_EXTENSIONS

TAR_EXTENSIONS

public static final List<String> TAR_EXTENSIONS

RPM_EXTENSIONS

public static final List<String> RPM_EXTENSIONS

RAR_EXTENSIONS

public static final List<String> RAR_EXTENSIONS

ZIP_EXTENSION_PATTERN

public static final String ZIP_EXTENSION_PATTERN

GEM_EXTENSION_PATTERN

public static final String GEM_EXTENSION_PATTERN

TAR_EXTENSION_PATTERN

public static final String TAR_EXTENSION_PATTERN

RPM_EXTENSION_PATTERN

public static final String RPM_EXTENSION_PATTERN

RAR_EXTENSION_PATTERN

public static final String RAR_EXTENSION_PATTERN

RUBY_DATA_FILE

public static final String RUBY_DATA_FILE

See Also:

Constant Field Values

TAR_SUFFIX

public static final String TAR_SUFFIX

See Also:

Constant Field Values

GZ_SUFFIX

public static final String GZ_SUFFIX

See Also:

Constant Field Values

BZ_SUFFIX

public static final String BZ_SUFFIX

See Also:

Constant Field Values

XZ_SUFFIX

public static final String XZ_SUFFIX

See Also:

Constant Field Values

LZMA

public static final String LZMA

See Also:

Constant Field Values

CPIO

public static final String CPIO

See Also:

Constant Field Values

TGZ_SUFFIX

public static final String TGZ_SUFFIX

See Also:

Constant Field Values

TAR_GZ_SUFFIX

public static final String TAR_GZ_SUFFIX

See Also:

Constant Field Values

TAR_BZ2_SUFFIX

public static final String TAR_BZ2_SUFFIX

See Also:

Constant Field Values

UN_ARCHIVER_LOGGER

public static final String UN_ARCHIVER_LOGGER

See Also:

Constant Field Values

GLOB_PATTERN_PREFIX

public static final String GLOB_PATTERN_PREFIX

See Also:

Constant Field Values

PATTERN_PREFIX

public static final String PATTERN_PREFIX

See Also:

Constant Field Values

XZ_UN_ARCHIVER_FILE_NAME

public static final String XZ_UN_ARCHIVER_FILE_NAME

See Also:

Constant Field Values

Constructor Detail

ArchiveExtractor

public ArchiveExtractor(String[] archiveIncludes,
                        String[] archiveExcludes,
                        String[] filesExcludes,
                        boolean fastUnpack)

ArchiveExtractor

public ArchiveExtractor(String[] archiveIncludes,
                        String[] archiveExcludes,
                        String[] filesExcludes)

Method Detail

extractArchives

public String extractArchives(String scannerBaseDir,
                              int archiveExtractionDepth,
                              List<String> archiveDirectories)

The Method extracts all the Archive files according to the archiveExtractionDepth. archiveExtractionDepth defined by the user in the configuration file.

The archiveExtractionDepth default value is 0 - no archive scanning, the max value is 3. By default the method scans jar/war/ear. If archiveIncludes/archiveExcludes params are defined the method will act accordingly.

Parameters:

scannerBaseDir - - directory for scanning.

archiveExtractionDepth - - drill down hierarchy level in archive files

archiveDirectories - list of directories

Returns:

the temp directory for the extracted files.

extractDockerImageLayers

public void extractDockerImageLayers(File imageTarFile,
                                     File imageExtractionDir)

processCollections

public Map<String,String> processCollections(Collection<Pair> unitsOfWork)

unXz

public boolean unXz(File srcFileToArchive,
                    String destFilePath)