Class AbstractS3Action

java.lang.Object

com.kingsrook.qqq.backend.module.filesystem.base.actions.AbstractBaseFilesystemAction<S3ObjectSummary>

com.kingsrook.qqq.backend.module.filesystem.s3.actions.AbstractS3Action

Direct Known Subclasses:

S3CountAction, S3DeleteAction, S3InsertAction, S3QueryAction, S3StorageAction

public class AbstractS3Action
extends AbstractBaseFilesystemAction<S3ObjectSummary>

Base class for all S3 filesystem actions

Field Summary

Fields inherited from class com.kingsrook.qqq.backend.module.filesystem.base.actions.AbstractBaseFilesystemAction

backendVariantRecord

Constructor Summary

Constructors

Constructor	Description
AbstractS3Action()

Method Summary

Modifier and Type	Method	Description
protected software.amazon.awssdk.services.s3.S3Client	buildS3ClientFromBackendMetaData(QBackendMetaData backendMetaData)	Get the (shared, cached) S3 client for the backend's connection settings.
void	deleteFile(QTableMetaData table, String fileReference)	In contrast with the DeleteAction, which deletes RECORDS - this is a filesystem-(or s3, sftp, etc)-specific extension to delete an entire FILE e.g., for post-ETL.
Instant	getFileCreateDate(S3ObjectSummary s3ObjectSummary)	get the createDate of the specified file, null if not supported/available
Instant	getFileModifyDate(S3ObjectSummary s3ObjectSummary)	get the createDate of the specified file, null if not supported/available
Long	getFileSize(S3ObjectSummary s3ObjectSummary)	get the size of the specified file, null if not supported/available
String	getFullPathForFile(S3ObjectSummary s3ObjectSummary)	Get a string that represents the full path to a file.
protected S3Utils	getS3Utils()	Internal accessor for the s3Utils object - should always use this, not the field.
List<S3ObjectSummary>	listFiles(QTableMetaData table, QBackendMetaData backendBase, String requestedPath)	List the files for a table.
void	moveFile(QInstance instance, QTableMetaData table, String source, String destination)	In contrast with the DeleteAction, which deletes RECORDS - this is a filesystem-(or s3, sftp, etc)-specific extension to delete an entire FILE e.g., for post-ETL.
void	preAction(QBackendMetaData backendMetaData)	Setup the s3 utils object to be used for this action.
InputStream	readFile(S3ObjectSummary s3ObjectSummary)	Read the contents of a file.
void	setS3Utils(S3Utils s3Utils)	Set the S3Utils object.
String	stripBackendAndTableBasePathsFromFileName(String filePath, QBackendMetaData backend, QTableMetaData table)	e.g., with a base path of /foo/ and a table path of /bar/ and a file at /foo/bar/baz.txt give us just the baz.txt part.
void	writeFile(QBackendMetaData backendMetaData, QTableMetaData table, QRecord record, String path, byte[] contents)	Write a file - to be implemented in module-specific subclasses.

Methods inherited from class com.kingsrook.qqq.backend.module.filesystem.base.actions.AbstractBaseFilesystemAction

addBackendDetailsToRecord, addBackendDetailsToRecords, executeCount, executeDelete, executeInsert, executeQuery, findAssociatedPrimaryKeys, getBackendMetaData, getFullBasePath, getTableBackendDetails, isPathEqualsCriteria, listFiles, lookupUniqueKey, postAction, readAssociationValues, stripDuplicatedSlashes, stripLeadingSlash, stripTrailingSlash

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractS3Action

public AbstractS3Action()

Method Details

getFileSize

public Long getFileSize(S3ObjectSummary s3ObjectSummary)

Description copied from class: AbstractBaseFilesystemAction

get the size of the specified file, null if not supported/available

Specified by:

getFileSize in class AbstractBaseFilesystemAction<S3ObjectSummary>

getFileCreateDate

public Instant getFileCreateDate(S3ObjectSummary s3ObjectSummary)

Description copied from class: AbstractBaseFilesystemAction

get the createDate of the specified file, null if not supported/available

Specified by:

getFileCreateDate in class AbstractBaseFilesystemAction<S3ObjectSummary>

getFileModifyDate

public Instant getFileModifyDate(S3ObjectSummary s3ObjectSummary)

Description copied from class: AbstractBaseFilesystemAction

get the createDate of the specified file, null if not supported/available

Specified by:

getFileModifyDate in class AbstractBaseFilesystemAction<S3ObjectSummary>

preAction

public void preAction(QBackendMetaData backendMetaData)
               throws QException

Setup the s3 utils object to be used for this action.

Overrides:

preAction in class AbstractBaseFilesystemAction<S3ObjectSummary>

Throws:

QException

buildS3ClientFromBackendMetaData

protected software.amazon.awssdk.services.s3.S3Client buildS3ClientFromBackendMetaData(QBackendMetaData backendMetaData)

Get the (shared, cached) S3 client for the backend's connection settings. Throws IllegalArgumentException if the backend is not an S3 backend.

setS3Utils

public void setS3Utils(S3Utils s3Utils)

Set the S3Utils object.

getS3Utils

protected S3Utils getS3Utils()

Internal accessor for the s3Utils object - should always use this, not the field.

listFiles

public List<S3ObjectSummary> listFiles(QTableMetaData table,
 QBackendMetaData backendBase,
 String requestedPath)
                                throws QException

List the files for a table.

Specified by:

listFiles in class AbstractBaseFilesystemAction<S3ObjectSummary>

Throws:

QException

readFile

public InputStream readFile(S3ObjectSummary s3ObjectSummary)
                     throws IOException

Read the contents of a file.

Specified by:

readFile in class AbstractBaseFilesystemAction<S3ObjectSummary>

Throws:

IOException

writeFile

public void writeFile(QBackendMetaData backendMetaData,
 QTableMetaData table,
 QRecord record,
 String path,
 byte[] contents)
               throws IOException

Write a file - to be implemented in module-specific subclasses.

Specified by:

writeFile in class AbstractBaseFilesystemAction<S3ObjectSummary>

Throws:

IOException

getFullPathForFile

public String getFullPathForFile(S3ObjectSummary s3ObjectSummary)

Get a string that represents the full path to a file.

Specified by:

getFullPathForFile in class AbstractBaseFilesystemAction<S3ObjectSummary>

stripBackendAndTableBasePathsFromFileName

public String stripBackendAndTableBasePathsFromFileName(String filePath,
 QBackendMetaData backend,
 QTableMetaData table)

e.g., with a base path of /foo/ and a table path of /bar/ and a file at /foo/bar/baz.txt give us just the baz.txt part.

Overrides:

stripBackendAndTableBasePathsFromFileName in class AbstractBaseFilesystemAction<S3ObjectSummary>

deleteFile

public void deleteFile(QTableMetaData table,
 String fileReference)
                throws FilesystemException

In contrast with the DeleteAction, which deletes RECORDS - this is a filesystem-(or s3, sftp, etc)-specific extension to delete an entire FILE e.g., for post-ETL.

Specified by:

deleteFile in class AbstractBaseFilesystemAction<S3ObjectSummary>

Throws:

FilesystemException - if the delete is known to have failed, and the file is thought to still exit

moveFile

public void moveFile(QInstance instance,
 QTableMetaData table,
 String source,
 String destination)
              throws FilesystemException

In contrast with the DeleteAction, which deletes RECORDS - this is a filesystem-(or s3, sftp, etc)-specific extension to delete an entire FILE e.g., for post-ETL.

Specified by:

moveFile in class AbstractBaseFilesystemAction<S3ObjectSummary>

Parameters:

destination - assumed to be a file path - not a directory

Throws:

FilesystemException - if the move is known to have failed