com.netflix.genie.web.services.impl

Class HttpFileTransferImpl

java.lang.Object

com.netflix.genie.web.services.impl.HttpFileTransferImpl

All Implemented Interfaces:

FileTransfer

public class HttpFileTransferImpl
extends java.lang.Object
implements FileTransfer

An implementation of the FileTransferService interface in which the remote locations are available via http[s].

Since:

3.0.0

Constructor Summary

Constructors

Constructor and Description
HttpFileTransferImpl(@NotNull org.springframework.web.client.RestTemplate restTemplate, @NotNull io.micrometer.core.instrument.MeterRegistry registry) Constructor.

Method Summary

Modifier and Type	Method and Description
void	getFile(@NotBlank(message="Source file path cannot be empty.") java.lang.String srcRemotePath, @NotBlank(message="Destination local path cannot be empty") 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(@NotBlank(message="Source local path cannot be empty.") java.lang.String srcLocalPath, @NotBlank(message="Destination remote path cannot be empty") java.lang.String dstRemotePath) Puts a file from Genie's local working directory to a remote location.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HttpFileTransferImpl

public HttpFileTransferImpl(@NotNull
                            @NotNull org.springframework.web.client.RestTemplate restTemplate,
                            @NotNull
                            @NotNull io.micrometer.core.instrument.MeterRegistry registry)

Constructor.

Parameters:

restTemplate - The rest template to use

registry - The metrics registry to use

Method Detail

isValid

public 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.

Specified by:

isValid in interface FileTransfer

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

public void getFile(@NotBlank(message="Source file path cannot be empty.")
                    @NotBlank(message="Source file path cannot be empty.") java.lang.String srcRemotePath,
                    @NotBlank(message="Destination local path cannot be empty")
                    @NotBlank(message="Destination local path cannot be empty") java.lang.String dstLocalPath)
             throws com.netflix.genie.common.exceptions.GenieException

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

Specified by:

getFile in interface FileTransfer

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

public void putFile(@NotBlank(message="Source local path cannot be empty.")
                    @NotBlank(message="Source local path cannot be empty.") java.lang.String srcLocalPath,
                    @NotBlank(message="Destination remote path cannot be empty")
                    @NotBlank(message="Destination remote path cannot be empty") java.lang.String dstRemotePath)
             throws com.netflix.genie.common.exceptions.GenieException

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

Specified by:

putFile in interface FileTransfer

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

public 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.

Specified by:

getLastModifiedTime in interface FileTransfer

Parameters:

path - location of the file

Returns:

time in milliseconds

Throws:

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