DATACMNS-1255 - Extend configuration of CDI repository settings.

We now extended CDI repository configuration to allow configuration of EvaluationContextProvider, NamedQueries, QueryLookupStrategy keys and the repository base class. CdiRepositoryConfiguration is now an interface with default-methods only providing default configuration values.

Original pull request: #272.

Author: mp911de

src/main/java/org/springframework/data/repository/cdi/CdiRepositoryBean.java

@@ -41,9 +41,9 @@
 import org.springframework.beans.factory.annotation.AnnotatedGenericBeanDefinition;
 import org.springframework.beans.factory.support.AbstractBeanDefinition;
 import org.springframework.data.repository.config.CustomRepositoryImplementationDetector;
-import org.springframework.data.repository.config.DefaultRepositoryConfiguration;
 import org.springframework.data.repository.config.RepositoryBeanNameGenerator;
 import org.springframework.data.repository.config.SpringDataAnnotationBeanNameGenerator;
+import org.springframework.data.repository.core.support.RepositoryFactorySupport;
 import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
 import org.springframework.util.ClassUtils;
@@ -407,6 +407,34 @@ protected T create(CreationalContext<T> creationalContext, Class<T> repositoryTy
 						+ "in order to use custom repository implementations");
 	}
 
+	/**
+	 * Applies the configuration from {@link CdiRepositoryConfiguration} to {@link RepositoryFactorySupport} by looking up
+	 * the actual configuration.
+	 *
+	 * @param repositoryFactory will never be {@literal null}.
+	 * @since 2.1
+	 */
+	protected void applyConfiguration(RepositoryFactorySupport repositoryFactory) {
+		applyConfiguration(repositoryFactory, lookupConfiguration(beanManager, qualifiers));
+	}
+
+	/**
+	 * Applies the configuration from {@link CdiRepositoryConfiguration} to {@link RepositoryFactorySupport} by looking up
+	 * the actual configuration.
+	 *
+	 * @param repositoryFactory will never be {@literal null}.
+	 * @param configuration will never be {@literal null}.
+	 * @since 2.1
+	 */
+	protected static void applyConfiguration(RepositoryFactorySupport repositoryFactory,
+			CdiRepositoryConfiguration configuration) {
+
+		configuration.getEvaluationContextProvider().ifPresent(repositoryFactory::setEvaluationContextProvider);
+		configuration.getNamedQueries().ifPresent(repositoryFactory::setNamedQueries);
+		configuration.getQueryLookupStrategy().ifPresent(repositoryFactory::setQueryLookupStrategyKey);
+		configuration.getRepositoryBeanClass().ifPresent(repositoryFactory::setRepositoryBaseClass);
+	}
+
 	/*
 	 * (non-Javadoc)
 	 * @see java.lang.Object#toString()
@@ -417,17 +445,7 @@ public String toString() {
 				qualifiers.toString());
 	}
 
-	static enum DefaultCdiRepositoryConfiguration implements CdiRepositoryConfiguration {
-
+	enum DefaultCdiRepositoryConfiguration implements CdiRepositoryConfiguration {
 		INSTANCE;
-
-		/*
-		 * (non-Javadoc)
-		 * @see org.springframework.data.repository.cdi.CdiRepositoryConfiguration#getRepositoryImplementationPostfix()
-		 */
-		@Override
-		public String getRepositoryImplementationPostfix() {
-			return DefaultRepositoryConfiguration.DEFAULT_REPOSITORY_IMPLEMENTATION_POSTFIX;
-		}
 	}
 }

src/main/java/org/springframework/data/repository/cdi/CdiRepositoryConfiguration.java

@@ -16,7 +16,10 @@
 
 package org.springframework.data.repository.cdi;
 
-import org.springframework.data.repository.config.DefaultRepositoryConfiguration;
+import java.util.Optional;
+
+import org.springframework.data.repository.core.NamedQueries;
+import org.springframework.data.repository.query.EvaluationContextProvider;
 import org.springframework.data.repository.query.QueryLookupStrategy;
 
 /**
@@ -28,19 +31,52 @@
 public interface CdiRepositoryConfiguration {
 
 	/**
-	 * Returns the configured postfix to be used for looking up custom implementation classes.
+	 * Return the {@link EvaluationContextProvider} to use. Can be {@link Optional#empty()} .
 	 *
-	 * @return the postfix to use, must not be {@literal null}.
+	 * @return the optional {@link EvaluationContextProvider} base to use, can be {@link Optional#empty()}, must not be
+	 *         {@literal null}.
+	 * @since 2.1
+	 */
+	default Optional<EvaluationContextProvider> getEvaluationContextProvider() {
+		return Optional.empty();
+	}
+
+	/**
+	 * Return the {@link NamedQueries} to use. Can be {@link Optional#empty()}.
+	 *
+	 * @return the optional named queries to use, can be {@link Optional#empty()}, must not be {@literal null}.
+	 * @since 2.1
+	 */
+	default Optional<NamedQueries> getNamedQueries() {
+		return Optional.empty();
+	}
+
+	/**
+	 * Return the {@link QueryLookupStrategy.Key} to lookup queries. Can be {@link Optional#empty()}.
+	 *
+	 * @return the lookup strategy to use, can be {@link Optional#empty()}, must not be {@literal null}.
+	 * @since 2.1
 	 */
-	String getRepositoryImplementationPostfix();
+	default Optional<QueryLookupStrategy.Key> getQueryLookupStrategy() {
+		return Optional.empty();
+	}
 
 	/**
-	 * Return the strategy to lookup queries.
+	 * Return the {@link Class repository base class} to use. Can be {@link Optional#empty()} .
 	 *
-	 * @return the lookup strategy to use.
+	 * @return the optional repository base to use, can be {@link Optional#empty()}, must not be {@literal null}.
 	 * @since 2.1
 	 */
-	default QueryLookupStrategy.Key getQueryLookupStrategy() {
-		return DefaultRepositoryConfiguration.DEFAULT_QUERY_LOOKUP_STRATEGY;
+	default Optional<Class<?>> getRepositoryBeanClass() {
+		return Optional.empty();
+	}
+
+	/**
+	 * Returns the configured postfix to be used for looking up custom implementation classes.
+	 *
+	 * @return the postfix to use, must not be {@literal null}.
+	 */
+	default String getRepositoryImplementationPostfix() {
+		return "Impl";
 	}
 }

src/test/java/org/springframework/data/repository/cdi/CdiRepositoryBeanUnitTests.java

@@ -39,11 +39,18 @@
 import org.mockito.junit.MockitoJUnitRunner;
 import org.springframework.data.repository.Repository;
 import org.springframework.data.repository.config.CustomRepositoryImplementationDetector;
+import org.springframework.data.repository.core.NamedQueries;
+import org.springframework.data.repository.core.support.PropertiesBasedNamedQueries;
+import org.springframework.data.repository.core.support.RepositoryFactorySupport;
+import org.springframework.data.repository.query.DefaultEvaluationContextProvider;
+import org.springframework.data.repository.query.EvaluationContextProvider;
+import org.springframework.data.repository.query.QueryLookupStrategy.Key;
 
 /**
  * Unit tests for {@link CdiRepositoryBean}.
  *
  * @author Oliver Gierke
+ * @author Mark Paluch
  */
 @RunWith(MockitoJUnitRunner.class)
 public class CdiRepositoryBeanUnitTests {
@@ -55,6 +62,7 @@ public class CdiRepositoryBeanUnitTests {
 			.singleton((Annotation) new CdiRepositoryExtensionSupport.DefaultAnnotationLiteral());
 
 	@Mock BeanManager beanManager;
+	@Mock RepositoryFactorySupport repositoryFactory;
 
 	@Test(expected = IllegalArgumentException.class)
 	public void voidRejectsNullQualifiers() {
@@ -154,6 +162,25 @@ protected SampleRepository create( //
 		);
 	}
 
+	@Test // DATACMNS-1255
+	public void appliesRepositoryConfiguration() {
+
+		DummyCdiRepositoryBean<SampleRepository> bean = new DummyCdiRepositoryBean<SampleRepository>(NO_ANNOTATIONS,
+				SampleRepository.class, beanManager) {
+			@Override
+			protected CdiRepositoryConfiguration lookupConfiguration(BeanManager beanManager, Set qualifiers) {
+				return RepositoryConfiguration.INSTANCE;
+			}
+		};
+
+		bean.applyConfiguration(repositoryFactory);
+
+		verify(repositoryFactory).setEvaluationContextProvider(DefaultEvaluationContextProvider.INSTANCE);
+		verify(repositoryFactory).setNamedQueries(PropertiesBasedNamedQueries.EMPTY);
+		verify(repositoryFactory).setRepositoryBaseClass(String.class);
+		verify(repositoryFactory).setQueryLookupStrategyKey(Key.CREATE);
+	}
+
 	static class DummyCdiRepositoryBean<T> extends CdiRepositoryBean<T> {
 
 		DummyCdiRepositoryBean(Set<Annotation> qualifiers, Class<T> repositoryType, BeanManager beanManager) {
@@ -168,12 +195,37 @@ protected T create(CreationalContext<T> creationalContext, Class<T> repositoryTy
 	}
 
 	@Named("namedRepository")
-	static interface SampleRepository extends Repository<Object, Serializable> {
+	interface SampleRepository extends Repository<Object, Serializable> {
 
 	}
 
 	@StereotypeAnnotation
-	static interface StereotypedSampleRepository {
+	interface StereotypedSampleRepository {
+
+	}
+
+	enum RepositoryConfiguration implements CdiRepositoryConfiguration {
+
+		INSTANCE;
 
+		@Override
+		public Optional<EvaluationContextProvider> getEvaluationContextProvider() {
+			return Optional.of(DefaultEvaluationContextProvider.INSTANCE);
+		}
+
+		@Override
+		public Optional<NamedQueries> getNamedQueries() {
+			return Optional.of(PropertiesBasedNamedQueries.EMPTY);
+		}
+
+		@Override
+		public Optional<Key> getQueryLookupStrategy() {
+			return Optional.of(Key.CREATE);
+		}
+
+		@Override
+		public Optional<Class<?>> getRepositoryBeanClass() {
+			return Optional.of(String.class);
+		}
 	}
 }