org.apache.archiva.checksum

Class ChecksummedFile

java.lang.Object

org.apache.archiva.checksum.ChecksummedFile

public class ChecksummedFile
extends Object

ChecksummedFile

Terminology:

Checksum File

The file that contains the previously calculated checksum value for the reference file. This is a text file with the extension ".sha1" or ".md5", and contains a single entry consisting of an optional reference filename, and a checksum string.

Reference File

The file that is being referenced in the checksum file.

Constructor Summary

Constructors

Constructor and Description
ChecksummedFile(Path referenceFile) Construct a ChecksummedFile object.

Method Summary

Modifier and Type	Method and Description
String	calculateChecksum(ChecksumAlgorithm checksumAlgorithm) Calculate the checksum based on a given checksum.
UpdateStatusList	fixChecksum(ChecksumAlgorithm algorithm)
UpdateStatusList	fixChecksums(List<ChecksumAlgorithm> algorithms) Writes a checksum file, if it does not exist or if it exists and has a different checksum value.
Path	getChecksumFile(ChecksumAlgorithm checksumAlgorithm) Get the checksum file for the reference file and hash.
static ChecksumReference	getFromChecksumFile(Path checksumFile)
Path	getReferenceFile()
boolean	isValidChecksum(ChecksumAlgorithm algorithm) Given a checksum file, check to see if the file it represents is valid according to the checksum.
boolean	isValidChecksum(ChecksumAlgorithm algorithm, boolean throwExceptions)
boolean	isValidChecksums(List<ChecksumAlgorithm> algorithms) Of any checksum files present, validate that the reference file conforms the to the checksum.
boolean	isValidChecksums(List<ChecksumAlgorithm> algorithms, boolean throwExceptions) Checks if the checksum files are valid for the referenced file.
String	parseChecksum(Path checksumFile, ChecksumAlgorithm checksumAlgorithm, String fileName, Charset encoding) Parse a checksum string.
ChecksumFileContent	parseChecksumFile(Path checksumFile, ChecksumAlgorithm checksumAlgorithm, Charset encoding)
Path	writeFile(ChecksumAlgorithm checksumAlgorithm) Writes a checksum file for the referenceFile.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChecksummedFile

public ChecksummedFile(Path referenceFile)

Construct a ChecksummedFile object.

Parameters:

referenceFile -

Method Detail

getFromChecksumFile

public static ChecksumReference getFromChecksumFile(Path checksumFile)

calculateChecksum

public String calculateChecksum(ChecksumAlgorithm checksumAlgorithm)
                         throws IOException

Calculate the checksum based on a given checksum.

Parameters:

checksumAlgorithm - the algorithm to use.

Returns:

the checksum string for the file.

Throws:

IOException - if unable to calculate the checksum.

writeFile

public Path writeFile(ChecksumAlgorithm checksumAlgorithm)
               throws IOException

Writes a checksum file for the referenceFile.

Parameters:

checksumAlgorithm - the hash to use.

Returns:

the checksum File that was created.

Throws:

IOException - if there was a problem either reading the referenceFile, or writing the checksum file.

getChecksumFile

public Path getChecksumFile(ChecksumAlgorithm checksumAlgorithm)

Get the checksum file for the reference file and hash. It returns a file for the given checksum, if one exists with one of the possible extensions. If it does not exist, a default path will be returned.

Parameters:

checksumAlgorithm - the hash that we are interested in.

Returns:

the checksum file to return

isValidChecksum

public boolean isValidChecksum(ChecksumAlgorithm algorithm)
                        throws ChecksumValidationException

Given a checksum file, check to see if the file it represents is valid according to the checksum.

NOTE: Only supports single file checksums of type MD5 or SHA1.

Parameters:

algorithm - the algorithms to check for.

Returns:

true if the checksum is valid for the file it represents. or if the checksum file does not exist.

Throws:

IOException - if the reading of the checksumFile or the file it refers to fails.

ChecksumValidationException

isValidChecksum

public boolean isValidChecksum(ChecksumAlgorithm algorithm,
                               boolean throwExceptions)
                        throws ChecksumValidationException

Throws:

ChecksumValidationException

isValidChecksums

public boolean isValidChecksums(List<ChecksumAlgorithm> algorithms)
                         throws ChecksumValidationException

Of any checksum files present, validate that the reference file conforms the to the checksum.

Parameters:

algorithms - the algorithms to check for.

Returns:

true if the checksums report that the the reference file is valid, false if invalid.

Throws:

ChecksumValidationException

isValidChecksums

public boolean isValidChecksums(List<ChecksumAlgorithm> algorithms,
                                boolean throwExceptions)
                         throws ChecksumValidationException

Checks if the checksum files are valid for the referenced file. It tries to find a checksum file for each algorithm in the same directory as the referenceFile. The method returns true, if at least one checksum file exists for one of the given algorithms and all existing checksum files are valid. This method throws only exceptions, if throwExceptions is true. Otherwise false will be returned instead. It verifies only the existing checksum files. If the checksum file for a particular algorithm does not exist, but others exist and are valid, it will return true.

Parameters:

algorithms - The algorithms to verify

throwExceptions - If true, exceptions will be thrown, otherwise false will be returned, if a exception occurred.

Returns:

True, if it is valid for all existing checksum files, otherwise false.

Throws:

ChecksumValidationException

getReferenceFile

public Path getReferenceFile()

fixChecksum

public UpdateStatusList fixChecksum(ChecksumAlgorithm algorithm)

fixChecksums

public UpdateStatusList fixChecksums(List<ChecksumAlgorithm> algorithms)

Writes a checksum file, if it does not exist or if it exists and has a different checksum value.

Parameters:

algorithms - the hashes to check for.

Returns:

true if checksums were created successfully.

parseChecksum

public String parseChecksum(Path checksumFile,
                            ChecksumAlgorithm checksumAlgorithm,
                            String fileName,
                            Charset encoding)
                     throws ChecksumValidationException

Parse a checksum string.

Validate the expected path, and expected checksum algorithm, then return the trimmed checksum hex string.

Parameters:

checksumFile - The file where the checksum is stored

checksumAlgorithm - The checksum algorithm to check

fileName - The filename of the reference file

Returns:

Throws:

IOException

ChecksumValidationException

parseChecksumFile

public ChecksumFileContent parseChecksumFile(Path checksumFile,
                                             ChecksumAlgorithm checksumAlgorithm,
                                             Charset encoding)