Package org.nuxeo.audit.provider

Class AuditPageProvider

java.lang.Object

org.nuxeo.ecm.platform.query.api.AbstractPageProvider<LogEntry>

org.nuxeo.audit.provider.AuditPageProvider

All Implemented Interfaces:

Serializable, PageProvider<LogEntry>

Direct Known Subclasses:

DocumentHistoryPageProvider

public class AuditPageProvider
extends AbstractPageProvider<LogEntry>
implements PageProvider<LogEntry>

Since:

2025.0

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	CORE_SESSION_PROPERTY
protected LogEntryList	currentEntries
protected String	nxqlQuery

Fields inherited from class org.nuxeo.ecm.platform.query.api.AbstractPageProvider

currentEntryIndex, currentHigherNonEmptyPageIndex, currentSelectPage, definition, error, errorMessage, highlights, maxPageSize, name, offset, PAGEPROVIDER_TRACK_PROPERTY_NAME, pageProviderChangedListener, pageSize, pageSizeOptions, parameters, properties, quickFilters, resultsCount, searchDocumentModel, selectedEntries, SKIPPED_SCHEMAS_FOR_SEARCHFIELD, sortable, sortInfos, tracking

Fields inherited from interface org.nuxeo.ecm.platform.query.api.PageProvider

DEFAULT_MAX_PAGE_SIZE, DEFAULT_MAX_PAGE_SIZE_RUNTIME_PROP, HIGHLIGHT_CTX_DATA, PAGE_LIMIT_UNKNOWN, SKIP_AGGREGATES_PROP, UNKNOWN_SIZE, UNKNOWN_SIZE_AFTER_QUERY

Constructor Summary

Constructors

Constructor	Description
AuditPageProvider()

Method Summary

Modifier and Type	Method	Description
protected MultiExpression	buildFilter()
protected QueryBuilder	buildQuery()
protected void	flattenPredicate(List<Predicate> predicates, Operator operator, Predicate predicate)
protected MultiExpression	flattenPredicateToMultiExpression(Operator operator, Predicate predicate)
protected MultiExpression	flattenPredicateToMultiExpression(Predicate predicate)
protected CoreSession	getCoreSession()
List<LogEntry>	getCurrentPage()	Returns the list of current page items.
protected void	pageChanged()	Page change hook, to override for custom behavior
void	refresh()	Refresh hook, to override for custom behavior
protected String	remapFixedPart(String fixedPart)
protected WhereClauseDefinition	remapWhereClause(WhereClauseDefinition whereClause)
String	toString()

Methods inherited from class org.nuxeo.ecm.platform.query.api.AbstractPageProvider

addQuickFilter, addSortInfo, fireSearchEvent, firstPage, getAggregateDefinitions, getAggregates, getAvailableQuickFilters, getBooleanProperty, getCurrentEntry, getCurrentHigherNonEmptyPageIndex, getCurrentPageIndex, getCurrentPageOffset, getCurrentPageSize, getCurrentPageStatus, getCurrentSelectPage, getDefaultMaxPageSize, getDefinition, getError, getErrorMessage, getHighlights, getMaxNumberOfEmptyPages, getMaxPageSize, getMinMaxPageSize, getName, getNumberOfPages, getPageLimit, getPageSize, getPageSizeOptions, getParameters, getParametersChanged, getProperties, getQuickFilters, getResultsCount, getResultsCountLimit, getSearchDocumentModel, getSortInfo, getSortInfoIndex, getSortInfos, hasAggregateSupport, hasChangedParameters, hasError, incorporateAggregates, isLastPageAvailable, isNextEntryAvailable, isNextPageAvailable, isPreviousEntryAvailable, isPreviousPageAvailable, isSkipAggregates, isSortable, isTrackingEnabled, lastPage, nextEntry, nextPage, notifyPageChanged, notifyRefresh, previousEntry, previousPage, searchDocumentModelChanged, setCurrentEntry, setCurrentEntryIndex, setCurrentHigherNonEmptyPageIndex, setCurrentPage, setCurrentPageIndex, setCurrentPageOffset, setDefinition, setHighlights, setMaxPageSize, setName, setPageProviderChangedListener, setPageSize, setPageSizeOptions, setParameters, setProperties, setQuickFilters, setResultsCount, setSearchDocumentModel, setSelectedEntries, setSortable, setSortInfo, setSortInfo, setSortInfos, sortInfoChanged

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.ecm.platform.query.api.PageProvider

addQuickFilter, addSortInfo, firstPage, getAggregateDefinitions, getAggregates, getAvailableQuickFilters, getCurrentEntry, getCurrentPageIndex, getCurrentPageOffset, getCurrentPageSize, getCurrentPageStatus, getCurrentSelectPage, getDefinition, getError, getErrorMessage, getHighlights, getMaxPageSize, getName, getNumberOfPages, getPageLimit, getPageSize, getPageSizeOptions, getParameters, getProperties, getQuickFilters, getResultsCount, getResultsCountLimit, getScroller, getSearchDocumentModel, getSortInfo, getSortInfoIndex, getSortInfos, hasAggregateSupport, hasChangedParameters, hasError, isLastPageAvailable, isNextEntryAvailable, isNextPageAvailable, isPreviousEntryAvailable, isPreviousPageAvailable, isSkipAggregates, isSortable, lastPage, nextEntry, nextPage, previousEntry, previousPage, setCurrentEntry, setCurrentEntryIndex, setCurrentPage, setCurrentPageIndex, setCurrentPageOffset, setDefinition, setHighlights, setMaxPageSize, setName, setPageProviderChangedListener, setPageSize, setPageSizeOptions, setParameters, setProperties, setQuickFilters, setResultsCount, setSearchDocumentModel, setSelectedEntries, setSortable, setSortInfo, setSortInfo, setSortInfos

Field Details

CORE_SESSION_PROPERTY

protected static final String CORE_SESSION_PROPERTY

See Also:

• Constant Field Values

nxqlQuery

protected String nxqlQuery

currentEntries

protected LogEntryList currentEntries

Constructor Details

AuditPageProvider

public AuditPageProvider()

Method Details

getCoreSession

protected CoreSession getCoreSession()

getCurrentPage

public List<LogEntry> getCurrentPage()

Description copied from class: AbstractPageProvider

Returns the list of current page items.

Custom implementation can be added here, based on the page provider properties, parameters and WhereClauseDefinition on the PageProviderDefinition, as well as search document, sort information, etc...

Implementation of this method usually consists in setting a non-null value to a field caching current items, and nullifying this field by overriding AbstractPageProvider.pageChanged() and AbstractPageProvider.refresh().

Fields AbstractPageProvider.errorMessage and AbstractPageProvider.error can also be filled to provide accurate feedback in case an error occurs during the search.

When items are retrieved, a call to AbstractPageProvider.setResultsCount(long) should be made to ensure proper pagination as implemented in this abstract class. The implementation in CoreQueryAndFetchPageProvider is a good example when the total results count is known.

If for performance reasons, for instance, the number of results cannot be known, a fall-back strategy can be applied to provide the "next" button but not the "last" one, by calling AbstractPageProvider.getCurrentHigherNonEmptyPageIndex() and AbstractPageProvider.setCurrentHigherNonEmptyPageIndex(int). In this case, CoreQueryDocumentPageProvider is a good example.

Specified by:

getCurrentPage in interface PageProvider<LogEntry>

Specified by:

getCurrentPage in class AbstractPageProvider<LogEntry>

Returns:

the current page

buildQuery

protected QueryBuilder buildQuery()

buildFilter

protected MultiExpression buildFilter()

remapWhereClause

protected WhereClauseDefinition remapWhereClause(WhereClauseDefinition whereClause)

remapFixedPart

protected String remapFixedPart(String fixedPart)

flattenPredicateToMultiExpression

protected MultiExpression flattenPredicateToMultiExpression(Predicate predicate)

flattenPredicateToMultiExpression

protected MultiExpression flattenPredicateToMultiExpression(Operator operator,
 Predicate predicate)

flattenPredicate

protected void flattenPredicate(List<Predicate> predicates,
 Operator operator,
 Predicate predicate)

pageChanged

protected void pageChanged()

Description copied from class: AbstractPageProvider

Page change hook, to override for custom behavior

When overriding it, call super.pageChanged() as last statement to make sure that the PageProviderChangedListener is called with the up-to-date @{code PageProvider} state.

Overrides:

pageChanged in class AbstractPageProvider<LogEntry>

refresh

public void refresh()

Description copied from class: AbstractPageProvider

Refresh hook, to override for custom behavior

When overriding it, call super.refresh() as last statement to make sure that the PageProviderChangedListener is called with the up-to-date @{code PageProvider} state.

Specified by:

refresh in interface PageProvider<LogEntry>

Overrides:

refresh in class AbstractPageProvider<LogEntry>

toString

public String toString()

Overrides:

toString in class Object