Class AbstractFilesystemAction

java.lang.Object

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

com.kingsrook.qqq.backend.module.filesystem.local.actions.AbstractFilesystemAction

Direct Known Subclasses:

FilesystemCountAction, FilesystemDeleteAction, FilesystemInsertAction, FilesystemQueryAction, FilesystemStorageAction

public class AbstractFilesystemAction
extends AbstractBaseFilesystemAction<File>

Base class for all (local) Filesystem actions

Field Summary

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

backendVariantRecord

Constructor Summary

Constructors

Constructor	Description
AbstractFilesystemAction()

Method Summary

Modifier and Type	Method	Description
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(File file)	get the createDate of the specified file, null if not supported/available
Instant	getFileModifyDate(File file)	get the createDate of the specified file, null if not supported/available
Long	getFileSize(File file)	get the size of the specified file, null if not supported/available
String	getFullPathForFile(File file)	Get a string that represents the full path to a file.
List<File>	listFiles(QTableMetaData table, QBackendMetaData backendBase, String requestedPath)	List the files for this table.
void	moveFile(QInstance instance, QTableMetaData table, String source, String destination)	Move a file from a source path, to a destination path.
InputStream	readFile(File file)	Read the contents of a file.
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 backend, 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, getBackendMetaData, getFullBasePath, getTableBackendDetails, isPathEqualsCriteria, listFiles, postAction, preAction, stripDuplicatedSlashes, stripLeadingSlash, stripTrailingSlash, writeFile

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractFilesystemAction

public AbstractFilesystemAction()

Method Details

getFileSize

public Long getFileSize(File file)

Description copied from class: AbstractBaseFilesystemAction

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

Specified by:

getFileSize in class AbstractBaseFilesystemAction<File>

getFileCreateDate

public Instant getFileCreateDate(File file)

Description copied from class: AbstractBaseFilesystemAction

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

Specified by:

getFileCreateDate in class AbstractBaseFilesystemAction<File>

getFileModifyDate

public Instant getFileModifyDate(File file)

Description copied from class: AbstractBaseFilesystemAction

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

Specified by:

getFileModifyDate in class AbstractBaseFilesystemAction<File>

listFiles

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

List the files for this table.

Specified by:

listFiles in class AbstractBaseFilesystemAction<File>

Throws:

QException

readFile

public InputStream readFile(File file)
                     throws IOException

Read the contents of a file.

Specified by:

readFile in class AbstractBaseFilesystemAction<File>

Throws:

IOException

writeFile

public void writeFile(QBackendMetaData backend,
 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<File>

Throws:

IOException

getFullPathForFile

public String getFullPathForFile(File file)

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

Specified by:

getFullPathForFile in class AbstractBaseFilesystemAction<File>

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<File>

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

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

Specified by:

moveFile in class AbstractBaseFilesystemAction<File>

Parameters:

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

Throws:

FilesystemException - if the delete 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.

Overrides:

stripBackendAndTableBasePathsFromFileName in class AbstractBaseFilesystemAction<File>