com.netflix.priam.aws

Class S3FileSystemBase

java.lang.Object

com.netflix.priam.backup.AbstractFileSystem

com.netflix.priam.aws.S3FileSystemBase

All Implemented Interfaces:

IBackupFileSystem, EventGenerator<BackupEvent>

Direct Known Subclasses:

S3EncryptedFileSystem, S3FileSystem

public abstract class S3FileSystemBase
extends AbstractFileSystem

Field Summary

Fields inherited from class com.netflix.priam.backup.AbstractFileSystem

backupMetrics, pathProvider

Method Summary

Modifier and Type	Method and Description
void	cleanup() Runs cleanup or set retention
void	configChangeListener()
void	deleteFiles(java.util.List<java.nio.file.Path> remotePaths)
protected boolean	doesRemoteFileExist(java.nio.file.Path remotePath)
long	getFileSize(java.lang.String remotePath) Get the size of the remote object
java.util.Iterator<java.lang.String>	listFileSystem(java.lang.String prefix, java.lang.String delimiter, java.lang.String marker) List all the files with the given prefix, delimiter, and marker.
void	setS3Client(com.amazonaws.services.s3.AmazonS3 client)
void	shutdown() Give the file system a chance to terminate any thread pools, etc.

Methods inherited from class com.netflix.priam.backup.AbstractFileSystem

addObserver, asyncDownloadFile, asyncUploadAndDelete, checkObjectExists, clearCache, deleteRemoteFiles, downloadFile, downloadFileImpl, getDownloadTasksQueued, getPrefix, getShard, getUploadTasksQueued, list, listPrefixes, notifyEventFailure, notifyEventStart, notifyEventStop, notifyEventSuccess, removeObserver, uploadAndDelete, uploadFileImpl

Methods inherited from class java.lang.Object

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

Method Detail

configChangeListener

public void configChangeListener()

setS3Client

public void setS3Client(com.amazonaws.services.s3.AmazonS3 client)

cleanup

public void cleanup()

Description copied from interface: IBackupFileSystem

Runs cleanup or set retention

getFileSize

public long getFileSize(java.lang.String remotePath)
                 throws BackupRestoreException

Description copied from interface: IBackupFileSystem

Get the size of the remote object

Parameters:

remotePath - Location of the object on the remote file system.

Returns:

size of the object on the remote filesystem.

Throws:

BackupRestoreException - in case of failure to read object denoted by remotePath or any other error.

doesRemoteFileExist

protected boolean doesRemoteFileExist(java.nio.file.Path remotePath)

Specified by:

doesRemoteFileExist in class AbstractFileSystem

shutdown

public void shutdown()

Description copied from interface: IBackupFileSystem

Give the file system a chance to terminate any thread pools, etc.

listFileSystem

public java.util.Iterator<java.lang.String> listFileSystem(java.lang.String prefix,
                                                           java.lang.String delimiter,
                                                           java.lang.String marker)

Description copied from interface: IBackupFileSystem

List all the files with the given prefix, delimiter, and marker. This should never return null.

Parameters:

prefix - Common prefix of the elements to search in the backup file system.

delimiter - All the object will end with this delimiter.

marker - Start the fetch with this as the first object.

Returns:

the iterator on the backup file system containing path of the files.

deleteFiles

public void deleteFiles(java.util.List<java.nio.file.Path> remotePaths)
                 throws BackupRestoreException

Specified by:

deleteFiles in class AbstractFileSystem

Throws:

BackupRestoreException