|
Nuxeo ECM Projects 5.4.3-SNAPSHOT | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.nuxeo.runtime.model.DefaultComponent org.nuxeo.ecm.platform.filemanager.service.FileManagerService
public class FileManagerService
FileManager registry service.
This is the component to request to perform transformations. See API.
Field Summary | |
---|---|
static String |
DEFAULT_FOLDER_TYPE_NAME
|
static int |
MAX
|
static ComponentName |
NAME
|
static String |
QUERY
|
Constructor Summary | |
---|---|
FileManagerService()
|
Method Summary | |
---|---|
String |
computeDigest(Blob blob)
|
DocumentModel |
createDocumentFromBlob(CoreSession documentManager,
Blob input,
String path,
boolean overwrite,
String fullName)
Returns an initialized doc based on a given blob. |
DocumentModel |
createFolder(CoreSession documentManager,
String fullname,
String path)
Creates a Folder. |
DocumentModel |
defaultCreateFolder(CoreSession documentManager,
String fullname,
String path)
|
DocumentModel |
defaultCreateFolder(CoreSession documentManager,
String fullname,
String path,
String containerTypeName,
boolean checkAllowedSubTypes)
|
List<DocumentLocation> |
findExistingDocumentWithFile(CoreSession documentManager,
String path,
String digest,
Principal principal)
|
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. |
DocumentModelList |
getCreationContainers(Principal 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. |
String |
getDigestAlgorithm()
|
List<String> |
getFields()
|
FileImporter |
getPluginByName(String name)
|
boolean |
isDigestComputingEnabled()
|
boolean |
isUnicityEnabled()
|
void |
registerExtension(Extension extension)
Registers the given extension. |
void |
unregisterExtension(Extension extension)
Unregisters the given extension. |
DocumentModel |
updateDocumentFromBlob(CoreSession documentManager,
Blob input,
String path,
String fullName)
Just applies the same actions as creation but does not changes the doc type. |
Methods inherited from class org.nuxeo.runtime.model.DefaultComponent |
---|
activate, applicationStarted, deactivate, getAdapter, registerContribution, unregisterContribution |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final ComponentName NAME
public static final String DEFAULT_FOLDER_TYPE_NAME
public static final String QUERY
public static final int MAX
Constructor Detail |
---|
public FileManagerService()
Method Detail |
---|
public DocumentModel createFolder(CoreSession documentManager, String fullname, String path) throws ClientException, IOException
FileManager
createFolder
in interface FileManager
fullname
- the full name of the folderpath
- the path were to create the folder
ClientException
IOException
public DocumentModel defaultCreateFolder(CoreSession documentManager, String fullname, String path) throws ClientException
ClientException
public DocumentModel defaultCreateFolder(CoreSession documentManager, String fullname, String path, String containerTypeName, boolean checkAllowedSubTypes) throws ClientException
ClientException
public DocumentModel createDocumentFromBlob(CoreSession documentManager, Blob input, String path, boolean overwrite, String fullName) throws IOException, ClientException
FileManager
createDocumentFromBlob
in interface FileManager
input
- the blob containing the content and the mime typepath
- the path were to create the documentoverwrite
- boolean how decide to overwrite or notfullName
- the fullname that contains the filename
IOException
ClientException
public DocumentModel updateDocumentFromBlob(CoreSession documentManager, Blob input, String path, String fullName) throws ClientException
FileManager
updateDocumentFromBlob
in interface FileManager
input
- the blob containing the content and the mime typepath
- the path to the file to updatefullName
- the full name that contains the filename
ClientException
public FileImporter getPluginByName(String name)
public void registerExtension(Extension extension) throws Exception
Extensible
registerExtension
in interface Extensible
registerExtension
in class DefaultComponent
extension
- the extension to register
Exception
- if any error occurspublic void unregisterExtension(Extension extension) throws Exception
Extensible
unregisterExtension
in interface Extensible
unregisterExtension
in class DefaultComponent
extension
- the extension to unregister
Exception
- if any error occurspublic String computeDigest(Blob blob) throws NoSuchAlgorithmException, IOException
computeDigest
in interface FileManager
NoSuchAlgorithmException
IOException
public List<DocumentLocation> findExistingDocumentWithFile(CoreSession documentManager, String path, String digest, Principal principal) throws ClientException
findExistingDocumentWithFile
in interface FileManager
ClientException
public boolean isUnicityEnabled()
isUnicityEnabled
in interface FileManager
public boolean isDigestComputingEnabled()
isDigestComputingEnabled
in interface FileManager
public List<String> getFields()
getFields
in interface FileManager
public DocumentModelList getCreationContainers(Principal principal, String docType) throws Exception
FileManager
getCreationContainers
in interface FileManager
Exception
public DocumentModelList getCreationContainers(CoreSession documentManager, String docType) throws Exception
FileManager
getCreationContainers
in interface FileManager
Exception
public String getDigestAlgorithm()
getDigestAlgorithm
in interface FileManager
|
Nuxeo ECM Projects 5.4.3-SNAPSHOT | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |