org.nuxeo.ecm.platform.sync.client

Class SynchronizeServiceImpl

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.ecm.platform.sync.client.SynchronizeServiceImpl

All Implemented Interfaces:

SynchronizeService, Adaptable, Component, Extensible, TimestampedService

public class SynchronizeServiceImpl
extends DefaultComponent
implements SynchronizeService

The Synchronize Service implementation.

Author:

rux

Constructor Summary

Constructors

Constructor and Description
SynchronizeServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
SynchronizeDetails	getDefaultDetails() Return the pre-configured connection parameters
ImportConfiguration	getImportConfiguration()
void	registerContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
boolean	shouldDisableReadSP(String docPath, String permission) Test if the ReadSecurityPolicy should be disabled or not.
SynchronizeReport	synchronize(CoreSession session, SynchronizeDetails details, String queryName) Performs the whole synchronization process including the documents relations and vocabularies synchronizations.
SynchronizeReport	synchronizeDocuments(CoreSession session, SynchronizeDetails details, String queryName) Synchronizes all the documents by using the synchronization details.
SynchronizeReport	synchronizeRelations(SynchronizeDetails details) Synchronizes all the relations defined on the documents by using the synchronization details.This should happen after the documents synchronization.
SynchronizeReport	synchronizeVocabularies(SynchronizeDetails details) Synchronizes all the vocabularies by using the synchronization details.This should happen after the documents synchronization.

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

activate, applicationStarted, deactivate, getAdapter, getApplicationStartedOrder, getLastModified, registerExtension, setLastModified, unregisterContribution, unregisterExtension

Methods inherited from class java.lang.Object

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

Constructor Detail

SynchronizeServiceImpl

public SynchronizeServiceImpl()

Method Detail

registerContribution

public void registerContribution(Object contribution,
                        String extensionPoint,
                        ComponentInstance contributor)
                          throws Exception

Overrides:

registerContribution in class DefaultComponent

Throws:

Exception

synchronizeDocuments

public SynchronizeReport synchronizeDocuments(CoreSession session,
                                     SynchronizeDetails details,
                                     String queryName)
                                       throws Exception

Description copied from interface: SynchronizeService

Synchronizes all the documents by using the synchronization details.

Specified by:

synchronizeDocuments in interface SynchronizeService

Parameters:

session - - the Nuxeo core session received from the web context

details - - the details about the synchronization process

queryName - - the query name to use server side

Throws:

ClientException

Exception

synchronizeRelations

public SynchronizeReport synchronizeRelations(SynchronizeDetails details)
                                       throws ClientException

Description copied from interface: SynchronizeService

Synchronizes all the relations defined on the documents by using the synchronization details.This should happen after the documents synchronization.

Specified by:

synchronizeRelations in interface SynchronizeService

Parameters:

details - - the details about the synchronization process

Throws:

ClientException

synchronizeVocabularies

public SynchronizeReport synchronizeVocabularies(SynchronizeDetails details)
                                          throws ClientException

Description copied from interface: SynchronizeService

Synchronizes all the vocabularies by using the synchronization details.This should happen after the documents synchronization.

Specified by:

synchronizeVocabularies in interface SynchronizeService

Throws:

ClientException

synchronize

public SynchronizeReport synchronize(CoreSession session,
                            SynchronizeDetails details,
                            String queryName)
                              throws Exception

Description copied from interface: SynchronizeService

Performs the whole synchronization process including the documents relations and vocabularies synchronizations.

Specified by:

synchronize in interface SynchronizeService

Parameters:

session - - the Nuxeo core session received from the web context

details - - the details about the synchronization process

Throws:

Exception

getImportConfiguration

public ImportConfiguration getImportConfiguration()

getDefaultDetails

public SynchronizeDetails getDefaultDetails()

Description copied from interface: SynchronizeService

Return the pre-configured connection parameters

Specified by:

getDefaultDetails in interface SynchronizeService

Returns:

shouldDisableReadSP

public boolean shouldDisableReadSP(String docPath,
                          String permission)

Description copied from interface: SynchronizeService

Test if the ReadSecurityPolicy should be disabled or not.

Specified by:

shouldDisableReadSP in interface SynchronizeService

Parameters:

docPath - the document path to test

permission - the permission to test

Returns:

true if the ReadSecurityPolicy must be disabled, false otherwise