Nuxeo 5

Nuxeo 5 Component
org.nuxeo.ecm.platform.filemanager.service.FileManagerService

Individual Documentation Coverage

done proportion
75.0 %


The FileManager service provide a generic service for building Documents
form a simple File.



Author: missing

Version: missing

Location: nuxeo-services/nuxeo-platform-filemanager-core/src/main/resources/OSGI-INF/nxfilemanager-service.xml

Require

No requirements

Required by

Not required

Implementation


Extension Points:

plugins


The plugin system for the FileManager give the possibility to register
extension that will be responsible for creating a document from a given
mime-type. The plugin should implement the
org.nuxeo.ecm.platform.filemanager.interfaces.FileImporter interface.

The registration of a file importer can be done like this:

        <plugin class="com.example.MyFileImporterImplementationClass" enabled="true" name="myCustomFileImporter" order="30">
          <filter>text/plain</filter>
        </plugin>



The filter tag is used to know what mime-types can be used with the
plugin. The order tag is used yo determine order between plugins.

A plugin can override an existing plugin by reusing the same name, in this
case the previous filters will be ignored. A plugin can be completely
disabled by setting enabled="false".

Similarly, to override the default behavior to import folders, custom
folder importers are registered as follows:

        <folderImporter class="com.example.MyFolderImporterImplementationClass" name="myCustomFolderImporter" />



The latest registered folder importer will be used in place of any other
previously registered folder importer.

Finally is it also possible to register CreationContainerListProvider
implementations for a given set of document types so as to provide the
user with a list of container suitable for new document creation.

This feature is especially useful for the creation of new document from an
office productivity application through the LiveEdit plugins.

The docType is optional: no docType declaration means all types are
handled by the extension.

        <creationContainerListProvider class="com.example.MyCustomContainerListImplementationClass" name="myCustomContainerListProvider">
          <docType>File</docType>
          <docType>Note</docType>
        </creationContainerListProvider>




unicity


The unicity extension point adds a digest to the given field using the
given algorithm. If the same file is already on the server, a new Message
is send to JMS bus with DocumentLocation if the existing files.

        <unicitySettings>
          <enabled>true</enabled>
          <algo>sha-256</algo>
          <field>file:content</field>
          <computeDigest>true</computeDigest>
        </unicitySettings>





Has contribution from:

Last generation: 15:23:17 CEST 04/08/2009