org.nuxeo.ecm.platform.replication.importer

Interface DocumentaryBaseImporterService

All Known Implementing Classes:

DocumentaryBaseImpServiceImpl

public interface DocumentaryBaseImporterService

The service which imports the documentary base. The system replication is made inside a single directory named “Replication Root”. Under it, “Documentary Base” contains the documents. Under it, the “Usual documents” contains the repository exported muck likely the export utility. The file names are the names of the documents. The path of Nuxeo documents is unique, so it can be used without worrying of duplicates. We can find the usual documents exported, with blobs, with workflow state (inside the document folder a file named “workflow.export”). The JBPM workflow state of the document is stored (lifecycle state is already saved in the document export) although for the moment it is not of much use. But if required it can be imagined a procedure to update the workflow state when importing based on customer's particularities. And also a third new file named “import.export” containing the contextual metadata required for core import.

Under “Documentary Base” the “Versions” folder contains the checked in versions. The versions are exported as the usual documents with single difference: without ACL and workflows.

Under “Documentary Base” the “Proxies” folder contains the proxies. They are exported as the usual documents with single difference: without workflows. The importer is reading the files and acts multi-threaded in 2 steps: first it "core imports" the documents and after it updates the properties.

Author:

rux

Method Summary

Methods

Modifier and Type	Method and Description
void	importDocuments(Map<String,Serializable> parameter, File path, boolean resume, boolean exportVersions, boolean exportProxies, boolean useMultiThread, boolean asynchronous) Imports the documentary base.
void	setListener(StatusListener listener) Sets the listener that will informs about the import process status.
void	setTypeSelector(DocumentTypeSelector typeSelector) Sets the acceptor of the documents before import.
void	setXmlTransformer(DocumentXmlTransformer xmlTransformer) Sets the transformer for exported document.
void	stop() Stops the process of import.

Method Detail

importDocuments

void importDocuments(Map<String,Serializable> parameter,
                   File path,
                   boolean resume,
                   boolean exportVersions,
                   boolean exportProxies,
                   boolean useMultiThread,
                   boolean asynchronous)
                     throws ClientException

Imports the documentary base.

Parameters:

parameter -

path - the path to root directory of replication

resume -

exportVersions -

exportProxies -

useMultiThread -

asynchronous - start the service asynchronous

Throws:

ClientException

stop

void stop()

Stops the process of import.

setListener

void setListener(StatusListener listener)

Sets the listener that will informs about the import process status.

Parameters:

listener -

setXmlTransformer

void setXmlTransformer(DocumentXmlTransformer xmlTransformer)

Sets the transformer for exported document.

Parameters:

xmlTransformer -

setTypeSelector

void setTypeSelector(DocumentTypeSelector typeSelector)

Sets the acceptor of the documents before import.