Package dk.netarkivet.archive.arcrepository.distribute

Class JMSArcRepositoryClient

    • Field Detail

      • log

        protected static final org.slf4j.Logger log
        Logging output place.

      • ARCREPOSITORY_GET_TIMEOUT

        public static final String ARCREPOSITORY_GET_TIMEOUT
        settings.common.arcrepositoryClient.getTimeout:
        The setting for how many milliseconds we will wait before giving up on a lookup request to the Arcrepository.
        See Also:
        Constant Field Values

      • ARCREPOSITORY_STORE_RETRIES

        public static final String ARCREPOSITORY_STORE_RETRIES
        settings.common.arcrepositoryClient.storeRetries:
        The setting for the number of times to try sending a store message before failing, including the first attempt.
        See Also:
        Constant Field Values

    • Constructor Detail

      • JMSArcRepositoryClient

        protected JMSArcRepositoryClient()
        Adds this Synchronizer as listener on a jms connection.

    • Method Detail

      • getInstance

        public static JMSArcRepositoryClient getInstance()
        Get an JMSArcRepositoryClient instance. This is guaranteed to be a singleton.
        Returns:
        an JMSArcRepositoryClient instance.

      • get

        public BitarchiveRecord get​(String arcfile,
                            long index)
                     throws ArgumentNotValid,
                            IOFailure
        Sends a GetMessage on the "TheArcrepos" queue and waits for a reply. This is a blocking call. Returns null if no message is returned within Settings.ARCREPOSITORY_GET_TIMEOUT
        Specified by:
        get in interface ArcRepositoryClient
        Specified by:
        get in interface PreservationArcRepositoryClient
        Specified by:
        get in interface ViewerArcRepositoryClient
        Parameters:
        arcfile - The name of a file.
        index - The offset of the wanted record in the file
        Returns:
        a BitarchiveRecord-object or null if request times out or object is not found.
        Throws:
        ArgumentNotValid - If the given arcfile is null or empty, or the given index is negative.
        IOFailure - If a wrong message is returned or the get operation failed.

      • getFile

        public void getFile​(String arcfilename,
                    Replica replica,
                    File toFile)
             throws ArgumentNotValid,
                    IOFailure
        Synchronously retrieves a file from a bitarchive and places it in a local file. This is the interface for sending GetFileMessage on the "TheArcrepos" queue. This is a blocking call.
        Specified by:
        getFile in interface ArcRepositoryClient
        Specified by:
        getFile in interface PreservationArcRepositoryClient
        Specified by:
        getFile in interface ViewerArcRepositoryClient
        Parameters:
        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.
        Throws:
        ArgumentNotValid - If the arcfilename are null or empty, or if either replica or toFile is null.
        IOFailure - if there are problems getting a reply or the file could not be found.

      • batch

        public BatchStatus batch​(FileBatchJob job,
                         String replicaId,
                         String... args)
        Runs a batch batch job on each file in the ArcRepository.

        Note: The id for the batchjob is the empty string, which removes the possibility of terminating the batchjob remotely while it is running.

        Specified by:
        batch in interface ArcRepositoryClient
        Specified by:
        batch in interface PreservationArcRepositoryClient
        Specified by:
        batch in interface ViewerArcRepositoryClient
        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.

      • batch

        public BatchStatus batch​(FileBatchJob job,
                         String replicaId,
                         String batchId,
                         String... args)
                  throws IOFailure,
                         ArgumentNotValid
        Runs a batch job on each file in the ArcRepository.
        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. This is allowed to be null.
        batchId - The id for the batch process.
        Returns:
        The status of the batch job after it ended.
        Throws:
        ArgumentNotValid - If the job is null or the replicaId is either null or the empty string.
        IOFailure - If no result file is returned.

      • getAllChecksums

        public File getAllChecksums​(String replicaId)
                     throws IOFailure,
                            ArgumentNotValid
        Retrieves all the checksum from the replica through a GetAllChecksumMessage.

        This is the checksum archive alternative to running a ChecksumBatchJob.

        Specified by:
        getAllChecksums in interface PreservationArcRepositoryClient
        Parameters:
        replicaId - The id of the replica from which the checksums should be retrieved.
        Returns:
        A file containing filename and checksum of all the files in an archive in the same format as a ChecksumJob.
        Throws:
        IOFailure - If the reply is not of type GetAllChecksumsMessage or if the file could not properly be retrieved from the reply message or if the message timed out.
        ArgumentNotValid - If the replicaId is null or empty.
        See Also:
        GetAllChecksumsMessage

      • getAllFilenames

        public File getAllFilenames​(String replicaId)
                     throws ArgumentNotValid,
                            IOFailure
        Retrieves the names of all the files in the replica through a GetAllFilenamesMessage.

        This is the checksum archive alternative to running a FilelistBatchJob.

        Specified by:
        getAllFilenames in interface PreservationArcRepositoryClient
        Parameters:
        replicaId - The id of the replica from which the list of filenames should be retrieved.
        Returns:
        A file with all the filenames within the archive of the given replica. A null is returned if the message timeout.
        Throws:
        IOFailure - If the reply is not of type GetAllFilenamesMessage or if the file could not properly be retrieved from the reply message
        ArgumentNotValid - If the replicaId is null or empty.
        See Also:
        GetAllFilenamesMessage

      • getChecksum

        public String getChecksum​(String replicaId,
                          String filename)
                   throws ArgumentNotValid,
                          IOFailure
        Retrieves the checksum of a specific file.

        This is the checksum archive alternative to running a ChecksumJob limited to a specific file.

        Specified by:
        getChecksum in interface PreservationArcRepositoryClient
        Parameters:
        replicaId - The ID of the replica to send the message.
        filename - The name of the file for whom the checksum should be retrieved.
        Returns:
        The checksum of the file in the replica.
        Throws:
        IOFailure - If the reply is not of type GetChecksumMessage. Or if the message timed out.
        ArgumentNotValid - If either the replicaId of the filename is null or empty.

      • correct

        public File correct​(String replicaId,
                    String checksum,
                    File file,
                    String credentials)
             throws IOFailure,
                    ArgumentNotValid
        Method for correcting an entry in a replica. This is done by sending a correct message to the replica.

        The file which is removed from the replica is put into the tempDir.

        Specified by:
        correct in interface PreservationArcRepositoryClient
        Parameters:
        replicaId - The id of the replica to send the message.
        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 file to correct the entry in the archive of the replica.
        credentials - A string with the password for allowing changes inside an archive. If it does not correspond to the credentials of the archive, the correction will not be allowed.
        Returns:
        The corrupted file from the archive.
        Throws:
        IOFailure - If the message is not handled properly.
        ArgumentNotValid - If the replicaId, the checksum or the credentials are either null or empty, or if file is null.