Package org.nuxeo.drive.service
Interface FileSystemChangeFinder
- All Known Implementing Classes:
AuditChangeFinder
,ESAuditChangeFinder
,MongoDBAuditChangeFinder
public interface FileSystemChangeFinder
Allows to find document changes.
- Author:
- Antoine Taillefer
-
Method Summary
Modifier and TypeMethodDescriptiongetFileSystemChanges
(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
Return the upper bound of the range clause in the change query.default long
getUpperBound
(Set<String> repositoryNames) Deprecated.void
handleParameters
(Map<String, String> parameters) Handles the parameters contributed through thechangeFinder
contribution.
-
Method Details
-
handleParameters
Handles the parameters contributed through thechangeFinder
contribution. -
getFileSystemChanges
List<FileSystemItemChange> getFileSystemChanges(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. 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 repositorylastActiveRootRefs
- docrefs of the roots as reported by the last successful synchronization (can be empty or null)activeRoots
- the currently active synchronization rootscollectionSyncRootMemberIds
- the collection sync root member idslowerBound
- the lower integer bound of the range clause in the change queryupperBound
- the upper integer bound of the range clause in the change query. This id is typically obtained by callinggetUpperBound()
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
-
getUpperBound
long getUpperBound()Return the upper bound of the range clause in the change query. -
getUpperBound
Deprecated.since 11.3, usegetUpperBound()
insteadReturns the upper bound of the range clause in the change query.- Since:
- 8.2
-
getUpperBound()
instead