public final class FileChecksumArchive extends Object implements ChecksumArchive
Each entry in the file is on its own line, thus the number of lines is the number of entries.
The entries on a line is in the format of a ChecksumJob:
'filename' + ## + 'checksum'
The lines are not sorted.
If no file exists when the class is instantiated then it will be created, and if an 'admin.data' file exists, then it will be loaded and put into the archive file.
Modifier and Type | Method and Description |
---|---|
String |
calculateChecksum(File f)
Method for calculating the checksum of a file.
|
String |
calculateChecksum(InputStream is)
Method for calculating the checksum of a inputstream.
|
void |
cleanup()
The method for cleaning up when done.
|
File |
correct(String filename,
File correctFile)
Method for correcting a bad entry from the archive.
|
File |
getAllFilenames()
Method for retrieving the names of all the files within the archive as a temporary file.
|
File |
getArchiveAsFile()
Method for retrieving the archive as a temporary file containing the checksum entries.
|
String |
getChecksum(String filename)
Method for retrieving the checksum of a record, based on the filename.
|
String |
getFileName()
Method for retrieving the name of the checksum file.
|
static FileChecksumArchive |
getInstance()
Method for obtaining the current singleton instance of this class.
|
String |
getWrongEntryFilename()
Method for retrieving the name of the wrongEntryFile.
|
boolean |
hasEnoughSpace()
Method for testing where there is enough space left on local drive.
|
boolean |
hasEntry(String filename)
Method for checking whether an entry exists within the archive.
|
void |
upload(RemoteFile file,
String filename)
The method for uploading a file to the archive.
|
public static FileChecksumArchive getInstance()
public String getFileName()
public String getWrongEntryFilename()
public boolean hasEnoughSpace()
hasEnoughSpace
in interface ChecksumArchive
public void upload(RemoteFile file, String filename) throws ArgumentNotValid, IllegalState
upload
in interface ChecksumArchive
file
- The remote file containing the file to be uploaded.filename
- The name of the arcFile.ArgumentNotValid
- If the RemoteFile is null or if the filename is not valid.IllegalState
- If the file already within the archive but with a different checksum.public String getChecksum(String filename) throws ArgumentNotValid
getChecksum
in interface ChecksumArchive
filename
- The name of the file to have recorded in the archive.ArgumentNotValid
- If the filename is not valid (null or empty).public boolean hasEntry(String filename)
hasEntry
in interface ChecksumArchive
filename
- The name of the file whose entry in the archive should be determined.public String calculateChecksum(File f) throws IOFailure
calculateChecksum
in interface ChecksumArchive
f
- The file to calculate the checksum of.IOFailure
- If a IOException is caught during the calculation of the MD5-checksum.public String calculateChecksum(InputStream is) throws IOFailure
calculateChecksum
in interface ChecksumArchive
is
- The inputstream to calculate the checksum of.IOFailure
- If a error occurs during the generation of the MD5 checksum.public File correct(String filename, File correctFile) throws IOFailure, ArgumentNotValid, IllegalState
correct
in interface ChecksumArchive
filename
- The name of the file whose record should be removed.correctFile
- The file that should replace the current entryArgumentNotValid
- If one of the arguments are not valid.IOFailure
- If the entry cannot be corrected. Either the bad entry cannot be stored, or the new checksum
file cannot be created. Or if a file for the removed entry cannot be created.IllegalState
- If no such entry exists to be corrected, or if the entry has a different checksum than the
incorrectChecksum.public File getArchiveAsFile() throws IOFailure
getArchiveAsFile
in interface ChecksumArchive
IOFailure
- If problems occurs during the creation of the file.public File getAllFilenames() throws IOFailure
getAllFilenames
in interface ChecksumArchive
IOFailure
- If problems occurs during the creation of the file.public void cleanup()
cleanup
in interface ChecksumArchive
Copyright © 2005–2015 The Royal Danish Library, the Danish State and University Library, the National Library of France and the Austrian National Library.. All rights reserved.