org.nuxeo.drive.service

Interface NuxeoDriveManager

All Known Implementing Classes:

NuxeoDriveManagerImpl

public interface NuxeoDriveManager

Manage list of NuxeoDrive synchronization roots and devices for a given nuxeo user.

Field Summary

Fields

Modifier and Type	Field and Description
static String	LOCALLY_EDITED_COLLECTION_NAME

Method Summary

Methods

Modifier and Type	Method and Description
void	addToLocallyEditedCollection(CoreSession session, DocumentModel doc) Adds the given DocumentModel to the LOCALLY_EDITED_COLLECTION_NAME collection.
FileSystemChangeFinder	getChangeFinder() Gets the FileSystemChangeFinder member.
FileSystemChangeSummary	getChangeSummary(Principal principal, Map<String,Set<IdRef>> lastSyncRootRefs, long lastSuccessfulSync) Gets a summary of document changes in all repositories or in the repository against which the given session is bound depending on the allRepositories parameter, for the given user's synchronization roots, since the user's device last successful synchronization date.
FileSystemChangeSummary	getChangeSummaryIntegerBounds(Principal principal, Map<String,Set<IdRef>> lastSyncRootRefs, long lowerBound) Gets a summary of document changes in all repositories or in the repository against which the given session is bound depending on the allRepositories parameter, for the given user's synchronization roots, from the lower bound sent by the user's device.
Map<String,Set<String>>	getCollectionSyncRootMemberIds(Principal principal) Fetch all the collection sync root member ids for a given user.
Set<IdRef>	getSynchronizationRootReferences(CoreSession session) Fetch the list of synchronization root refs for a given user and a given session repository.
Map<String,SynchronizationRoots>	getSynchronizationRoots(Principal principal) Fetch all the synchronization root references and paths for a given user.
void	handleFolderDeletion(IdRef ref) Method to be called by a CoreEvent listener monitoring documents deletions to cleanup references to recently deleted documents and invalidate the caches.
void	invalidateCollectionSyncRootMemberCache() Invalidate the collection sync root member cache for all users so as to query the repository next time getCollectionSyncRootMemberIds(Principal) is called.
void	invalidateCollectionSyncRootMemberCache(String userName) Invalidate the collection sync root member cache for a given user so as to query the repository next time getCollectionSyncRootMemberIds(Principal) is called.
void	invalidateSynchronizationRootsCache(String userName) Invalidate the synchronization roots cache for a given user so as to query the repository next time getSynchronizationRoots(Principal) is called.
boolean	isSynchronizationRoot(Principal principal, DocumentModel doc) Checks if the given DocumentModel is a synchronization root for the given user.
void	registerSynchronizationRoot(Principal principal, DocumentModel newRootContainer, CoreSession session)
void	setChangeFinder(FileSystemChangeFinder changeFinder) Sets the FileSystemChangeFinder member.
void	unregisterSynchronizationRoot(Principal principal, DocumentModel rootContainer, CoreSession session)

Field Detail

LOCALLY_EDITED_COLLECTION_NAME

static final String LOCALLY_EDITED_COLLECTION_NAME

See Also:

Constant Field Values

Method Detail

registerSynchronizationRoot

void registerSynchronizationRoot(Principal principal,
                               DocumentModel newRootContainer,
                               CoreSession session)
                                 throws ClientException

Parameters:

principal - the Nuxeo Drive user

newRootContainer - the folderish document to be used as synchronization root: must be bound to an active session

Throws:

ClientException

SecurityException - if the user does not have write permissions to the container.

unregisterSynchronizationRoot

void unregisterSynchronizationRoot(Principal principal,
                                 DocumentModel rootContainer,
                                 CoreSession session)
                                   throws ClientException

Parameters:

principal - the Nuxeo Drive user

rootContainer - the folderish document that should no longer be used as a synchronization root

Throws:

ClientException

getSynchronizationRootReferences

Set<IdRef> getSynchronizationRootReferences(CoreSession session)
                                            throws ClientException

Fetch the list of synchronization root refs for a given user and a given session repository. This list is assumed to be short enough (in the order of 100 folder max) so that no paging API is required. The user is taken from the session.getPrincipal() method.

Parameters:

session - active CoreSession instance to the repository hosting the roots.

Returns:

the ordered set of non deleted synchronization root references for that user

Throws:

ClientException

See Also:

#getSynchronizationRootPaths(String, CoreSession)

getSynchronizationRoots

Map<String,SynchronizationRoots> getSynchronizationRoots(Principal principal)
                                                         throws ClientException

Fetch all the synchronization root references and paths for a given user. This list is assumed to be short enough (in the order of 100 folder max) so that no paging API is required.

Parameters:

principal - the user to fetch the roots for

Returns:

the map keyed by repository names all active roots definitions for the current user.

Throws:

ClientException

getCollectionSyncRootMemberIds

Map<String,Set<String>> getCollectionSyncRootMemberIds(Principal principal)
                                                       throws ClientException

Fetch all the collection sync root member ids for a given user.

Parameters:

principal - the user to fetch the ids for

Returns:

the map keyed by repository names all collection sync root member ids for the current user.

Throws:

ClientException

isSynchronizationRoot

boolean isSynchronizationRoot(Principal principal,
                            DocumentModel doc)
                              throws ClientException

Checks if the given DocumentModel is a synchronization root for the given user.

Throws:

ClientException

handleFolderDeletion

void handleFolderDeletion(IdRef ref)
                          throws ClientException

Method to be called by a CoreEvent listener monitoring documents deletions to cleanup references to recently deleted documents and invalidate the caches.

Throws:

ClientException

getChangeSummary

FileSystemChangeSummary getChangeSummary(Principal principal,
                                       Map<String,Set<IdRef>> lastSyncRootRefs,
                                       long lastSuccessfulSync)
                                         throws ClientException

Gets a summary of document changes in all repositories or in the repository against which the given session is bound depending on the allRepositories parameter, for the given user's synchronization roots, since the user's device last successful synchronization date.

The summary includes:

• The list of sync root paths
• A list of document changes
• The document models that have changed
• A status code

Parameters:

allRepositories - if true then the document changes are retrieved from all repositories, else only from the one against which the given session is bound

userName - the id of the Nuxeo Drive user

session - active CoreSession instance to the repository hosting the user's synchronization roots

lastSyncRootRefs - the map keyed by repository names of document refs for the synchronization roots that were active during last synchornization

lastSuccessfulSync - the last successful synchronization date of the user's device. This time is expected to be in milliseconds since 1970-01-01 UTC as measured on the Nuxeo server clock, typically set to the value returned by FileSystemChangeSummary.getSyncDate() of the previous call to getChangeSummary(Principal, Map, long) or 0 for catching every event since the repository initialization.

Returns:

the summary of document changes

Throws:

ClientException

getChangeSummaryIntegerBounds

FileSystemChangeSummary getChangeSummaryIntegerBounds(Principal principal,
                                                    Map<String,Set<IdRef>> lastSyncRootRefs,
                                                    long lowerBound)
                                                      throws ClientException

Gets a summary of document changes in all repositories or in the repository against which the given session is bound depending on the allRepositories parameter, for the given user's synchronization roots, from the lower bound sent by the user's device.

The summary includes:

• The list of sync root paths
• A list of document changes
• The document models that have changed
• A status code

Parameters:

allRepositories - if true then the document changes are retrieved from all repositories, else only from the one against which the given session is bound

userName - the id of the Nuxeo Drive user

session - active CoreSession instance to the repository hosting the user's synchronization roots

lastSyncRootRefs - the map keyed by repository names of document refs for the synchronization roots that were active during last synchornization

lowerBound - the lower bound sent by the user's device. Typically set to the value returned by FileSystemChangeSummary.getUpperBound() of the previous call to getChangeSummaryIntegerBounds(Principal, Map, long) or 0 for catching every event since the repository initialization.

Returns:

the summary of document changes

Throws:

ClientException

getChangeFinder

FileSystemChangeFinder getChangeFinder()

Gets the FileSystemChangeFinder member.

setChangeFinder

void setChangeFinder(FileSystemChangeFinder changeFinder)

Sets the FileSystemChangeFinder member.

TODO: make it overridable with an extension point and remove setter.

invalidateSynchronizationRootsCache

void invalidateSynchronizationRootsCache(String userName)

Invalidate the synchronization roots cache for a given user so as to query the repository next time getSynchronizationRoots(Principal) is called.

Parameters:

userName - the principal name of the user to invalidate the cache for.

invalidateCollectionSyncRootMemberCache

void invalidateCollectionSyncRootMemberCache(String userName)

Invalidate the collection sync root member cache for a given user so as to query the repository next time getCollectionSyncRootMemberIds(Principal) is called.

Parameters:

userName - the principal name of the user to invalidate the cache for.

invalidateCollectionSyncRootMemberCache

void invalidateCollectionSyncRootMemberCache()

Invalidate the collection sync root member cache for all users so as to query the repository next time getCollectionSyncRootMemberIds(Principal) is called.

addToLocallyEditedCollection

void addToLocallyEditedCollection(CoreSession session,
                                DocumentModel doc)
                                  throws ClientException

Adds the given DocumentModel to the LOCALLY_EDITED_COLLECTION_NAME collection.

Throws:

ClientException

Since:

6.0