org.nuxeo.drive.service.impl

Class AuditChangeFinder

java.lang.Object

org.nuxeo.drive.service.impl.AuditChangeFinder

All Implemented Interfaces:

Serializable, FileSystemChangeFinder

Direct Known Subclasses:

ESAuditChangeFinder

public class AuditChangeFinder
extends Object
implements FileSystemChangeFinder

Implementation of FileSystemChangeFinder using the AuditReader.

Author:

Antoine Taillefer

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,String>	parameters

Constructor Summary

Constructors

Constructor and Description
AuditChangeFinder()

Method Summary

Modifier and Type	Method and Description
protected long	getClusteringDelay(Set<String> repositoryNames) Returns the longest clustering delay among the given repositories for which clustering is enabled.
protected String	getCollectionSyncRootFilteringClause(Set<String> collectionSyncRootMemberIds, Map<String,Object> params)
long	getCurrentDate() To be deprecated (in fact make throw UnsupportedOperationException), keeping for backward compatibility.
protected String	getCurrentRootFilteringClause(Set<String> rootPaths, Map<String,Object> params)
List<FileSystemItemChange>	getFileSystemChanges(CoreSession session, Set<IdRef> lastActiveRootRefs, SynchronizationRoots activeRoots, long lastSuccessfulSyncDate, long syncDate, int limit) To be deprecated (in fact make throw UnsupportedOperationException), keeping old method based on log date for backward compatibility.
protected List<FileSystemItemChange>	getFileSystemChanges(CoreSession session, Set<IdRef> lastActiveRootRefs, SynchronizationRoots activeRoots, Set<String> collectionSyncRootMemberIds, long lowerBound, long upperBound, boolean integerBounds, int 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.
protected FileSystemItemChange	getFileSystemItemChange(CoreSession session, DocumentRef docRef, LogEntry entry, String expectedFileSystemItemId)
protected String	getJPARangeClause(long lowerBound, long upperBound, boolean integerBounds, Map<String,Object> params) Now using event log id to ensure consistency, see https://jira.nuxeo.com/browse/NXP-14826.
long	getUpperBound() Return the last available log id in the audit log table (primary key) to be used as the upper bound of the event log id range clause in the change query.
long	getUpperBound(Set<String> repositoryNames) Returns the last available log id in the audit log table (primary key) considering events older than the last clustering invalidation date 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.
protected List<LogEntry>	queryAuditEntries(CoreSession session, SynchronizationRoots activeRoots, Set<String> collectionSyncRootMemberIds, long lowerBound, long upperBound, boolean integerBounds, int limit)

Methods inherited from class java.lang.Object

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

Field Detail

parameters

protected Map<String,String> parameters

Constructor Detail

AuditChangeFinder

public AuditChangeFinder()

Method Detail

handleParameters

public void handleParameters(Map<String,String> parameters)

Description copied from interface: FileSystemChangeFinder

Handles the parameters contributed through the changeFinder contribution.

Specified by:

handleParameters in interface FileSystemChangeFinder

getFileSystemChanges

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

To be deprecated (in fact make throw UnsupportedOperationException), keeping old method based on log date for backward compatibility.

Now using event log id for lower and upper bounds to ensure consistency.

Specified by:

getFileSystemChanges in interface FileSystemChangeFinder

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 FileSystemChangeFinder.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

See Also:

https://jira.nuxeo.com/browse/NXP-14826, getFileSystemChangesIntegerBounds(CoreSession, Set, SynchronizationRoots, Set, long, long, int)

getFileSystemChangesIntegerBounds

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

Description copied from interface: FileSystemChangeFinder

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.

Specified by:

getFileSystemChangesIntegerBounds in interface FileSystemChangeFinder

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

getFileSystemChanges

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

Throws:

TooManyChangesException

getCurrentDate

public long getCurrentDate()

To be deprecated (in fact make throw UnsupportedOperationException), keeping for backward compatibility.

Return the current time to query the logDate field of the audit log. This time intentionally truncated to 0 milliseconds to have a consistent behavior across databases.

Should now use last available log id in the audit log table as upper bound.

Specified by:

getCurrentDate in interface FileSystemChangeFinder

See Also:

https://jira.nuxeo.com/browse/NXP-14826, getUpperBound()

getUpperBound

public long getUpperBound()

Return the last available log id in the audit log table (primary key) to be used as the upper bound of the event log id range clause in the change query.

Specified by:

getUpperBound in interface FileSystemChangeFinder

getUpperBound

public long getUpperBound(Set<String> repositoryNames)

Returns the last available log id in the audit log table (primary key) considering events older than the last clustering invalidation date if clustering is enabled for at least one of the given repositories. This is to make sure the DocumentModel further fetched from the session using the audit entry doc id is fresh.

Specified by:

getUpperBound in interface FileSystemChangeFinder

getClusteringDelay

protected long getClusteringDelay(Set<String> repositoryNames)

Returns the longest clustering delay among the given repositories for which clustering is enabled.

queryAuditEntries

protected List<LogEntry> queryAuditEntries(CoreSession session,
                                           SynchronizationRoots activeRoots,
                                           Set<String> collectionSyncRootMemberIds,
                                           long lowerBound,
                                           long upperBound,
                                           boolean integerBounds,
                                           int limit)

getCurrentRootFilteringClause

protected String getCurrentRootFilteringClause(Set<String> rootPaths,
                                               Map<String,Object> params)

getCollectionSyncRootFilteringClause

protected String getCollectionSyncRootFilteringClause(Set<String> collectionSyncRootMemberIds,
                                                      Map<String,Object> params)

getJPARangeClause

protected String getJPARangeClause(long lowerBound,
                                   long upperBound,
                                   boolean integerBounds,
                                   Map<String,Object> params)

Now using event log id to ensure consistency, see https://jira.nuxeo.com/browse/NXP-14826.

Keeping ability to use old clause based on log date for backward compatibility, to be deprecated.

getFileSystemItemChange

protected FileSystemItemChange getFileSystemItemChange(CoreSession session,
                                                       DocumentRef docRef,
                                                       LogEntry entry,
                                                       String expectedFileSystemItemId)