org.nuxeo.drive.service

Interface FileSystemChangeFinder

All Superinterfaces:

Serializable

All Known Implementing Classes:

AuditChangeFinder, ESAuditChangeFinder

public interface FileSystemChangeFinder
extends Serializable

Allows to find document changes.

Author:

Antoine Taillefer

Method Summary

Modifier and Type	Method and Description
long	getCurrentDate() Read the current time code to query for changes.
List<FileSystemItemChange>	getFileSystemChanges(CoreSession session, Set<IdRef> lastActiveRootRefs, SynchronizationRoots activeRoots, long lastSuccessfulSyncDate, long syncDate, int limit) Gets the changes in the repository against which the given session is bound for the given synchronization root paths, since the given last successful synchronization date and without exceeding the given limit.
List<FileSystemItemChange>	getFileSystemChangesIntegerBounds(CoreSession session, Set<IdRef> lastActiveRootRefs, SynchronizationRoots activeRoots, Set<String> collectionSyncRootMemberIds, long lowerBound, long upperBound, int limit) Gets the changes in the repository against which the given session is bound for the given synchronization root paths, between the given lower and upper integer bounds and without exceeding the given limit.
long	getUpperBound() Return the upper bound of the range clause in the change query.
long	getUpperBound(Set<String> repositoryNames) Returns the upper bound of the range clause in the change query taking into account the clustering delay if clustering is enabled for at least one of the given repositories.
void	handleParameters(Map<String,String> parameters) Handles the parameters contributed through the changeFinder contribution.

Method Detail

handleParameters

void handleParameters(Map<String,String> parameters)

Handles the parameters contributed through the changeFinder contribution.

getFileSystemChanges

List<FileSystemItemChange> getFileSystemChanges(CoreSession session,
                                                Set<IdRef> lastActiveRootRefs,
                                                SynchronizationRoots activeRoots,
                                                long lastSuccessfulSyncDate,
                                                long syncDate,
                                                int limit)
                                         throws TooManyChangesException

Gets the changes in the repository against which the given session is bound for the given synchronization root paths, since the given last successful synchronization date and without exceeding the given limit. The change summaries are mapped back to the file system view: the file system items might not always have the same tree layout as the backing documents in the repositories but this is a back-end detail that the client does not have to deal with.

Parameters:

session - the session bound to a specific repository

lastActiveRootRefs - docrefs of the roots as reported by the last successful synchronization (can be empty or null)

activeRoots - the currently active synchronization roots

lastSuccessfulSyncDate - the last successful synchronization date as measured on the server for this user device.

syncDate - the current synchronization date (upper bound on the date of the changes to return). This date is typically obtained by calling getCurrentDate()

limit - the maximum number of changes to fetch

Returns:

the list of document changes

Throws:

TooManyChangesException - if the number of changes found has exceeded the limit

getFileSystemChangesIntegerBounds

List<FileSystemItemChange> getFileSystemChangesIntegerBounds(CoreSession session,
                                                             Set<IdRef> lastActiveRootRefs,
                                                             SynchronizationRoots activeRoots,
                                                             Set<String> collectionSyncRootMemberIds,
                                                             long lowerBound,
                                                             long upperBound,
                                                             int limit)
                                                      throws TooManyChangesException

Gets the changes in the repository against which the given session is bound for the given synchronization root paths, between the given lower and upper integer bounds and without exceeding the given limit. The change summaries are mapped back to the file system view: the file system items might not always have the same tree layout as the backing documents in the repositories but this is a back-end detail that the client does not have to deal with.

Parameters:

session - the session bound to a specific repository

lastActiveRootRefs - docrefs of the roots as reported by the last successful synchronization (can be empty or null)

activeRoots - the currently active synchronization roots

collectionSyncRootMemberIds - the collection sync root member ids

lowerBound - the lower integer bound of the range clause in the change query

upperBound - the upper integer bound of the range clause in the change query. This id is typically obtained by calling #getUpperBound())

limit - the maximum number of changes to fetch

Returns:

the list of document changes

Throws:

TooManyChangesException - if the number of changes found has exceeded the limit

getCurrentDate

long getCurrentDate()

Read the current time code to query for changes. The time is truncated to 0 milliseconds to have a consistent behavior across databases. Call to this method should be monotonic (or very nearly monotonic).

getUpperBound

long getUpperBound()

Return the upper bound of the range clause in the change query.

getUpperBound

long getUpperBound(Set<String> repositoryNames)

Returns the upper bound of the range clause in the change query taking into account the clustering delay if clustering is enabled for at least one of the given repositories.

Since:

8.2