Package com.logicaldoc.importfolder.smb

Class SMBHelper

  • public class SMBHelper
extends CrawlerHelper
    Helper for SMB shares(it uses jCIFS and can work with SMB1 or SMB2).
    Since:
    4.5
    Author:
    Marco Meschieri - LogicalDOC

    • Constructor Detail

      • SMBHelper

        public SMBHelper​(ImportFolder importFolder)

    • 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

      • downloadFile

        public static File downloadFile​(jcifs.smb.SmbFile f)
                         throws Exception
        Downloads a remote file into a local copy
        Parameters:
        f - the remote file
        Returns:
        The local file copy
        Throws:
        Exception - a generic error happened

      • 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

      • getFile

        public jcifs.smb.SmbFile 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

      • 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

      • getSmbContext

        public static jcifs.CIFSContext getSmbContext​(ImportFolder importFolder)

      • 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