Package com.logicaldoc.importfolder.sftp

Class SFTPHelper

java.lang.Object

com.logicaldoc.importfolder.CrawlerHelper

com.logicaldoc.importfolder.sftp.SFTPHelper

public class SFTPHelper
extends CrawlerHelper

Helper for SFTP folders

Since:

8.0

Author:

Marco Meschieri - LogicalDOC

Constructor Summary

Constructors

Constructor	Description
SFTPHelper(ImportFolder importFolder)

Method Summary

Modifier and Type	Method	Description
void	checkinFile(Object file, long docId, com.logicaldoc.core.security.User owner)	Imports a remote file into an existing document producing a new version
boolean	deleteFile(Object file)	Delete the given referenced file after document import.
File	getContentFile(String path)	Retrieves a file that contains the content referenced by path
Date	getCreationDate(Object file)	Computes remote file creation date
Object	getFile(String path)	Gets the object representation of the given path
Date	getLastModified(Object file)	Computes remote file last modification time
String	getName(Object file)	Computes the name of the remote file
String	getPath(Object file)	Computes the path of the remote file
int	importDocumentsCount()	The documents, referenced by a index file, that should be imported.
com.logicaldoc.core.document.Document	importFile(Object file, com.logicaldoc.core.folder.Folder folder, com.logicaldoc.core.security.User owner, boolean timestamp)	Imports a remote file
void	importUsingIndex(ImportFolderCrawler crawler)	Imports documents referenced by a index file
void	list(Object parent, int depth, List<Object> folders, List<Object> files, long max, ImportFolderCache cache)	Lists all files in a remote folder
boolean	testConnection()	Tests if the import folder can be accessed

Methods inherited from class com.logicaldoc.importfolder.CrawlerHelper

getInstance, toBeImported

Methods inherited from class java.lang.Object

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

Constructor Detail

SFTPHelper

public SFTPHelper(ImportFolder importFolder)
           throws com.logicaldoc.core.PersistenceException

Throws:

com.logicaldoc.core.PersistenceException

Method Detail

checkinFile

public void checkinFile(Object file,
                        long docId,
                        com.logicaldoc.core.security.User owner)
                 throws Exception

Description copied from class: CrawlerHelper

Imports a remote file into an existing document producing a new version

Specified by:

checkinFile in class CrawlerHelper

Parameters:

file - The file to be loaded

docId - The document identifier

owner - The owner user

Throws:

Exception - a generic error happened

importFile

public com.logicaldoc.core.document.Document importFile(Object file,
                                                        com.logicaldoc.core.folder.Folder folder,
                                                        com.logicaldoc.core.security.User owner,
                                                        boolean timestamp)
                                                 throws Exception

Description copied from class: CrawlerHelper

Imports a remote file

Specified by:

importFile in class CrawlerHelper

Parameters:

file - The file to be loaded

folder - The target folder

owner - The owner user

timestamp - If the timestamp has to be included in filename and title

Returns:

The newly created document

Throws:

Exception - a generic error happened

list

public void list(Object parent,
                 int depth,
                 List<Object> folders,
                 List<Object> files,
                 long max,
                 ImportFolderCache cache)
          throws Exception

Description copied from class: CrawlerHelper

Lists all files in a remote folder

Specified by:

list in class CrawlerHelper

Parameters:

parent - The parent directory

depth - The maximum depth

folders - The list that will contain all allowed folders

files - The list that will contain all allowed files

max - The maximum number of elements in files

cache - Cache of imported documents

Throws:

Exception - a generic error happened

getName

public String getName(Object file)
               throws Exception

Description copied from class: CrawlerHelper

Computes the name of the remote file

Specified by:

getName in class CrawlerHelper

Parameters:

file - The file to be considered

Returns:

The name

Throws:

Exception - a generic error happened

getPath

public String getPath(Object file)
               throws Exception

Description copied from class: CrawlerHelper

Computes the path of the remote file

Specified by:

getPath in class CrawlerHelper

Parameters:

file - The file to be considered

Returns:

The path

Throws:

Exception - a generic error happened

getLastModified

public Date getLastModified(Object file)

Description copied from class: CrawlerHelper

Computes remote file last modification time

Specified by:

getLastModified in class CrawlerHelper

Parameters:

file - The file to be considered

Returns:

The last modification time

getCreationDate

public Date getCreationDate(Object file)

Description copied from class: CrawlerHelper

Computes remote file creation date

Specified by:

getCreationDate in class CrawlerHelper

Parameters:

file - The file to be considered

Returns:

The creation date

importUsingIndex

public void importUsingIndex(ImportFolderCrawler crawler)
                      throws Exception

Description copied from class: CrawlerHelper

Imports documents referenced by a index file

Specified by:

importUsingIndex in class CrawlerHelper

Parameters:

crawler - The current ImportFolderCrawler task

Throws:

Exception - a generic error happened

importDocumentsCount

public int importDocumentsCount()
                         throws Exception

Description copied from class: CrawlerHelper

The documents, referenced by a index file, that should be imported. It returns -1 in case there is not index file

Specified by:

importDocumentsCount in class CrawlerHelper

Returns:

number of documents references inside the index file

Throws:

Exception - a generic error happened

deleteFile

public boolean deleteFile(Object file)

Description copied from class: CrawlerHelper

Delete the given referenced file after document import.

Specified by:

deleteFile in class CrawlerHelper

Parameters:

file - The file that must be deleted

Returns:

if the file has been successfully deleted

testConnection

public boolean testConnection()

Description copied from class: CrawlerHelper

Tests if the import folder can be accessed

Specified by:

testConnection in class CrawlerHelper

Returns:

true if the import folder is accessible

getFile

public Object getFile(String path)

Description copied from class: CrawlerHelper

Gets the object representation of the given path

Specified by:

getFile in class CrawlerHelper

Parameters:

path - the full path of a remote file

Returns:

the remote file at the specified path

getContentFile

public File getContentFile(String path)

Description copied from class: CrawlerHelper

Retrieves a file that contains the content referenced by path

Specified by:

getContentFile in class CrawlerHelper

Parameters:

path - the full path of a remote file

Returns:

a local file containing the remote file's content