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

Class AbstractUsersPageProvider<T>

java.lang.Object

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

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

All Implemented Interfaces:

Serializable, PageProvider<T>

Direct Known Subclasses:

NuxeoPrincipalsPageProvider, UsersPageProvider

public abstract class AbstractUsersPageProvider<T>
extends AbstractPageProvider<T>

Since:

5.8

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	ALL_MODE
protected List<DocumentModel>	pageUsers
protected static final String	SEARCH_ONLY_MODE
protected static final String	SEARCH_OVERFLOW_ERROR_MESSAGE
protected static final String	TABBED_MODE
protected Map<String,DocumentModelList>	userCatalog	Map with first letter as key and users list as value.
protected static final String	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
AbstractUsersPageProvider()

Method Summary

Modifier and Type	Method	Description
protected List<DocumentModel>	computeCurrentPage()
Collection<String>	getCatalogLetters()
protected String	getFirstParameter()
protected String	getUserListingMode()
boolean	isSortable()	This page provider does not support sort for now => override what may be contributed in the definition
protected void	pageChanged()	Page change hook, to override for custom behavior
void	refresh()	Refresh hook, to override for custom behavior
protected List<DocumentModel>	searchAllUsers(UserManager userManager)
protected List<DocumentModel>	searchUsers(UserManager userManager)
protected List<DocumentModel>	searchUsersFromCatalog(UserManager userManager)
protected void	updateUserCatalog(UserManager userManager)

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

addQuickFilter, addSortInfo, fireSearchEvent, firstPage, getAggregateDefinitions, getAggregates, getAvailableQuickFilters, getBooleanProperty, getCurrentEntry, getCurrentHigherNonEmptyPageIndex, getCurrentPage, 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

USERS_LISTING_MODE_PROPERTY

protected static final String USERS_LISTING_MODE_PROPERTY

See Also:

• Constant Field Values

ALL_MODE

protected static final String ALL_MODE

See Also:

• Constant Field Values

SEARCH_ONLY_MODE

protected static final String SEARCH_ONLY_MODE

See Also:

• Constant Field Values

TABBED_MODE

protected static final String TABBED_MODE

See Also:

• Constant Field Values

SEARCH_OVERFLOW_ERROR_MESSAGE

protected static final String SEARCH_OVERFLOW_ERROR_MESSAGE

See Also:

• Constant Field Values

userCatalog

protected Map<String,DocumentModelList> userCatalog

Map with first letter as key and users list as value.

pageUsers

protected List<DocumentModel> pageUsers

Constructor Details

AbstractUsersPageProvider

public AbstractUsersPageProvider()

Method Details

computeCurrentPage

protected List<DocumentModel> computeCurrentPage()

getUserListingMode

protected String getUserListingMode()

getFirstParameter

protected String getFirstParameter()

searchAllUsers

protected List<DocumentModel> searchAllUsers(UserManager userManager)

searchUsers

protected List<DocumentModel> searchUsers(UserManager userManager)

searchUsersFromCatalog

protected List<DocumentModel> searchUsersFromCatalog(UserManager userManager)

updateUserCatalog

protected void updateUserCatalog(UserManager userManager)

getCatalogLetters

public Collection<String> getCatalogLetters()

isSortable

public boolean isSortable()

This page provider does not support sort for now => override what may be contributed in the definition

Specified by:

isSortable in interface PageProvider<T>

Overrides:

isSortable in class AbstractPageProvider<T>

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

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

Overrides:

refresh in class AbstractPageProvider<T>