Package org.nuxeo.ecm.platform.audit.api

Class AuditPageProvider

java.lang.Object

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

org.nuxeo.ecm.platform.audit.api.AuditPageProvider

All Implemented Interfaces:

Serializable, PageProvider<LogEntry>

Direct Known Subclasses:

DocumentHistoryPageProvider

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

PageProvider implementation that returns LogEntry from Audit Service

Since:

5.4.2

Author:

Tiry ([email protected])

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	auditQuery
protected Map<String,Object>	auditQueryParams
static String	CORE_SESSION_PROPERTY
static String	UICOMMENTS_PROPERTY

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

currentEntryIndex, currentHigherNonEmptyPageIndex, currentSelectPage, definition, error, errorMessage, highlights, log, 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 boolean	allowSimplePattern()
protected void	buildAuditQuery(boolean includeSort)
protected Object	convertParam(Object param)
List<LogEntry>	getCurrentPage()	Returns the list of current page items.
protected String	getFixedPart()
long	getResultsCount()	Returns the number of result elements if available or a negative value if it is unknown: UNKNOWN_SIZE if it is unknown as query was not done, and since 5.5, UNKNOWN_SIZE_AFTER_QUERY if it is still unknown after query was done.
protected String	getSortPart()
protected boolean	isNonNullParam(Object[] val)
protected void	preprocessCommentsIfNeeded(List<LogEntry> entries)
void	refresh()	Refresh hook, to override for custom behavior
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, getResultsCountLimit, getSearchDocumentModel, getSortInfo, getSortInfoIndex, getSortInfos, hasAggregateSupport, hasChangedParameters, hasError, incorporateAggregates, isLastPageAvailable, isNextEntryAvailable, isNextPageAvailable, isPreviousEntryAvailable, isPreviousPageAvailable, isSkipAggregates, isSortable, isTrackingEnabled, lastPage, nextEntry, nextPage, notifyPageChanged, notifyRefresh, pageChanged, 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, getResultsCountLimit, 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 Detail

auditQuery

protected String auditQuery

auditQueryParams

protected Map<String,Object> auditQueryParams

CORE_SESSION_PROPERTY

public static final String CORE_SESSION_PROPERTY

See Also:

Constant Field Values

UICOMMENTS_PROPERTY

public static final String UICOMMENTS_PROPERTY

See Also:

Constant Field Values

Constructor Detail

AuditPageProvider

public AuditPageProvider()

Method Detail

toString

public String toString()

Overrides:

toString in class Object

preprocessCommentsIfNeeded

protected void preprocessCommentsIfNeeded(List<LogEntry> entries)

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

getSortPart

protected String getSortPart()

convertParam

protected Object convertParam(Object param)

isNonNullParam

protected boolean isNonNullParam(Object[] val)

getFixedPart

protected String getFixedPart()

allowSimplePattern

protected boolean allowSimplePattern()

buildAuditQuery

protected void buildAuditQuery(boolean includeSort)

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>

getResultsCount

public long getResultsCount()

Description copied from interface: PageProvider

Returns the number of result elements if available or a negative value if it is unknown: UNKNOWN_SIZE if it is unknown as query was not done, and since 5.5, UNKNOWN_SIZE_AFTER_QUERY if it is still unknown after query was done.

Specified by:

getResultsCount in interface PageProvider<LogEntry>

Overrides:

getResultsCount in class AbstractPageProvider<LogEntry>