Class AbstractSFTPAction

java.lang.Object

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

com.kingsrook.qqq.backend.module.filesystem.sftp.actions.AbstractSFTPAction

Direct Known Subclasses:

SFTPCountAction, SFTPDeleteAction, SFTPInsertAction, SFTPQueryAction, SFTPStorageAction, SFTPTestConnectionAction

public class AbstractSFTPAction
extends AbstractBaseFilesystemAction<SFTPDirEntryWithPath>

Base class for all SFTP filesystem actions

Field Summary

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

backendVariantRecord

Constructor Summary

Constructors

Constructor	Description
AbstractSFTPAction()

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(SFTPDirEntryWithPath sftpDirEntryWithPath)	get the createDate of the specified file, null if not supported/available
Instant	getFileModifyDate(SFTPDirEntryWithPath sftpDirEntryWithPath)	get the createDate of the specified file, null if not supported/available
Long	getFileSize(SFTPDirEntryWithPath sftpDirEntryWithPath)	get the size of the specified file, null if not supported/available
String	getFullPathForFile(SFTPDirEntryWithPath dirEntry)	Get a string that represents the full path to a file.
protected org.apache.sshd.sftp.client.SftpClient	getSftpClient(QBackendMetaData backend)
List<SFTPDirEntryWithPath>	listFiles(QTableMetaData table, QBackendMetaData backendBase, String requestedPath)	List the files for a table - or optionally, just a single file name - to be implemented in module-specific subclasses.
protected org.apache.sshd.sftp.client.SftpClient	makeConnection(String username, String hostName, Integer port, String password, byte[] privateKeyBytes)
void	moveFile(QInstance instance, QTableMetaData table, String source, String destination)	Move a file from a source path, to a destination path.
static byte[]	pemStringToDecodedBytes(String pemString)	take a string, which is the contents of a PEM file (like a private key) - and if it has the -----BEGIN...----- and -----END...---- lines, strip them away, and strip away any whitespace, and then base-64 decode it.
void	postAction()	Method that subclasses can override to add post-action things (e.g., closing resources)
void	preAction(QBackendMetaData backendMetaData)	Set up the sftp utils object to be used for this action.
InputStream	readFile(SFTPDirEntryWithPath dirEntry)	Read the contents of a file - to be implemented in module-specific subclasses.
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, stripBackendAndTableBasePathsFromFileName, stripDuplicatedSlashes, stripLeadingSlash, stripTrailingSlash, writeFile

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractSFTPAction

public AbstractSFTPAction()

Method Details

preAction

public void preAction(QBackendMetaData backendMetaData)
               throws QException

Set up the sftp utils object to be used for this action.

Overrides:

preAction in class AbstractBaseFilesystemAction<SFTPDirEntryWithPath>

Throws:

QException

postAction

public void postAction()

Description copied from class: AbstractBaseFilesystemAction

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

Overrides:

postAction in class AbstractBaseFilesystemAction<SFTPDirEntryWithPath>

makeConnection

protected org.apache.sshd.sftp.client.SftpClient makeConnection(String username,
 String hostName,
 Integer port,
 String password,
 byte[] privateKeyBytes)
                                                         throws Exception

Throws:

Exception

getFileSize

public Long getFileSize(SFTPDirEntryWithPath sftpDirEntryWithPath)

Description copied from class: AbstractBaseFilesystemAction

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

Specified by:

getFileSize in class AbstractBaseFilesystemAction<SFTPDirEntryWithPath>

getFileCreateDate

public Instant getFileCreateDate(SFTPDirEntryWithPath sftpDirEntryWithPath)

Description copied from class: AbstractBaseFilesystemAction

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

Specified by:

getFileCreateDate in class AbstractBaseFilesystemAction<SFTPDirEntryWithPath>

getFileModifyDate

public Instant getFileModifyDate(SFTPDirEntryWithPath sftpDirEntryWithPath)

Description copied from class: AbstractBaseFilesystemAction

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

Specified by:

getFileModifyDate in class AbstractBaseFilesystemAction<SFTPDirEntryWithPath>

listFiles

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

Description copied from class: AbstractBaseFilesystemAction

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

Specified by:

listFiles in class AbstractBaseFilesystemAction<SFTPDirEntryWithPath>

Throws:

QException

readFile

public InputStream readFile(SFTPDirEntryWithPath dirEntry)
                     throws IOException

Description copied from class: AbstractBaseFilesystemAction

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

Specified by:

readFile in class AbstractBaseFilesystemAction<SFTPDirEntryWithPath>

Throws:

IOException

writeFile

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

Description copied from class: AbstractBaseFilesystemAction

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

Specified by:

writeFile in class AbstractBaseFilesystemAction<SFTPDirEntryWithPath>

Throws:

IOException

getFullPathForFile

public String getFullPathForFile(SFTPDirEntryWithPath dirEntry)

Description copied from class: AbstractBaseFilesystemAction

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

Specified by:

getFullPathForFile in class AbstractBaseFilesystemAction<SFTPDirEntryWithPath>

deleteFile

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

Description copied from class: AbstractBaseFilesystemAction

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

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

Description copied from class: AbstractBaseFilesystemAction

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

Specified by:

moveFile in class AbstractBaseFilesystemAction<SFTPDirEntryWithPath>

Throws:

FilesystemException - if the move is known to have failed

getSftpClient

protected org.apache.sshd.sftp.client.SftpClient getSftpClient(QBackendMetaData backend)
                                                        throws QException

Throws:

QException

pemStringToDecodedBytes

public static byte[] pemStringToDecodedBytes(String pemString)

take a string, which is the contents of a PEM file (like a private key) - and if it has the -----BEGIN...----- and -----END...---- lines, strip them away, and strip away any whitespace, and then base-64 decode it.