org.nuxeo.ecm.platform.filemanager.api
Interface FileManager

All Known Subinterfaces:

FileManagerLocal

All Known Implementing Classes:

FileManagerBean, FileManagerService

public interface FileManager

File Manager.

File Manager to handle file

Author:

Andreas Kalogeropoulos

Method Summary

java.lang.String	computeDigest(Blob blob)
DocumentModel	createDocumentFromBlob(CoreSession documentManager, Blob input, java.lang.String path, boolean overwrite, java.lang.String fullName) Returns an initialized doc based on a given blob.
DocumentModel	createFolder(CoreSession documentManager, java.lang.String fullname, java.lang.String path) Creates a Folder.
java.util.List<DocumentLocation>	findExistingDocumentWithFile(CoreSession documentManager, java.lang.String path, java.lang.String digest, java.security.Principal principal)
DocumentModelList	getCreationContainers(CoreSession documentManager, java.lang.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.
DocumentModelList	getCreationContainers(java.security.Principal principal, java.lang.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.
java.lang.String	getDigestAlgorithm()
java.util.List<java.lang.String>	getFields()
boolean	isDigestComputingEnabled()
boolean	isUnicityEnabled()
DocumentModel	updateDocumentFromBlob(CoreSession documentManager, Blob input, java.lang.String path, java.lang.String fullName) Just applies the same actions as creation but does not changes the doc type.

Method Detail

createDocumentFromBlob

DocumentModel createDocumentFromBlob(CoreSession documentManager,
                                     Blob input,
                                     java.lang.String path,
                                     boolean overwrite,
                                     java.lang.String fullName)
                                     throws java.lang.Exception

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 - boolean how decide to overwrite or not

fullName - the fullname that contains the filename

Returns:

the created Document

Throws:

java.lang.Exception

updateDocumentFromBlob

DocumentModel updateDocumentFromBlob(CoreSession documentManager,
                                     Blob input,
                                     java.lang.String path,
                                     java.lang.String fullName)
                                     throws java.lang.Exception

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

Throws:

java.lang.Exception

createFolder

DocumentModel createFolder(CoreSession documentManager,
                           java.lang.String fullname,
                           java.lang.String path)
                           throws java.lang.Exception

Creates a Folder.

Parameters:

fullname - the full name of the folder

path - the path were to create the folder

Returns:

the Folder Created

Throws:

java.lang.Exception

getCreationContainers

DocumentModelList getCreationContainers(java.security.Principal principal,
                                        java.lang.String docType)
                                        throws java.lang.Exception

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

Throws:

java.lang.Exception

getCreationContainers

DocumentModelList getCreationContainers(CoreSession documentManager,
                                        java.lang.String docType)
                                        throws java.lang.Exception

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

Throws:

java.lang.Exception

computeDigest

java.lang.String computeDigest(Blob blob)
                               throws ClientException,
                                      java.security.NoSuchAlgorithmException,
                                      java.io.IOException

Throws:

ClientException

java.security.NoSuchAlgorithmException

java.io.IOException

findExistingDocumentWithFile

java.util.List<DocumentLocation> findExistingDocumentWithFile(CoreSession documentManager,
                                                              java.lang.String path,
                                                              java.lang.String digest,
                                                              java.security.Principal principal)
                                                              throws ClientException

Throws:

ClientException

isUnicityEnabled

boolean isUnicityEnabled()
                         throws ClientException

Throws:

ClientException

getFields

java.util.List<java.lang.String> getFields()
                                           throws ClientException

Throws:

ClientException

getDigestAlgorithm

java.lang.String getDigestAlgorithm()

isDigestComputingEnabled

boolean isDigestComputingEnabled()