com.netflix.genie.web.services

Interface FileTransfer

All Known Implementing Classes:

HttpFileTransferImpl, LocalFileTransferImpl, S3FileTransferImpl

public interface FileTransfer

API to handle file transfer for genie jobs. There will be an implementation for different files systems including local.

Since:

3.0.0

Method Summary

Modifier and Type	Method and Description
void	getFile(java.lang.String srcRemotePath, java.lang.String dstLocalPath) Gets a file from any remote location to Genie's local working directory.
long	getLastModifiedTime(java.lang.String path) Returns the last modified time of the file with the given path.
boolean	isValid(java.lang.String fileName) This method validates whether it can handle operations for a particular file based on the prefix of the file like s3://, hdfs:// etc.
void	putFile(java.lang.String srcLocalPath, java.lang.String dstRemotePath) Puts a file from Genie's local working directory to a remote location.

Method Detail

isValid

boolean isValid(java.lang.String fileName)
         throws com.netflix.genie.common.exceptions.GenieException

This method validates whether it can handle operations for a particular file based on the prefix of the file like s3://, hdfs:// etc.

Parameters:

fileName - file name to validate

Returns:

whether the implementation can handle file based on prefix

Throws:

com.netflix.genie.common.exceptions.GenieException - if there are errors

getFile

void getFile(java.lang.String srcRemotePath,
             java.lang.String dstLocalPath)
      throws com.netflix.genie.common.exceptions.GenieException

Gets a file from any remote location to Genie's local working directory.

Parameters:

srcRemotePath - Source path of the files to copy

dstLocalPath - Destination path of the files to copy to

Throws:

com.netflix.genie.common.exceptions.GenieException - exception in case of an error

putFile

void putFile(java.lang.String srcLocalPath,
             java.lang.String dstRemotePath)
      throws com.netflix.genie.common.exceptions.GenieException

Puts a file from Genie's local working directory to a remote location.

Parameters:

srcLocalPath - Source path of the files to copy

dstRemotePath - Destination path of the files to copy to

Throws:

com.netflix.genie.common.exceptions.GenieException - exception in case of an error

getLastModifiedTime

long getLastModifiedTime(java.lang.String path)
                  throws com.netflix.genie.common.exceptions.GenieException

Returns the last modified time of the file with the given path.

Parameters:

path - location of the file

Returns:

time in milliseconds

Throws:

com.netflix.genie.common.exceptions.GenieException - exception in case of IO error