Class AbstractBaseFilesystemAction<FILE>

java.lang.Object

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

Record Components:

FILE - The class that represents a file in the sub-module. e.g., a java.io.File, or an S3Object.

Direct Known Subclasses:

AbstractFilesystemAction, AbstractS3Action, AbstractSFTPAction

public abstract class AbstractBaseFilesystemAction<FILE>
extends Object

Base class for all Filesystem actions across all modules.

Field Summary

Fields

Modifier and Type	Field	Description
protected QRecord	backendVariantRecord

Constructor Summary

Constructors

Constructor	Description
AbstractBaseFilesystemAction()

Method Summary

Modifier and Type	Method	Description
protected void	addBackendDetailsToRecord(QRecord record, FILE file)	Add backend details to a record about the file that it is in.
protected void	addBackendDetailsToRecords(List<QRecord> recordsInFile, FILE file)	Add backend details to records about the file that they are in.
abstract 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.
CountOutput	executeCount(CountInput countInput)
protected DeleteOutput	executeDelete(DeleteInput deleteInput)
protected InsertOutput	executeInsert(InsertInput insertInput)
QueryOutput	executeQuery(QueryInput queryInput)	Generic implementation of the execute method from the QueryInterface
List<Serializable>	findAssociatedPrimaryKeys(AssociatedRecordDiscovery.Input input)	MANY-file reads return all rows, so apply relationship criteria explicitly.
protected <T extends AbstractFilesystemBackendMetaData> T	getBackendMetaData(Class<T> outputClass, QBackendMetaData metaData)	Get the backend metaData, type-checked as the requested type.
abstract Instant	getFileCreateDate(FILE file)	get the createDate of the specified file, null if not supported/available
abstract Instant	getFileModifyDate(FILE file)	get the createDate of the specified file, null if not supported/available
abstract Long	getFileSize(FILE file)	get the size of the specified file, null if not supported/available
String	getFullBasePath(QTableMetaData table, QBackendMetaData backendBase)	Append together the backend's base path (if present), with a table's base path (again, if present).
abstract String	getFullPathForFile(FILE file)	Get a string that represents the full path to a file.
protected <T extends AbstractFilesystemTableBackendDetails> T	getTableBackendDetails(Class<T> outputClass, QTableMetaData tableMetaData)	Get the backendDetails out of a table, type-checked as the requested type
protected static boolean	isPathEqualsCriteria(QFilterCriteria criteria)
List<FILE>	listFiles(QTableMetaData table, QBackendMetaData backendBase)	List the files for a table - to be implemented in module-specific subclasses.
abstract List<FILE>	listFiles(QTableMetaData table, QBackendMetaData backendBase, String requestedSingleFileName)	List the files for a table - or optionally, just a single file name - to be implemented in module-specific subclasses.
List<QRecord>	lookupUniqueKey(UniqueKeyLookup.Input input)	MANY-file readers need explicit matching; projected key contents may be heavy.
abstract void	moveFile(QInstance instance, QTableMetaData table, String source, String destination)	Move a file from a source path, to a destination path.
void	postAction()	Method that subclasses can override to add post-action things (e.g., closing resources)
void	preAction(QBackendMetaData backendMetaData)	Method that subclasses can override to add pre-action things (e.g., setting up s3 client).
List<QRecord>	readAssociationValues(AssociatedRecordDiscovery.StoredValuesInput input)	Read only exact parent keys, retaining every declared relationship component.
abstract InputStream	readFile(FILE file)	Read the contents of a file - to be implemented in module-specific subclasses.
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.
static String	stripDuplicatedSlashes(String path)
static String	stripLeadingSlash(String path)
static String	stripTrailingSlash(String path)
abstract void	writeFile(QBackendMetaData backend, QTableMetaData table, QRecord record, String path, byte[] contents)	Write a file - to be implemented in module-specific subclasses.

Methods inherited from class java.lang.Object

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

Field Details

backendVariantRecord

protected QRecord backendVariantRecord

Constructor Details

AbstractBaseFilesystemAction

public AbstractBaseFilesystemAction()

Method Details

listFiles

public List<FILE> listFiles(QTableMetaData table,
 QBackendMetaData backendBase)
                     throws QException

List the files for a table - to be implemented in module-specific subclasses.

Throws:

QException

getFileSize

public abstract Long getFileSize(FILE file)

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

getFileCreateDate

public abstract Instant getFileCreateDate(FILE file)

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

getFileModifyDate

public abstract Instant getFileModifyDate(FILE file)

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

listFiles

public abstract List<FILE> listFiles(QTableMetaData table,
 QBackendMetaData backendBase,
 String requestedSingleFileName)
                              throws QException

List the files for a table - or optionally, just a single file name - to be implemented in module-specific subclasses.

Throws:

QException

readFile

public abstract InputStream readFile(FILE file)
                              throws IOException

Read the contents of a file - to be implemented in module-specific subclasses.

Throws:

IOException

writeFile

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

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

Throws:

IOException

getFullPathForFile

public abstract String getFullPathForFile(FILE file)

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

deleteFile

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

Throws:

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

moveFile

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

Move a file from a source path, to a destination path.

Throws:

FilesystemException - if the move is known to have failed

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.

getFullBasePath

public String getFullBasePath(QTableMetaData table,
 QBackendMetaData backendBase)

Append together the backend's base path (if present), with a table's base path (again, if present).

stripDuplicatedSlashes

public static String stripDuplicatedSlashes(String path)

stripLeadingSlash

public static String stripLeadingSlash(String path)

stripTrailingSlash

public static String stripTrailingSlash(String path)

getBackendMetaData

protected <T extends AbstractFilesystemBackendMetaData>
T getBackendMetaData(Class<T> outputClass,
 QBackendMetaData metaData)

Get the backend metaData, type-checked as the requested type.

getTableBackendDetails

protected <T extends AbstractFilesystemTableBackendDetails>
T getTableBackendDetails(Class<T> outputClass,
 QTableMetaData tableMetaData)

Get the backendDetails out of a table, type-checked as the requested type

lookupUniqueKey

public List<QRecord> lookupUniqueKey(UniqueKeyLookup.Input input)
                              throws QException

MANY-file readers need explicit matching; projected key contents may be heavy.

Throws:

QException

readAssociationValues

public List<QRecord> readAssociationValues(AssociatedRecordDiscovery.StoredValuesInput input)
                                    throws QException

Read only exact parent keys, retaining every declared relationship component.

Throws:

QException

findAssociatedPrimaryKeys

public List<Serializable> findAssociatedPrimaryKeys(AssociatedRecordDiscovery.Input input)
                                             throws QException

MANY-file reads return all rows, so apply relationship criteria explicitly.

Throws:

QException

executeQuery

public QueryOutput executeQuery(QueryInput queryInput)
                         throws QException

Generic implementation of the execute method from the QueryInterface

Throws:

QException

isPathEqualsCriteria

protected static boolean isPathEqualsCriteria(QFilterCriteria criteria)

executeCount

public CountOutput executeCount(CountInput countInput)
                         throws QException

Throws:

QException

addBackendDetailsToRecords

protected void addBackendDetailsToRecords(List<QRecord> recordsInFile,
 FILE file)

Add backend details to records about the file that they are in.

addBackendDetailsToRecord

protected void addBackendDetailsToRecord(QRecord record,
 FILE file)

Add backend details to a record about the file that it is in.

preAction

public void preAction(QBackendMetaData backendMetaData)
               throws QException

Method that subclasses can override to add pre-action things (e.g., setting up s3 client).

Throws:

QException

postAction

public void postAction()

Method that subclasses can override to add post-action things (e.g., closing resources)

executeInsert

protected InsertOutput executeInsert(InsertInput insertInput)
                              throws QException

Throws:

QException

executeDelete

protected DeleteOutput executeDelete(DeleteInput deleteInput)
                              throws QException

Throws:

QException