public interface PreservationArcRepositoryClient
Modifier and Type | Method and Description |
---|---|
BatchStatus |
batch(FileBatchJob job,
String replicaId,
String... args)
Runs a batch batch job on each file in the ArcRepository.
|
void |
close()
Call on shutdown to release external resources.
|
File |
correct(String replicaId,
String checksum,
File file,
String credentials)
Method for correcting a file in a replica.
|
BitarchiveRecord |
get(String arcfile,
long index)
Gets a single ARC record out of the ArcRepository.
|
File |
getAllChecksums(String replicaId)
Retrieves all the checksum from the replica through a GetAllChecksumMessage.
|
File |
getAllFilenames(String replicaId)
Retrieves the names of all the files in the replica through a GetAllFilenamesMessage.
|
String |
getChecksum(String replicaId,
String filename)
Retrieves the checksum of a specific file.
|
void |
getFile(String arcfilename,
Replica replica,
File toFile)
Retrieves a file from an ArcRepository and places it in a local file.
|
File |
removeAndGetFile(String fileName,
String replicaId,
String checksum,
String credentials)
Remove a file from one part of the ArcRepository, retrieving a copy for security purposes.
|
void |
store(File file)
Store the given file in the ArcRepository.
|
void |
updateAdminChecksum(String filename,
String checksum)
Updates the checksum kept in the ArcRepository for a given file.
|
void |
updateAdminData(String fileName,
String replicaId,
ReplicaStoreState newval)
Updates the administrative data in the ArcRepository for a given file and bitarchive replica.
|
void close()
BitarchiveRecord get(String arcfile, long index) throws ArgumentNotValid
arcfile
- The name of a file containing the desired record.index
- The offset of the desired record in the fileArgumentNotValid
- If the get operation failed.void getFile(String arcfilename, Replica replica, File toFile)
arcfilename
- Name of the arcfile to retrieve.replica
- The bitarchive to retrieve the data from.toFile
- Filename of a place where the file fetched can be put.IOFailure
- if there are problems getting a reply or the file could not be found.void store(File file) throws IOFailure, ArgumentNotValid
file
- A file to be stored. Must exist.IOFailure
- thrown if store is unsuccessful, or failed to clean up files after the store operation.ArgumentNotValid
- if file parameter is null or file is not an existing file.BatchStatus batch(FileBatchJob job, String replicaId, String... args)
job
- An object that implements the FileBatchJob interface. The initialize() method will be called before
processing and the finish() method will be called afterwards. The process() method will be called with each File
entry. An optional function postProcess() allows handling the combined results of the batchjob, e.g. summing the
results, sorting, etc.replicaId
- The archive to execute the job on.args
- The arguments for the batchjob.void updateAdminData(String fileName, String replicaId, ReplicaStoreState newval)
fileName
- The name of a file stored in the ArcRepository.replicaId
- The id if the replica that the administrative data for fileName is wrong for.newval
- What the administrative data will be updated to.void updateAdminChecksum(String filename, String checksum)
filename
- The name of a file stored in the ArcRepository.checksum
- The new checksum.File removeAndGetFile(String fileName, String replicaId, String checksum, String credentials)
fileName
- The name of the file to remove.replicaId
- The replica id from which to remove the file.checksum
- The checksum of the file to be removed.credentials
- A string that shows that the user is allowed to perform this operation.File getAllChecksums(String replicaId)
This is the checksum archive alternative to running a ChecksumBatchJob.
replicaId
- The id of the replica from which the checksums should be retrieved.GetAllChecksumsMessage
String getChecksum(String replicaId, String filename)
This is the checksum archive alternative to running a ChecksumJob limited to a specific file.
replicaId
- The name of the replica to send the message.filename
- The name of the file for whom the checksum should be retrieved.File getAllFilenames(String replicaId)
This is the checksum archive alternative to running a FilelistBatchJob.
replicaId
- The id of the replica from which the list of filenames should be retrieved.GetAllFilenamesMessage
File correct(String replicaId, String checksum, File file, String credentials)
This is the checksum archive method for correcting a file entry in the archive. The bitarchive uses 'removeAndGetFile' followed by a 'store'.
replicaId
- The identification of the replica.checksum
- The checksum of the corrupt entry in the archive. It is important to validate that the checksum
actually is wrong before correcting the entry.file
- The new file to replace the old one.credentials
- The password for allowing to remove a file entry in the archive.Copyright © 2005–2016 The Royal Danish Library, the Danish State and University Library, the National Library of France and the Austrian National Library.. All rights reserved.