Interface ArcRepositoryClient
-
- All Superinterfaces:
AutoCloseable
,HarvesterArcRepositoryClient
,PreservationArcRepositoryClient
,ViewerArcRepositoryClient
- All Known Implementing Classes:
BitmagArcRepositoryClient
,JMSArcRepositoryClient
,LocalArcRepositoryClient
,TestArcRepositoryClient
,TrivialArcRepositoryClient
public interface ArcRepositoryClient extends HarvesterArcRepositoryClient, ViewerArcRepositoryClient, PreservationArcRepositoryClient
Generic interface defining all methods that an ArcRepository provides. Typically, an application using this will only see one of the restricted superinterfaces.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method 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)
Deprecated.void
store(File file)
Store the given file in the ArcRepository.void
updateAdminChecksum(String filename, String checksum)
Deprecated.void
updateAdminData(String fileName, String bitarchiveId, ReplicaStoreState newval)
Deprecated.-
Methods inherited from interface dk.netarkivet.common.distribute.arcrepository.PreservationArcRepositoryClient
correct, getAllChecksums, getAllFilenames, getChecksum
-
-
-
-
Method Detail
-
close
void close()
Call on shutdown to release external resources.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceHarvesterArcRepositoryClient
- Specified by:
close
in interfacePreservationArcRepositoryClient
- Specified by:
close
in interfaceViewerArcRepositoryClient
-
get
BitarchiveRecord get(String arcfile, long index) throws ArgumentNotValid
Gets a single ARC record out of the ArcRepository.- Specified by:
get
in interfacePreservationArcRepositoryClient
- Specified by:
get
in interfaceViewerArcRepositoryClient
- Parameters:
arcfile
- The name of a file containing the desired record.index
- The offset of the desired record in the file- Returns:
- a BitarchiveRecord-object, or null if request times out or object is not found.
- Throws:
IOFailure
- If the get operation failed.ArgumentNotValid
- if the given arcfile is null or empty string, or the given index is negative.
-
getFile
void getFile(String arcfilename, Replica replica, File toFile)
Retrieves a file from an ArcRepository and places it in a local file.- Specified by:
getFile
in interfacePreservationArcRepositoryClient
- Specified by:
getFile
in interfaceViewerArcRepositoryClient
- Parameters:
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.- Throws:
IOFailure
- if there are problems getting a reply or the file could not be found.
-
store
void store(File file) throws IOFailure, ArgumentNotValid
Store the given file in the ArcRepository. After storing, the file is deleted.- Specified by:
store
in interfaceHarvesterArcRepositoryClient
- Specified by:
store
in interfacePreservationArcRepositoryClient
- Parameters:
file
- A file to be stored. Must exist.- Throws:
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.
-
batch
BatchStatus batch(FileBatchJob job, String replicaId, String... args)
Runs a batch batch job on each file in the ArcRepository.- Specified by:
batch
in interfacePreservationArcRepositoryClient
- Specified by:
batch
in interfaceViewerArcRepositoryClient
- Parameters:
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.- Returns:
- The status of the batch job after it ended.
-
updateAdminData
@Deprecated void updateAdminData(String fileName, String bitarchiveId, ReplicaStoreState newval)
Deprecated.Updates the administrative data in the ArcRepository for a given file and replica.- Specified by:
updateAdminData
in interfacePreservationArcRepositoryClient
- Parameters:
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.
-
updateAdminChecksum
@Deprecated void updateAdminChecksum(String filename, String checksum)
Deprecated.Updates the checksum kept in the ArcRepository for a given file. It is the responsibility of the ArcRepository implementation to ensure that this checksum matches that of the underlying files.- Specified by:
updateAdminChecksum
in interfacePreservationArcRepositoryClient
- Parameters:
filename
- The name of a file stored in the ArcRepository.checksum
- The new checksum.
-
removeAndGetFile
@Deprecated File removeAndGetFile(String fileName, String bitarchiveId, String checksum, String credentials)
Deprecated.Remove a file from one part of the ArcRepository, retrieving a copy for security purposes. This is typically used when repairing a file that has been corrupted.- Specified by:
removeAndGetFile
in interfacePreservationArcRepositoryClient
- Parameters:
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.- Returns:
- A local copy of the file removed.
-
-