org.codehaus.plexus.digest

Class ChecksumFile

public class ChecksumFile extends Object

ChecksumFile

Version: $Id: ChecksumFile.java 6294 2007-04-13 15:42:34Z joakime $

Author: Joakim Erdfelt

UNKNOWN: role="org.codehaus.plexus.digest.ChecksumFile"

Method Summary
FilecreateChecksum(File referenceFile, Digester digester)
Creates a checksum file of the provided referenceFile.
booleanisValidChecksum(File checksumFile)

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

Method Detail

createChecksum

public File createChecksum(File referenceFile, Digester digester)
Creates a checksum file of the provided referenceFile.

Parameters: referenceFile the file to checksum. digester the digester to use.

Returns: the checksum File that was created.

Throws: DigesterException if there was a problem calculating the checksum of the referenceFile. IOException if there was a problem either reading the referenceFile, or writing the checksum file.

isValidChecksum

public boolean isValidChecksum(File checksumFile)

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

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.

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

Parameters: checksumFile the checksum file (must end in ".sha1" or ".md5")

Returns: true if the checksum is valid for the file it represents.

Throws: DigesterException if there is a digester problem during the check of the reference file. FileNotFoundException if the checksumFile itself or the file it refers to is not found. IOException if the reading of the checksumFile or the file it refers to fails.

Copyright © 2001-2009 Codehaus. All Rights Reserved.