public interface ArcRepositoryClient extends HarvesterArcRepositoryClient, ViewerArcRepositoryClient, 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.
|
BitarchiveRecord |
get(String arcfile,
long index)
Gets a single ARC record out of the ArcRepository.
|
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 bitarchiveId,
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 bitarchiveId,
ReplicaStoreState newval)
Updates the administrative data in the ArcRepository for a given file and replica.
|
correct, getAllChecksums, getAllFilenames, getChecksum
void close()
close
in interface HarvesterArcRepositoryClient
close
in interface PreservationArcRepositoryClient
close
in interface ViewerArcRepositoryClient
BitarchiveRecord get(String arcfile, long index) throws ArgumentNotValid
get
in interface PreservationArcRepositoryClient
get
in interface ViewerArcRepositoryClient
arcfile
- The name of a file containing the desired record.index
- The offset of the desired record in the fileIOFailure
- If the get operation failed.ArgumentNotValid
- if the given arcfile is null or empty string, or the given index is negative.void getFile(String arcfilename, Replica replica, File toFile)
getFile
in interface PreservationArcRepositoryClient
getFile
in interface ViewerArcRepositoryClient
arcfilename
- Name of the arcfile to retrieve.replica
- The bitarchive to retrieve the data from. On implementations with only one replica, null may be
used.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
store
in interface HarvesterArcRepositoryClient
store
in interface PreservationArcRepositoryClient
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)
batch
in interface PreservationArcRepositoryClient
batch
in interface ViewerArcRepositoryClient
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 bitarchiveId, ReplicaStoreState newval)
updateAdminData
in interface PreservationArcRepositoryClient
fileName
- The name of a file stored in the ArcRepository.bitarchiveId
- The id of 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)
updateAdminChecksum
in interface PreservationArcRepositoryClient
filename
- The name of a file stored in the ArcRepository.checksum
- The new checksum.File removeAndGetFile(String fileName, String bitarchiveId, String checksum, String credentials)
removeAndGetFile
in interface PreservationArcRepositoryClient
fileName
- The name of the file to remove.bitarchiveId
- The id of the replica 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.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.