Package org.nuxeo.ecm.platform.filemanager.api

Interface FileManager

All Known Implementing Classes:
FileManagerService
public interface FileManager
File Manager.

File Manager to handle file

Author:
Andreas Kalogeropoulos

  • Method Details

    • createDocumentFromBlob

      @Deprecated DocumentModel createDocumentFromBlob(CoreSession documentManager, Blob input, String path, boolean overwrite, String fullName) throws IOException
      Deprecated.
      since 10.10. Use createOrUpdateDocument(FileImporterContext) instead.
      Returns an initialized doc based on a given blob.
      Parameters:
      input - the blob containing the content and the mime type
      path - the path were to create the document
      overwrite - whether to overwrite an existing file with the same title or not
      fullName - the fullname that contains the filename
      Returns:
      the created Document
      Throws:
      IOException

    • createDocumentFromBlob

      @Deprecated DocumentModel createDocumentFromBlob(CoreSession documentManager, Blob input, String path, boolean overwrite, String fullName, boolean noMimeTypeCheck) throws IOException
      Deprecated.
      since 10.10. Use createOrUpdateDocument(FileImporterContext) instead.
      Returns an initialized doc based on a given blob.
      Parameters:
      input - the blob containing the content and the mime type
      path - the path were to create the document
      overwrite - whether to overwrite an existing file with the same title or not
      fullName - the fullname that contains the filename
      noMimeTypeCheck - true if the blob's mime-type doesn't have to be checked against fullName
      Returns:
      the created Document
      Throws:
      IOException
      Since:
      8.10

    • createOrUpdateDocument

      DocumentModel createOrUpdateDocument(FileImporterContext context) throws IOException
      Returns a created or updated document based on the given context.

      The document may not be persisted according to FileImporterContext.isPersistDocument(). That's the caller's responsibility to actually persist the document.

      Note that file importers may not use FileImporterContext.isPersistDocument() and always persist the document.

      Returns:
      the created or updated document
      Throws:
      IOException
      Since:
      10.10
      See Also:

    • updateDocumentFromBlob

      @Deprecated DocumentModel updateDocumentFromBlob(CoreSession documentManager, Blob input, String path, String fullName)
      Deprecated.
      since 10.10. Not used.
      Just applies the same actions as creation but does not changes the doc type.
      Parameters:
      input - the blob containing the content and the mime type
      path - the path to the file to update
      fullName - the full name that contains the filename
      Returns:
      the updated Document

    • createFolder

      DocumentModel createFolder(CoreSession documentManager, String fullname, String path, boolean overwrite) throws IOException
      Creates a Folder.
      Parameters:
      fullname - the full name of the folder
      path - the path were to create the folder
      overwrite - whether to overwrite an existing folder with the same title or not
      Returns:
      the Folder Created
      Throws:
      IOException
      Since:
      9.1

    • getCreationContainers

      DocumentModelList getCreationContainers(NuxeoPrincipal principal, String docType)
      Returns the list of document that are to be suggested to principalName as a candidate container for a new document of type docType on all registered repositories.
      Returns:
      the list of candidate containers

    • getCreationContainers

      DocumentModelList getCreationContainers(CoreSession documentManager, String docType)
      Returns the list of document that are to be suggested to the principal of documentManager as a candidate container for a new document of type docType.
      Returns:
      the list of candidate containers

    • findExistingDocumentWithFile

      List<DocumentLocation> findExistingDocumentWithFile(CoreSession documentManager, String path, String digest, NuxeoPrincipal principal)

    • isUnicityEnabled

      boolean isUnicityEnabled()

    • getFields

      List<String> getFields()

    • getDigestAlgorithm

      String getDigestAlgorithm()

    • isDigestComputingEnabled

      boolean isDigestComputingEnabled()