Merge pull request #21289 from filiphr

* gh-21289:
  Polish "Add properties to control exceptions ignored by LdapTemplate"
  Add properties to control exceptions ignored by LdapTemplate

Closes gh-21289

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/ldap/LdapAutoConfiguration.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2019 the original author or authors.
+ * Copyright 2012-2020 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.
@@ -22,6 +22,7 @@ import org.springframework.beans.factory.ObjectProvider;
 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
+import org.springframework.boot.autoconfigure.ldap.LdapProperties.Template;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.boot.context.properties.PropertyMapper;
 import org.springframework.context.annotation.Bean;
@@ -64,8 +65,16 @@ public class LdapAutoConfiguration {
 
 	@Bean
 	@ConditionalOnMissingBean(LdapOperations.class)
-	public LdapTemplate ldapTemplate(ContextSource contextSource) {
+	public LdapTemplate ldapTemplate(LdapProperties properties, ContextSource contextSource) {
-		return new LdapTemplate(contextSource);
+		Template template = properties.getTemplate();
+		PropertyMapper propertyMapper = PropertyMapper.get().alwaysApplyingWhenNonNull();
+		LdapTemplate ldapTemplate = new LdapTemplate(contextSource);
+		propertyMapper.from(template.isIgnorePartialResultException())
+				.to(ldapTemplate::setIgnorePartialResultException);
+		propertyMapper.from(template.isIgnoreNameNotFoundException()).to(ldapTemplate::setIgnoreNameNotFoundException);
+		propertyMapper.from(template.isIgnoreSizeLimitExceededException())
+				.to(ldapTemplate::setIgnoreSizeLimitExceededException);
+		return ldapTemplate;
 	}
 
 }

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/ldap/LdapProperties.java

@@ -21,6 +21,7 @@ import java.util.Map;
 
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.core.env.Environment;
+import org.springframework.ldap.core.LdapTemplate;
 import org.springframework.util.Assert;
 import org.springframework.util.ObjectUtils;
 
@@ -66,6 +67,8 @@ public class LdapProperties {
 	 */
 	private final Map<String, String> baseEnvironment = new HashMap<>();
 
+	private Template template = new Template();
+
 	public String[] getUrls() {
 		return this.urls;
 	}
@@ -110,6 +113,10 @@ public class LdapProperties {
 		return this.baseEnvironment;
 	}
 
+	public Template getTemplate() {
+		return this.template;
+	}
+
 	public String[] determineUrls(Environment environment) {
 		if (ObjectUtils.isEmpty(this.urls)) {
 			return new String[] { "ldap://localhost:" + determinePort(environment) };
@@ -126,4 +133,53 @@ public class LdapProperties {
 		return DEFAULT_PORT;
 	}
 
+	/**
+	 * {@link LdapTemplate settings}.
+	 */
+	public static class Template {
+
+		/**
+		 * Whether PartialResultException should be ignored in searches via the
+		 * LdapTemplate.
+		 */
+		private boolean ignorePartialResultException = false;
+
+		/**
+		 * Whether NameNotFoundException should be ignored in searches via the
+		 * LdapTemplate.
+		 */
+		private boolean ignoreNameNotFoundException = false;
+
+		/**
+		 * Whether SizeLimitExceededException should be ignored in searches via the
+		 * LdapTemplate.
+		 */
+		private boolean ignoreSizeLimitExceededException = true;
+
+		public boolean isIgnorePartialResultException() {
+			return this.ignorePartialResultException;
+		}
+
+		public void setIgnorePartialResultException(boolean ignorePartialResultException) {
+			this.ignorePartialResultException = ignorePartialResultException;
+		}
+
+		public boolean isIgnoreNameNotFoundException() {
+			return this.ignoreNameNotFoundException;
+		}
+
+		public void setIgnoreNameNotFoundException(boolean ignoreNameNotFoundException) {
+			this.ignoreNameNotFoundException = ignoreNameNotFoundException;
+		}
+
+		public boolean isIgnoreSizeLimitExceededException() {
+			return this.ignoreSizeLimitExceededException;
+		}
+
+		public void setIgnoreSizeLimitExceededException(Boolean ignoreSizeLimitExceededException) {
+			this.ignoreSizeLimitExceededException = ignoreSizeLimitExceededException;
+		}
+
+	}
+
 }

spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/ldap/LdapAutoConfigurationTests.java

@@ -112,8 +112,27 @@ class LdapAutoConfigurationTests {
 
 	@Test
 	void templateExists() {
-		this.contextRunner.withPropertyValues("spring.ldap.urls:ldap://localhost:389")
+		this.contextRunner.withPropertyValues("spring.ldap.urls:ldap://localhost:389").run((context) -> {
-				.run((context) -> assertThat(context).hasSingleBean(LdapTemplate.class));
+			assertThat(context).hasSingleBean(LdapTemplate.class);
+			LdapTemplate ldapTemplate = context.getBean(LdapTemplate.class);
+			assertThat(ldapTemplate).hasFieldOrPropertyWithValue("ignorePartialResultException", false);
+			assertThat(ldapTemplate).hasFieldOrPropertyWithValue("ignoreNameNotFoundException", false);
+			assertThat(ldapTemplate).hasFieldOrPropertyWithValue("ignoreSizeLimitExceededException", true);
+		});
+	}
+
+	@Test
+	void templateConfigurationCanBeCustomized() {
+		this.contextRunner.withPropertyValues("spring.ldap.urls:ldap://localhost:389",
+				"spring.ldap.template.ignorePartialResultException=true",
+				"spring.ldap.template.ignoreNameNotFoundException=true",
+				"spring.ldap.template.ignoreSizeLimitExceededException=false").run((context) -> {
+					assertThat(context).hasSingleBean(LdapTemplate.class);
+					LdapTemplate ldapTemplate = context.getBean(LdapTemplate.class);
+					assertThat(ldapTemplate).hasFieldOrPropertyWithValue("ignorePartialResultException", true);
+					assertThat(ldapTemplate).hasFieldOrPropertyWithValue("ignoreNameNotFoundException", true);
+					assertThat(ldapTemplate).hasFieldOrPropertyWithValue("ignoreSizeLimitExceededException", false);
+				});
 	}
 
 	@Test

spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/ldap/LdapPropertiesTests.java

@@ -0,0 +1,45 @@
+/*
+ * Copyright 2012-2020 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.boot.autoconfigure.ldap;
+
+import org.junit.jupiter.api.Test;
+
+import org.springframework.boot.autoconfigure.ldap.LdapProperties.Template;
+import org.springframework.ldap.core.LdapTemplate;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Tests for {@link LdapProperties}
+ *
+ * @author Filip Hrisafov
+ */
+class LdapPropertiesTests {
+
+	@Test
+	void ldapTemplatePropertiesUseConsistentLdapTemplateDefaultValues() {
+		Template templateProperties = new LdapProperties().getTemplate();
+		LdapTemplate ldapTemplate = new LdapTemplate();
+		assertThat(ldapTemplate).hasFieldOrPropertyWithValue("ignorePartialResultException",
+				templateProperties.isIgnorePartialResultException());
+		assertThat(ldapTemplate).hasFieldOrPropertyWithValue("ignoreNameNotFoundException",
+				templateProperties.isIgnoreNameNotFoundException());
+		assertThat(ldapTemplate).hasFieldOrPropertyWithValue("ignoreSizeLimitExceededException",
+				templateProperties.isIgnoreSizeLimitExceededException());
+	}
+
+}