Package org.nuxeo.ecm.directory.scroll

Class DirectoryScroll

java.lang.Object

org.nuxeo.ecm.core.query.scroll.AbstractQueryBuilderScroll

org.nuxeo.ecm.core.query.scroll.AbstractQueryBuilderScroll.Query

org.nuxeo.ecm.directory.scroll.DirectoryScroll

All Implemented Interfaces:

AutoCloseable, Iterator<List<String>>, Scroll

public class DirectoryScroll
extends AbstractQueryBuilderScroll.Query
implements Scroll

Scrolls directory entry ids.

The scroll query is expressed in NXQL e.g "SELECT * FROM continent". Where clauses are ignored and results are ordered by directory id field ascendant.

Since:

2025.1

Nested Class Summary

Nested classes/interfaces inherited from class org.nuxeo.ecm.core.query.scroll.AbstractQueryBuilderScroll

AbstractQueryBuilderScroll.Query, AbstractQueryBuilderScroll.Scroll

Field Summary

Fields

Modifier and Type	Field	Description
protected NuxeoLoginContext	loginContext
static final String	SCROLL_NAME
protected Session	session

Fields inherited from class org.nuxeo.ecm.core.query.scroll.AbstractQueryBuilderScroll.Query

hasNext

Fields inherited from class org.nuxeo.ecm.core.query.scroll.AbstractQueryBuilderScroll

queryBuilder, size, timeout

Constructor Summary

Constructors

Constructor	Description
DirectoryScroll()

Method Summary

Modifier and Type	Method	Description
void	close()
void	init(ScrollRequest request, Map<String,String> options)	Initialization of the iterator.
protected List<String>	queryIds(QueryBuilder queryBuilder)

Methods inherited from class org.nuxeo.ecm.core.query.scroll.AbstractQueryBuilderScroll.Query

hasNext, next

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next, remove

Field Details

SCROLL_NAME

public static final String SCROLL_NAME

See Also:

• Constant Field Values

loginContext

protected NuxeoLoginContext loginContext

session

protected Session session

Constructor Details

DirectoryScroll

public DirectoryScroll()

Method Details

init

public void init(ScrollRequest request,
 Map<String,String> options)

Description copied from interface: Scroll

Initialization of the iterator.

Specified by:

init in interface Scroll

Overrides:

init in class AbstractQueryBuilderScroll.Query

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Scroll

queryIds

protected List<String> queryIds(QueryBuilder queryBuilder)

Specified by:

queryIds in class AbstractQueryBuilderScroll.Query