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
void	doSynchronize(CoreSession session) Performs the whole synchronization process including the documents relations and vocabularies synchronizations using the default synchronization details.
void	doSynchronize(CoreSession session, String queryName) Performs the whole synchronization process including the documents relations and vocabularies synchronizations using the default synchronization details.
void	doSynchronize(CoreSession session, SynchronizeDetails details) Performs the whole synchronization process including the documents relations and vocabularies synchronizations.
void	doSynchronize(CoreSession session, SynchronizeDetails details, String queryName) Performs the whole synchronization process including the documents relations and vocabularies synchronizations.
void	doSynchronizeDocuments(CoreSession session) Synchronizes all the documents by using the default synchronization details.
void	doSynchronizeDocuments(CoreSession session, String queryName) Synchronizes all the documents by using the default synchronization details.
void	doSynchronizeDocuments(CoreSession session, SynchronizeDetails details) Synchronizes all the documents by using the synchronization details.
void	doSynchronizeDocuments(CoreSession session, SynchronizeDetails details, String queryName) Synchronizes all the documents by using the synchronization details.
void	doSynchronizeRelations() Synchronizes all the relations defined on the documents by using the default synchronization details.This should happen after the documents synchronization.
void	doSynchronizeRelations(SynchronizeDetails details) Synchronizes all the relations defined on the documents by using the synchronization details.This should happen after the documents synchronization.
void	doSynchronizeVocabularies() Synchronizes all the vocabularies by using the default synchronization details.This should happen after the documents synchronization.
void	doSynchronizeVocabularies(SynchronizeDetails details) Synchronizes all the vocabularies by using the synchronization details.This should happen after the documents synchronization.
SynchronizeDetails	getDefaultSynchronizeDetails()
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.

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

doSynchronizeDocuments

public void doSynchronizeDocuments(CoreSession session,
                          SynchronizeDetails details)
                            throws Exception

Description copied from interface: SynchronizeService

Synchronizes all the documents by using the synchronization details.

Specified by:

doSynchronizeDocuments in interface SynchronizeService

Parameters:

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

details - - the details about the synchronization process

Throws:

ClientException

Exception

doSynchronizeDocuments

public void doSynchronizeDocuments(CoreSession session)
                            throws Exception

Description copied from interface: SynchronizeService

Synchronizes all the documents by using the default synchronization details.

Specified by:

doSynchronizeDocuments in interface SynchronizeService

Parameters:

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

Throws:

ClientException

Exception

doSynchronizeDocuments

public void doSynchronizeDocuments(CoreSession session,
                          SynchronizeDetails details,
                          String queryName)
                            throws Exception

Description copied from interface: SynchronizeService

Synchronizes all the documents by using the synchronization details.

Specified by:

doSynchronizeDocuments 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

doSynchronizeDocuments

public void doSynchronizeDocuments(CoreSession session,
                          String queryName)
                            throws Exception

Description copied from interface: SynchronizeService

Synchronizes all the documents by using the default synchronization details.

Specified by:

doSynchronizeDocuments in interface SynchronizeService

Parameters:

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

queryName - - the query name to use server side

Throws:

ClientException

Exception

doSynchronizeRelations

public void doSynchronizeRelations(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:

doSynchronizeRelations in interface SynchronizeService

Parameters:

details - - the details about the synchronization process

Throws:

ClientException

doSynchronizeRelations

public void doSynchronizeRelations()
                            throws ClientException

Description copied from interface: SynchronizeService

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

Specified by:

doSynchronizeRelations in interface SynchronizeService

Throws:

ClientException

doSynchronizeVocabularies

public void doSynchronizeVocabularies(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:

doSynchronizeVocabularies in interface SynchronizeService

Throws:

ClientException

doSynchronizeVocabularies

public void doSynchronizeVocabularies()
                               throws ClientException

Description copied from interface: SynchronizeService

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

Specified by:

doSynchronizeVocabularies in interface SynchronizeService

Throws:

ClientException

doSynchronize

public void doSynchronize(CoreSession session,
                 SynchronizeDetails details)
                   throws Exception

Description copied from interface: SynchronizeService

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

Specified by:

doSynchronize in interface SynchronizeService

Parameters:

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

details - - the details about the synchronization process

Throws:

Exception

doSynchronize

public void doSynchronize(CoreSession session)
                   throws Exception

Description copied from interface: SynchronizeService

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

Specified by:

doSynchronize in interface SynchronizeService

Parameters:

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

Throws:

Exception

doSynchronize

public void doSynchronize(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:

doSynchronize in interface SynchronizeService

Parameters:

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

details - - the details about the synchronization process

Throws:

Exception

doSynchronize

public void doSynchronize(CoreSession session,
                 String queryName)
                   throws Exception

Description copied from interface: SynchronizeService

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

Specified by:

doSynchronize in interface SynchronizeService

Parameters:

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

Throws:

Exception

getImportConfiguration

public ImportConfiguration getImportConfiguration()

getDefaultSynchronizeDetails

public SynchronizeDetails getDefaultSynchronizeDetails()

Specified by:

getDefaultSynchronizeDetails in interface SynchronizeService

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