org.nuxeo.ecm.platform.filemanager.service

Class FileManagerService

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.ecm.platform.filemanager.service.FileManagerService

All Implemented Interfaces:

FileManager, Adaptable, Component, Extensible, TimestampedService

public class FileManagerService
extends DefaultComponent
implements FileManager

FileManager registry service.

This is the component to request to perform transformations. See API.

Author:

Andreas Kalogeropoulos

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEF_VERSIONING_AFTER_ADD
static VersioningOption	DEF_VERSIONING_OPTION
static String	DEFAULT_FOLDER_TYPE_NAME
static int	MAX
static ComponentName	NAME
static String	QUERY

Fields inherited from class org.nuxeo.runtime.model.DefaultComponent

lastModified

Constructor Summary

Constructors

Constructor and Description
FileManagerService()

Method Summary

Modifier and Type	Method and Description
DocumentModel	createDocumentFromBlob(CoreSession documentManager, Blob input, String path, boolean overwrite, String fullName) Returns an initialized doc based on a given blob.
DocumentModel	createDocumentFromBlob(CoreSession documentManager, Blob input, String path, boolean overwrite, String fullName, boolean noMimeTypeCheck) Returns an initialized doc based on a given blob.
DocumentModel	createFolder(CoreSession documentManager, String fullname, String path, boolean overwrite) Creates a Folder.
DocumentModel	defaultCreateFolder(CoreSession documentManager, String fullname, String path) Deprecated. since 9.1, use defaultCreateFolder(CoreSession, String, String, boolean) instead
DocumentModel	defaultCreateFolder(CoreSession documentManager, String fullname, String path, boolean overwrite)
DocumentModel	defaultCreateFolder(CoreSession documentManager, String fullname, String path, String containerTypeName, boolean checkAllowedSubTypes) Deprecated. since 9.1, use defaultCreateFolder(CoreSession, String, String, String, boolean, boolean) instead
DocumentModel	defaultCreateFolder(CoreSession documentManager, String fullname, String path, String containerTypeName, boolean checkAllowedSubTypes, boolean overwrite)
boolean	doVersioningAfterAdd() Deprecated. since 9.1 automatic versioning is now handled at versioning service level, remove versioning behaviors from importers
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)
VersioningOption	getVersioningOption() Deprecated. since 9.1 automatic versioning is now handled at versioning service level, remove versioning behaviors from importers
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, deactivate, getAdapter, getLastModified, registerContribution, setLastModified, setModifiedNow, start, stop, unregisterContribution

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.nuxeo.ecm.platform.filemanager.api.FileManager

createFolder

Methods inherited from interface org.nuxeo.runtime.model.Component

applicationStarted, getApplicationStartedOrder

Field Detail

NAME

public static final ComponentName NAME

DEFAULT_FOLDER_TYPE_NAME

public static final String DEFAULT_FOLDER_TYPE_NAME

See Also:

Constant Field Values

QUERY

public static final String QUERY

See Also:

Constant Field Values

MAX

public static final int MAX

See Also:

Constant Field Values

DEF_VERSIONING_OPTION

public static final VersioningOption DEF_VERSIONING_OPTION

DEF_VERSIONING_AFTER_ADD

public static final boolean DEF_VERSIONING_AFTER_ADD

See Also:

Constant Field Values

Constructor Detail

FileManagerService

public FileManagerService()

Method Detail

createFolder

public DocumentModel createFolder(CoreSession documentManager,
                                  String fullname,
                                  String path,
                                  boolean overwrite)
                           throws IOException

Description copied from interface: FileManager

Creates a Folder.

Specified by:

createFolder in interface FileManager

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

defaultCreateFolder

@Deprecated
public DocumentModel defaultCreateFolder(CoreSession documentManager,
                                                     String fullname,
                                                     String path)

Deprecated. since 9.1, use defaultCreateFolder(CoreSession, String, String, boolean) instead

defaultCreateFolder

public DocumentModel defaultCreateFolder(CoreSession documentManager,
                                         String fullname,
                                         String path,
                                         boolean overwrite)

Since:

9.1

defaultCreateFolder

@Deprecated
public DocumentModel defaultCreateFolder(CoreSession documentManager,
                                                     String fullname,
                                                     String path,
                                                     String containerTypeName,
                                                     boolean checkAllowedSubTypes)

Deprecated. since 9.1, use defaultCreateFolder(CoreSession, String, String, String, boolean, boolean) instead

defaultCreateFolder

public DocumentModel defaultCreateFolder(CoreSession documentManager,
                                         String fullname,
                                         String path,
                                         String containerTypeName,
                                         boolean checkAllowedSubTypes,
                                         boolean overwrite)

Since:

9.1

createDocumentFromBlob

public DocumentModel createDocumentFromBlob(CoreSession documentManager,
                                            Blob input,
                                            String path,
                                            boolean overwrite,
                                            String fullName)
                                     throws IOException

Description copied from interface: FileManager

Returns an initialized doc based on a given blob.

Specified by:

createDocumentFromBlob in interface FileManager

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

public DocumentModel createDocumentFromBlob(CoreSession documentManager,
                                            Blob input,
                                            String path,
                                            boolean overwrite,
                                            String fullName,
                                            boolean noMimeTypeCheck)
                                     throws IOException

Description copied from interface: FileManager

Returns an initialized doc based on a given blob.

Specified by:

createDocumentFromBlob in interface FileManager

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

updateDocumentFromBlob

public DocumentModel updateDocumentFromBlob(CoreSession documentManager,
                                            Blob input,
                                            String path,
                                            String fullName)

Description copied from interface: FileManager

Just applies the same actions as creation but does not changes the doc type.

Specified by:

updateDocumentFromBlob in interface FileManager

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

getPluginByName

public FileImporter getPluginByName(String name)

registerExtension

public void registerExtension(Extension extension)

Description copied from interface: Extensible

Registers the given extension.

Specified by:

registerExtension in interface Extensible

Overrides:

registerExtension in class DefaultComponent

Parameters:

extension - the extension to register

unregisterExtension

public void unregisterExtension(Extension extension)

Description copied from interface: Extensible

Unregisters the given extension.

Specified by:

unregisterExtension in interface Extensible

Overrides:

unregisterExtension in class DefaultComponent

Parameters:

extension - the extension to unregister

findExistingDocumentWithFile

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

Specified by:

findExistingDocumentWithFile in interface FileManager

isUnicityEnabled

public boolean isUnicityEnabled()

Specified by:

isUnicityEnabled in interface FileManager

isDigestComputingEnabled

public boolean isDigestComputingEnabled()

Specified by:

isDigestComputingEnabled in interface FileManager

getFields

public List<String> getFields()

Specified by:

getFields in interface FileManager

getCreationContainers

public DocumentModelList getCreationContainers(Principal principal,
                                               String docType)

Description copied from interface: FileManager

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.

Specified by:

getCreationContainers in interface FileManager

Returns:

the list of candidate containers

getCreationContainers

public DocumentModelList getCreationContainers(CoreSession documentManager,
                                               String docType)

Description copied from interface: FileManager

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.

Specified by:

getCreationContainers in interface FileManager

Returns:

the list of candidate containers

getDigestAlgorithm

public String getDigestAlgorithm()

Specified by:

getDigestAlgorithm in interface FileManager

getVersioningOption

@Deprecated
public VersioningOption getVersioningOption()

Deprecated. since 9.1 automatic versioning is now handled at versioning service level, remove versioning behaviors from importers

Description copied from interface: FileManager

Gets the versioning applied on an overwritten document before it is overwritten.

Specified by:

getVersioningOption in interface FileManager

doVersioningAfterAdd

@Deprecated
public boolean doVersioningAfterAdd()

Deprecated. since 9.1 automatic versioning is now handled at versioning service level, remove versioning behaviors from importers

Description copied from interface: FileManager

Checks whether versioning should also be applied after a document is added.

Specified by:

doVersioningAfterAdd in interface FileManager