Consider query method result limiting.

We now correctly apply the limit of derived queries. Additionally, we support dynamic limiting when query methods declare a Limit parameter.

Closes #586
See also: #585

Author: mp911de

src/main/java/org/springframework/data/ldap/repository/Query.java

@@ -71,6 +71,9 @@
 
 	/**
 	 * Count limit, to be used as input to {@link org.springframework.ldap.query.LdapQueryBuilder#countLimit(int)}.
+	 * <p>
+	 * This attribute will be ignored when a query method accepts a {@link org.springframework.data.domain.Limit}
+	 * parameter
 	 *
 	 * @return the count limit.
 	 */

src/main/java/org/springframework/data/ldap/repository/query/AnnotatedLdapRepositoryQuery.java

@@ -17,6 +17,7 @@
 
 import static org.springframework.ldap.query.LdapQueryBuilder.*;
 
+import org.springframework.data.domain.Limit;
 import org.springframework.data.expression.ValueEvaluationContext;
 import org.springframework.data.expression.ValueEvaluationContextProvider;
 import org.springframework.data.ldap.repository.Query;
@@ -93,17 +94,24 @@ protected LdapQuery createQuery(LdapParameterAccessor parameters) {
 		String query = bind(parameters, valueContextProvider, this.query);
 		String base = bind(parameters, valueContextProvider, this.base);
 
+		int countLimit = queryAnnotation.countLimit();
+
+		if (getQueryMethod().getParameters().hasLimitParameter()) {
+			Limit limit = parameters.getLimit();
+			countLimit = limit.isLimited() ? limit.max() : 0;
+		}
+
 		return query().base(base) //
 				.searchScope(queryAnnotation.searchScope()) //
-				.countLimit(queryAnnotation.countLimit()) //
+				.countLimit(countLimit) //
 				.timeLimit(queryAnnotation.timeLimit()) //
 				.filter(query, parameters.getBindableParameterValues());
 	}
 
 	private String bind(LdapParameterAccessor parameters, ValueEvaluationContextProvider valueContextProvider, StringBasedQuery query) {
 
 		ValueEvaluationContext evaluationContext = valueContextProvider
-				.getEvaluationContext(parameters.getBindableParameterValues(), query.getExpressionDependencies());
+				.getEvaluationContext(parameters.getValues(), query.getExpressionDependencies());
 
 		return query.bindQuery(parameters,
 				expression -> expression.evaluate(evaluationContext));

src/main/java/org/springframework/data/ldap/repository/query/LdapParameterAccessor.java

@@ -31,4 +31,13 @@ public interface LdapParameterAccessor extends ParameterAccessor {
 	 * @return
 	 */
 	Object[] getBindableParameterValues();
+
+	/**
+	 * Returns all parameter values of the underlying query method.
+	 *
+	 * @return
+	 * @since 3.5.6
+	 */
+	Object[] getValues();
+
 }

src/main/java/org/springframework/data/ldap/repository/query/LdapParametersParameterAccessor.java

@@ -56,4 +56,9 @@ public Object[] getBindableParameterValues() {
 		return values;
 	}
 
+	@Override
+	public Object[] getValues() {
+		return super.getValues();
+	}
+
 }

src/main/java/org/springframework/data/ldap/repository/query/LdapQueryCreator.java

@@ -99,6 +99,7 @@ private ContainerCriteria appendCondition(Part part, Iterator<Object> iterator,
 			Object next = iterator.next();
 			value = next != null ? next.toString() : null;
 		}
+
 		switch (type) {
 			case NEGATING_SIMPLE_PROPERTY:
 				return criteria.not().is(value);
@@ -125,10 +126,10 @@ private ContainerCriteria appendCondition(Part part, Iterator<Object> iterator,
 			default:
 				throw new IllegalArgumentException(String.format("%s queries are not supported for LDAP repositories", type));
 		}
-
 	}
 
 	private String getAttribute(Part part) {
+
 		PropertyPath path = part.getProperty();
 		if (path.hasNext()) {
 			throw new IllegalArgumentException("Nested properties are not supported");
@@ -139,8 +140,8 @@ private String getAttribute(Part part) {
 
 	@Override
 	protected ContainerCriteria and(Part part, ContainerCriteria base, Iterator<Object> iterator) {
-		ConditionCriteria criteria = base.and(getAttribute(part));
 
+		ConditionCriteria criteria = base.and(getAttribute(part));
 		return appendCondition(part, iterator, criteria);
 	}
 

src/main/java/org/springframework/data/ldap/repository/query/PartTreeLdapRepositoryQuery.java

@@ -18,6 +18,7 @@
 import java.util.Collections;
 import java.util.List;
 
+import org.springframework.data.domain.Limit;
 import org.springframework.data.mapping.PersistentEntity;
 import org.springframework.data.mapping.PersistentProperty;
 import org.springframework.data.mapping.context.MappingContext;
@@ -28,6 +29,7 @@
 import org.springframework.ldap.core.LdapOperations;
 import org.springframework.ldap.odm.core.ObjectDirectoryMapper;
 import org.springframework.ldap.query.LdapQuery;
+import org.springframework.ldap.query.LdapQueryBuilder;
 
 /**
  * {@link RepositoryQuery} implementation for LDAP.
@@ -72,6 +74,26 @@ protected LdapQuery createQuery(LdapParameterAccessor parameters) {
 
 		org.springframework.data.ldap.repository.query.LdapQueryCreator queryCreator = new LdapQueryCreator(partTree,
 				getEntityClass(), objectDirectoryMapper, parameters, inputProperties);
-		return queryCreator.createQuery();
+
+		LdapQuery query = queryCreator.createQuery();
+
+		if (getQueryMethod().getParameters().hasLimitParameter() || partTree.isLimiting()) {
+
+			LdapQueryBuilder builder = LdapQueryBuilder.fromQuery(query);
+
+			Limit limit = parameters.getLimit();
+
+			if (partTree.isLimiting()) {
+				builder.countLimit(partTree.getResultLimit().max());
+			}
+
+			if (getQueryMethod().getParameters().hasLimitParameter()) {
+				builder.countLimit(limit.isLimited() ? limit.max() : 0);
+			}
+
+			return builder;
+		}
+
+		return query;
 	}
 }

src/test/java/org/springframework/data/ldap/repository/query/AnnotatedLdapRepositoryQueryUnitTests.java

@@ -22,6 +22,7 @@
 import org.junit.jupiter.api.Test;
 import org.mockito.Mockito;
 
+import org.springframework.data.domain.Limit;
 import org.springframework.data.ldap.core.mapping.LdapMappingContext;
 import org.springframework.data.ldap.repository.LdapEncode;
 import org.springframework.data.ldap.repository.LdapEncoder;
@@ -93,6 +94,34 @@ void shouldEncodeWithCustomEncoder() throws NoSuchMethodException {
 		assertThat(ldapQuery.filter().encode()).isEqualTo("(cn=Doebar)");
 	}
 
+	@Test // GH-586
+	void shouldConsiderLimit() throws NoSuchMethodException {
+
+		LdapQueryMethod method = queryMethod("limited", String.class);
+		AnnotatedLdapRepositoryQuery query = repositoryQuery(method);
+
+		LdapQuery ldapQuery = query.createQuery(new LdapParametersParameterAccessor(method, new Object[] { "John Doe" }));
+
+		assertThat(ldapQuery.countLimit()).isEqualTo(123);
+	}
+
+	@Test // GH-586
+	void shouldConsiderLimitParameter() throws NoSuchMethodException {
+
+		LdapQueryMethod method = queryMethod("limited", String.class, Limit.class);
+		AnnotatedLdapRepositoryQuery query = repositoryQuery(method);
+
+		LdapQuery ldapQuery = query
+				.createQuery(new LdapParametersParameterAccessor(method, new Object[] { "John Doe", Limit.unlimited() }));
+
+		assertThat(ldapQuery.countLimit()).isEqualTo(0);
+
+		ldapQuery = query
+				.createQuery(new LdapParametersParameterAccessor(method, new Object[] { "John Doe", Limit.of(10) }));
+
+		assertThat(ldapQuery.countLimit()).isEqualTo(10);
+	}
+
 	private LdapQueryMethod queryMethod(String methodName, Class<?>... parameterTypes) throws NoSuchMethodException {
 		return new LdapQueryMethod(QueryRepository.class.getMethod(methodName, parameterTypes),
 				new DefaultRepositoryMetadata(QueryRepository.class), new SpelAwareProxyProjectionFactory());
@@ -108,6 +137,12 @@ interface QueryRepository extends LdapRepository<SchemaEntry> {
 		@Query(value = "(cn=:fullName)")
 		List<SchemaEntry> namedParameters(String fullName);
 
+		@Query(value = "(cn=:fullName)", countLimit = 123)
+		List<SchemaEntry> limited(String fullName);
+
+		@Query(value = "(cn=:fullName)", countLimit = 123)
+		List<SchemaEntry> limited(String fullName, Limit limit);
+
 		@Query(value = "(cn={0})")
 		List<SchemaEntry> messageFormatParameters(String fullName);
 

src/test/java/org/springframework/data/ldap/repository/query/PartTreeLdapRepositoryQueryUnitTests.java

@@ -0,0 +1,97 @@
+/*
+ * Copyright 2025 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.ldap.repository.query;
+
+import static org.assertj.core.api.Assertions.*;
+import static org.mockito.Mockito.*;
+
+import java.util.List;
+
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.mockito.Mockito;
+
+import org.springframework.data.domain.Limit;
+import org.springframework.data.ldap.core.mapping.LdapMappingContext;
+import org.springframework.data.ldap.repository.LdapRepository;
+import org.springframework.data.mapping.model.EntityInstantiators;
+import org.springframework.data.projection.SpelAwareProxyProjectionFactory;
+import org.springframework.data.repository.core.support.DefaultRepositoryMetadata;
+import org.springframework.ldap.core.LdapOperations;
+import org.springframework.ldap.odm.core.impl.DefaultObjectDirectoryMapper;
+import org.springframework.ldap.query.LdapQuery;
+
+/**
+ * Unit tests for {@link PartTreeLdapRepositoryQuery}.
+ *
+ * @author Mark Paluch
+ */
+class PartTreeLdapRepositoryQueryUnitTests {
+
+	LdapOperations ldapOperations = Mockito.mock();
+
+	@BeforeEach
+	void setUp() {
+		when(ldapOperations.getObjectDirectoryMapper()).thenReturn(new DefaultObjectDirectoryMapper());
+	}
+
+	@Test // GH-586
+	void shouldConsiderLimit() throws NoSuchMethodException {
+
+		LdapQueryMethod method = queryMethod("findTop5ByFullName", String.class);
+		PartTreeLdapRepositoryQuery query = repositoryQuery(method);
+
+		LdapQuery ldapQuery = query.createQuery(new LdapParametersParameterAccessor(method, new Object[] { "John Doe" }));
+
+		assertThat(ldapQuery.countLimit()).isEqualTo(5);
+	}
+
+	@Test // GH-586
+	void shouldConsiderLimitParameter() throws NoSuchMethodException {
+
+		LdapQueryMethod method = queryMethod("findTop5ByFullName", String.class, Limit.class);
+		PartTreeLdapRepositoryQuery query = repositoryQuery(method);
+
+		LdapQuery ldapQuery = query
+				.createQuery(new LdapParametersParameterAccessor(method, new Object[] { "John Doe", Limit.unlimited() }));
+
+		assertThat(ldapQuery.countLimit()).isEqualTo(0);
+
+		ldapQuery = query
+				.createQuery(new LdapParametersParameterAccessor(method, new Object[] { "John Doe", Limit.of(10) }));
+
+		assertThat(ldapQuery.countLimit()).isEqualTo(10);
+	}
+
+	private LdapQueryMethod queryMethod(String methodName, Class<?>... parameterTypes) throws NoSuchMethodException {
+		return new LdapQueryMethod(QueryRepository.class.getMethod(methodName, parameterTypes),
+				new DefaultRepositoryMetadata(QueryRepository.class), new SpelAwareProxyProjectionFactory());
+	}
+
+	private PartTreeLdapRepositoryQuery repositoryQuery(LdapQueryMethod method) {
+		return new PartTreeLdapRepositoryQuery(method, SchemaEntry.class, ldapOperations, new LdapMappingContext(),
+				new EntityInstantiators());
+	}
+
+	interface QueryRepository extends LdapRepository<SchemaEntry> {
+
+		List<SchemaEntry> findTop5ByFullName(String fullName);
+
+		List<SchemaEntry> findTop5ByFullName(String fullName, Limit limit);
+
+	}
+
+}