Package org.nuxeo.ecm.platform.usermanager.providers

Class NuxeoPrincipalsPageProvider

java.lang.Object

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

org.nuxeo.ecm.platform.usermanager.providers.AbstractUsersPageProvider<NuxeoPrincipal>

org.nuxeo.ecm.platform.usermanager.providers.NuxeoPrincipalsPageProvider

All Implemented Interfaces:

Serializable, PageProvider<NuxeoPrincipal>

public class NuxeoPrincipalsPageProvider
extends AbstractUsersPageProvider<NuxeoPrincipal>

* Page provider listing NuxeoPrincipals.

Since:

5.8

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected List<NuxeoPrincipal>	pagePrincipals

Fields inherited from class org.nuxeo.ecm.platform.usermanager.providers.AbstractUsersPageProvider

ALL_MODE, pageUsers, SEARCH_ONLY_MODE, SEARCH_OVERFLOW_ERROR_MESSAGE, TABBED_MODE, userCatalog, USERS_LISTING_MODE_PROPERTY

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
NuxeoPrincipalsPageProvider()

Method Summary

Modifier and Type	Method	Description
List<NuxeoPrincipal>	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

Methods inherited from class org.nuxeo.ecm.platform.usermanager.providers.AbstractUsersPageProvider

computeCurrentPage, getCatalogLetters, getFirstParameter, getUserListingMode, isSortable, searchAllUsers, searchUsers, searchUsersFromCatalog, updateUserCatalog

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, 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, toString, wait, wait, wait

Field Details

pagePrincipals

protected List<NuxeoPrincipal> pagePrincipals

Constructor Details

NuxeoPrincipalsPageProvider

public NuxeoPrincipalsPageProvider()

Method Details

getCurrentPage

public List<NuxeoPrincipal> 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<NuxeoPrincipal>

Specified by:

getCurrentPage in class AbstractPageProvider<NuxeoPrincipal>

Returns:

the current page

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 AbstractUsersPageProvider<NuxeoPrincipal>

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<NuxeoPrincipal>

Overrides:

refresh in class AbstractUsersPageProvider<NuxeoPrincipal>