Interface DefaultImporterService

All Known Implementing Classes:
DefaultImporterServiceImpl

public interface DefaultImporterService
Allows basic configuration of the default importer :

Allows configuration of the a DocumentModelFactory and the document types it creates ( if no implementation is contributed, DefaultDocumentModelFactory is used;

Also allows configuration of the SourceNode implementation; if none is provided the FileSourceNode it's used by default

  • Method Summary

    Modifier and Type
    Method
    Description
    Deprecated.
    boolean
    Gets the enablePerfLogging value used by the GenericMultiThreadImporter.
    Class<? extends SourceNode>
    Deprecated.
    void
    importDocuments(String destionationPath, String sourcePath, boolean skipRootContainerCreation, int batchSize, int noImportingThreads)
    Imports documents using a DefaultImporterExecutor and the contributed documentModelFactory and SourceNode implementations; If no documentModelFactory implementation was contributed to the service, DefaultDocumentModelFactory it's used If no SourceNode implementation was contributed to the service, FileSourceNode it's used
    importDocuments(AbstractImporterExecutor executor, String destinationPath, String sourcePath, boolean skipRootContainerCreation, int batchSize, int noImportingThreads, boolean interactive)
    Imports documents using a the given executor and the contributed documentModelFactory and SourceNode implementations; If no documentModelFactory implementation was contributed to the service, DefaultDocumentModelFactory it's used If no SourceNode implementation was contributed to the service, FileSourceNode it's used
    importDocuments(AbstractImporterExecutor executor, String leafType, String folderishType, String destinationPath, String sourcePath, boolean skipRootContainerCreation, int batchSize, int noImportingThreads, boolean interactive)
    Imports documents using a the given executor and the contributed documentModelFactory and SourceNode implementations; Allows to overwrite the leaf and folderish types used by the documentModelFactory when importing; if one of them is not specified then the contributed one is used If no documentModelFactory implementation was contributed to the service, DefaultDocumentModelFactory it's used If no SourceNode implementation was contributed to the service, FileSourceNode it's used
    void
    setBulkMode(boolean bulkMode)
    Sets the bulk mode for the importer.
    void
     
    void
    setEnablePerfLogging(boolean enablePerfLogging)
    Sets whether or not the GenericMultiThreadedImporter should log performance metrics
    void
    setFolderishDocType(String folderishDocType)
     
    void
     
    void
    setLeafDocType(String fileDocType)
     
    void
    setRepository(String repositoryName)
     
    void
    setSourceNodeClass(Class<? extends SourceNode> sourceNodeClass)
     
    void
    setTransactionTimeout(int transactionTimeout)
     
  • Method Details

    • importDocuments

      void importDocuments(String destionationPath, String sourcePath, boolean skipRootContainerCreation, int batchSize, int noImportingThreads)
      Imports documents using a DefaultImporterExecutor and the contributed documentModelFactory and SourceNode implementations; If no documentModelFactory implementation was contributed to the service, DefaultDocumentModelFactory it's used If no SourceNode implementation was contributed to the service, FileSourceNode it's used
    • importDocuments

      String importDocuments(AbstractImporterExecutor executor, String destinationPath, String sourcePath, boolean skipRootContainerCreation, int batchSize, int noImportingThreads, boolean interactive)
      Imports documents using a the given executor and the contributed documentModelFactory and SourceNode implementations; If no documentModelFactory implementation was contributed to the service, DefaultDocumentModelFactory it's used If no SourceNode implementation was contributed to the service, FileSourceNode it's used
    • importDocuments

      String importDocuments(AbstractImporterExecutor executor, String leafType, String folderishType, String destinationPath, String sourcePath, boolean skipRootContainerCreation, int batchSize, int noImportingThreads, boolean interactive)
      Imports documents using a the given executor and the contributed documentModelFactory and SourceNode implementations; Allows to overwrite the leaf and folderish types used by the documentModelFactory when importing; if one of them is not specified then the contributed one is used If no documentModelFactory implementation was contributed to the service, DefaultDocumentModelFactory it's used If no SourceNode implementation was contributed to the service, FileSourceNode it's used
    • setSourceNodeClass

      void setSourceNodeClass(Class<? extends SourceNode> sourceNodeClass)
    • setDocModelFactoryClass

      void setDocModelFactoryClass(Class<? extends ImporterDocumentModelFactory> docModelFactoryClass)
    • setLeafDocType

      void setLeafDocType(String fileDocType)
    • setFolderishDocType

      void setFolderishDocType(String folderishDocType)
    • setImporterLogger

      void setImporterLogger(ImporterLogger importerLogger)
    • setTransactionTimeout

      void setTransactionTimeout(int transactionTimeout)
      Since:
      5.9.4
    • setRepository

      void setRepository(String repositoryName)
      Since:
      7.1
    • getSourceNodeClass

      @Deprecated Class<? extends SourceNode> getSourceNodeClass()
      Deprecated.
      Added waiting the importer refactoring. Only used by Scan Importer.
      Since:
      5.7.3
    • getDocModelFactoryClass

      @Deprecated Class<? extends ImporterDocumentModelFactory> getDocModelFactoryClass()
      Deprecated.
      Added waiting the importer refactoring. Only used by Scan Importer.
      Since:
      5.7.3
    • setBulkMode

      void setBulkMode(boolean bulkMode)
      Sets the bulk mode for the importer.
      Parameters:
      bulkMode - true to enable bulk mode (default), or false to disable it
      Since:
      8.3
    • setEnablePerfLogging

      void setEnablePerfLogging(boolean enablePerfLogging)
      Sets whether or not the GenericMultiThreadedImporter should log performance metrics
      Since:
      9.3
    • getEnablePerfLogging

      boolean getEnablePerfLogging()
      Gets the enablePerfLogging value used by the GenericMultiThreadImporter. Only used by Scan Importer and JAXRS Importer.
      Since:
      9.3