org.duracloud.sync.endpoint
Interface SyncEndpoint

All Known Implementing Classes:

DuraStoreChunkSyncEndpoint, DuraStoreSyncEndpoint, FileSystemSyncEndpoint

public interface SyncEndpoint

Endpoint to which files are synchronized.

Method Summary

java.util.Iterator<java.lang.String>

getFilesList() Retrieves a listing of all files available at the endpoint.

boolean

syncFile(java.io.File file, java.io.File watchDir) Ensures that the endpoint includes a file equivalent to the provided local file: - If the local file exists but no file with the same path exists at the endpoint, the local file will be copied to the endpoint - If the local file exists and is different from a file with the same path at the endpoint, the local file will replace the file at the endpoint.

Method Detail

syncFile

boolean syncFile(java.io.File file,
                 java.io.File watchDir)

Ensures that the endpoint includes a file equivalent to the provided local file: - If the local file exists but no file with the same path exists at the endpoint, the local file will be copied to the endpoint - If the local file exists and is different from a file with the same path at the endpoint, the local file will replace the file at the endpoint. - If the local file does not exist (it has been deleted), a file with the same path will be removed at the endpoint (if it exists)

Parameters:

file - local file to sync with the endpoint

watchDir - the directory under watch in which this file resides

Returns:

true if file was successfully synced, false otherwise

getFilesList

java.util.Iterator<java.lang.String> getFilesList()

Retrieves a listing of all files available at the endpoint. This list is to be used for comparison with the local system.

Returns:

Iterator allowing access to complete file listing