com.xilinx.rapidwright.util

Class Installer

Object

com.xilinx.rapidwright.util.Installer

public class Installer
extends Object

Installer for RapidWright for development setup. Created on: Sep 1, 2017

Field Summary

Fields

Modifier and Type	Field and Description
static String	DATA_ZIP
static String	JARS_ZIP
static boolean	KEEP_ZIP_FILES
static String	MD5_FILE_NAME
static String	RELEASE
static String	REPO
static boolean	SKIP_TEST
static boolean	SKIP_ZIP_DOWNLOAD
static boolean	verbose

Constructor Summary

Constructors

Constructor and Description
Installer()

Method Summary

Modifier and Type	Method and Description
static String	bytesToString(byte[] checksum) Convert bytes of an MD5 checksum into common alpha-numeric String representation.
static String	calculateMD5OfFile(Path path) Performs an MD5 checksum on the provided file and returns the result.
static String	calculateMD5OfFile(String fileName) Performs an MD5 checksum on the provided file and returns the result.
static String	calculateMD5OfStream(InputStream is) Performs an MD5 checksum on the provided input stream and returns the result.
static long	downloadFile(String url, String dstFileName) Downloads a file specified by the URL to the local file dstFileName.
static List<String>	getAllJavaSources(String dir) Gets all Java (.java) source files recursively under the provided directory
static String	getExpectedMD5(String releaseName, String fileName)
static String	getJarsClasspath() Identifies all necessary jar files in /jars directory and creates a CLASSPATH string.
static boolean	isWindows()
static void	main(String[] args)
static Integer	runCommand(List<String> command)
static void	unzipFile(String zipFile, String destDir) Unzips a file into a specified directory
static void	updateJars()
static boolean	validateMD5OfDownloadedFile(String releaseDir, String downloadedFileName) Validates an already downloaded RapidWright release file using the MD5 hash

Methods inherited from class Object

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

Field Detail

verbose

public static boolean verbose

KEEP_ZIP_FILES

public static boolean KEEP_ZIP_FILES

SKIP_ZIP_DOWNLOAD

public static boolean SKIP_ZIP_DOWNLOAD

SKIP_TEST

public static boolean SKIP_TEST

MD5_FILE_NAME

public static String MD5_FILE_NAME

REPO

public static final String REPO

See Also:

Constant Field Values

RELEASE

public static final String RELEASE

See Also:

Constant Field Values

DATA_ZIP

public static final String DATA_ZIP

See Also:

Constant Field Values

JARS_ZIP

public static final String JARS_ZIP

See Also:

Constant Field Values

Constructor Detail

Installer

public Installer()

Method Detail

bytesToString

public static String bytesToString(byte[] checksum)

Convert bytes of an MD5 checksum into common alpha-numeric String representation.

Parameters:

checksum - The digested result from an MD5 instance.

Returns:

The alpha-numeric String representation of the checksum.

calculateMD5OfFile

public static String calculateMD5OfFile(String fileName)

Performs an MD5 checksum on the provided file and returns the result.

Parameters:

fileName - Name of the file on which to perform the checksum

Returns:

Checksum result String or null if no file was found.

calculateMD5OfFile

public static String calculateMD5OfFile(Path path)

Performs an MD5 checksum on the provided file and returns the result.

Parameters:

path - Path of the file on which to perform the checksum

Returns:

Checksum result String or null if no file was found.

calculateMD5OfStream

public static String calculateMD5OfStream(InputStream is)

Performs an MD5 checksum on the provided input stream and returns the result.

validateMD5OfDownloadedFile

public static boolean validateMD5OfDownloadedFile(String releaseDir,
                                                  String downloadedFileName)

Validates an already downloaded RapidWright release file using the MD5 hash

Parameters:

releaseDir - The URL of the release directory

downloadedFileName - The name of the local file

Returns:

True if the file is correct, false otherwise

downloadFile

public static long downloadFile(String url,
                                String dstFileName)

Downloads a file specified by the URL to the local file dstFileName.

Parameters:

url - The target URL to download

dstFileName - The local file name

Returns:

The number of bytes downloaded into the file

unzipFile

public static void unzipFile(String zipFile,
                             String destDir)

Unzips a file into a specified directory

Parameters:

zipFile - Name of the zip file to unzip

destDir - The directory to receive the contents of the zip file

runCommand

public static Integer runCommand(List<String> command)

isWindows

public static boolean isWindows()

getJarsClasspath

public static String getJarsClasspath()

Identifies all necessary jar files in /jars directory and creates a CLASSPATH string.

Returns:

The dependent jar files

getAllJavaSources

public static List<String> getAllJavaSources(String dir)

Gets all Java (.java) source files recursively under the provided directory

Parameters:

dir - The directory to look under for Java source files

Returns:

A list of all Java source files with absolute path names.

getExpectedMD5

public static String getExpectedMD5(String releaseName,
                                    String fileName)

updateJars

public static void updateJars()

main

public static void main(String[] args)
                 throws IOException

Throws:

IOException