org.bitrepository.modify.replacefile

Interface ReplaceFileClient

All Superinterfaces:

BitrepositoryClient

All Known Implementing Classes:

ConversationBasedReplaceFileClient

public interface ReplaceFileClient
extends BitrepositoryClient

Interface for the delete client.

Method Summary

Methods

Modifier and Type

Method and Description

void

replaceFile(String collectionID, String fileId, String pillarId, ChecksumDataForFileTYPE checksumForDeleteAtPillar, ChecksumSpecTYPE checksumRequestedForDeletedFile, URL url, long sizeOfNewFile, ChecksumDataForFileTYPE checksumForNewFileValidationAtPillar, ChecksumSpecTYPE checksumRequestsForNewFile, EventHandler eventHandler, String auditTrailInformation) Starts the conversation for replacing a file on a given pillar.

Method Detail

replaceFile

void replaceFile(String collectionID,
               String fileId,
               String pillarId,
               ChecksumDataForFileTYPE checksumForDeleteAtPillar,
               ChecksumSpecTYPE checksumRequestedForDeletedFile,
               URL url,
               long sizeOfNewFile,
               ChecksumDataForFileTYPE checksumForNewFileValidationAtPillar,
               ChecksumSpecTYPE checksumRequestsForNewFile,
               EventHandler eventHandler,
               String auditTrailInformation)

Starts the conversation for replacing a file on a given pillar. It is similar to performing the DeleteFile followed by the PutFile operations. Since both of these takes two checksum arguments each, then this takes four!

Parameters:

collectionID - The collection to repæace the file in.

fileId - The id of the file to delete.

pillarId - The id of the pillar, where the file should be replaced.

checksumForDeleteAtPillar - The checksum of the file on the pillar which should be replaced. Used for validating at pillar-side.

checksumRequestedForDeletedFile - [OPTIONAL] Request for calculation of the checksum of the file which should be replaced at the pillar. Used for client-side validation.

url - The URL of the new file to replaced the old one.

sizeOfNewFile - The size of the new file.

checksumForNewFileValidationAtPillar - [OPTIONAL] The checksum of the new file. Used for pillar-side validation.

checksumRequestsForNewFile - [OPTIONAL] Request for a checksum calculation of the new file. Used for client-side validation.

eventHandler - [OPTIONAL] The handler which should receive notifications of the events occurring in connection with the pillar communication. This is allowed to be null. In a good case scenario this will give the events:
IdentifyPillarsRequestSent, PillarIdentified, PillarSelected, RequestSent, Progress, PillarComplete, Complete

auditTrailInformation - The audit information for the given operation. E.g. who is behind the operation call.