org.apache.oodt.cas.filemgr.datatransfer

Interface DataTransfer

All Known Implementing Classes:

InPlaceDataTransferer, LocalDataTransferer, RemoteDataTransferer, S3DataTransferer

public interface DataTransfer

Version:

$Revision$

Objects implementing this interface define how to transfer products to the DataStore repository.

Author:

mattmann

Field Summary

Fields

Modifier and Type	Field and Description
static String	X_POINT_ID

Method Summary

Modifier and Type	Method and Description
void	deleteProduct(Product product)
void	retrieveProduct(Product product, File directory) Requires that the data store reference be set, nothing else is used
void	setFileManagerUrl(URL url)
void	transferProduct(Product product)

Field Detail

X_POINT_ID

static final String X_POINT_ID

Method Detail

setFileManagerUrl

void setFileManagerUrl(URL url)

Parameters:

url - The URL to the File Manager that this transferer will be transferring Products to.

transferProduct

void transferProduct(Product product)
              throws DataTransferException,
                     IOException

Parameters:

product - The product that is being transferred. The product should have both its origFileLocation, as well as its dataStoreRefs filled in to perform the transfer.

Throws:

DataTransferException - If a general error occurs during the transfer.

IOException - If there is an IO eerror when performing the transfer.

retrieveProduct

void retrieveProduct(Product product,
                     File directory)
              throws DataTransferException,
                     IOException

Requires that the data store reference be set, nothing else is used

Parameters:

product - The product whose data store reference will be copied

directory - The directory where the data store reference will be copied to

Throws:

DataTransferException - If a general error occurs during the transfer.

IOException - If there is an IO eerror when performing the transfer.

deleteProduct

void deleteProduct(Product product)
            throws DataTransferException,
                   IOException

Throws:

DataTransferException

IOException