DATACMNS-542 - Simplified way to customize repository base class.

RepositoryFactorySupport now exposes a setRepositoryBaseClass(…) to take a custom type that instances will be created reflectively for. This removes the need for a boilerplate repository factory and FactoryBean implementation to hook custom repository base class implementations into the infrastructure.

RepositoryFactorySupport now exposes a getTargetRepositoryViaReflection(…) method to allow sub-classes to create repository instances and consider customized repository base classes nonetheless. getTargetRepository(…) needs a tiny signature change which unfortunately requires imple

Fixed schema registration for version 1.8 schema. Added new XSD containing a base-class attribute on the <repositories /> element to customize the repository base class via XML.

Removed outdated section of how to create a custom base repository class from the reference documentation and replaced it with new simplified instructions.

Deprecated usage of factory-class attribute in configuration. Point users to newly introduced way of configuring a base class directly to avoid the need for a boilerplate repository factory and factory bean implementation.

DefaultRepositoryInformation now makes target class methods assignable before caching and returning them, so that they can always be invoked reflectively. Made this aspect part of the contract of RepositoryInformation.getTargetClassMethod(…).

Author: odrotbohm

src/main/asciidoc/repositories.adoc

@@ -528,10 +528,8 @@ The approach just shown works well if your custom implementation uses annotation
 [[repositories.custom-behaviour-for-all-repositories]]
 === Adding custom behavior to all repositories
 
-The preceding approach is not feasible when you want to add a single method to all your repository interfaces.
+The preceding approach is not feasible when you want to add a single method to all your repository interfaces. To add custom behavior to all repositories, you first add an intermediate interface to declare the shared behavior.
 
-. To add custom behavior to all repositories, you first add an intermediate interface to declare the shared behavior.
-+
 .An interface declaring custom shared behavior
 ====
 [source, java]
@@ -545,10 +543,8 @@ public interface MyRepository<T, ID extends Serializable>
 ----
 ====
 
-. Now your individual repository interfaces will extend this intermediate interface instead of the `Repository` interface to include the functionality declared.
+Now your individual repository interfaces will extend this intermediate interface instead of the `Repository` interface to include the functionality declared. Next, create an implementation of the intermediate interface that extends the persistence technology-specific repository base class. This class will then act as a custom base class for the repository proxies.
 
-. Next, create an implementation of the intermediate interface that extends the persistence technology-specific repository base class. This class will then act as a custom base class for the repository proxies.
-+
 .Custom repository base class
 ====
 [source, java]
@@ -571,62 +567,29 @@ public class MyRepositoryImpl<T, ID extends Serializable>
 }
 ----
 ====
-+
+
 The default behavior of the Spring `<repositories />` namespace is to provide an implementation for all interfaces that fall under the `base-package`. This means that if left in its current state, an implementation instance of `MyRepository` will be created by Spring. This is of course not desired as it is just supposed to act as an intermediary between `Repository` and the actual repository interfaces you want to define for each entity. To exclude an interface that extends `Repository` from being instantiated as a repository instance, you can either annotate it with `@NoRepositoryBean` (as seen above) or move it outside of the configured `base-package`.
 
-. Then create a custom repository factory to replace the default `RepositoryFactoryBean` that will in turn produce a custom `RepositoryFactory`. The new repository factory will then provide your `MyRepositoryImpl` as the implementation of any interfaces that extend the `Repository` interface, replacing the `SimpleJpaRepository` implementation you just extended.
-+
-.Custom repository factory bean
+The final step is to make the Spring Data infrastructure aware of the customized repository base class. In JavaConfig this is achieved by using the `repositoryBaseClass` attribute of the `@Enable…Repositories` annotation:
+
+.Configuring a custom repository base class using JavaConfig
 ====
 [source, java]
 ----
-public class MyRepositoryFactoryBean<R extends JpaRepository<T, I>, T,
-  I extends Serializable> extends JpaRepositoryFactoryBean<R, T, I> {
-
-  protected RepositoryFactorySupport createRepositoryFactory(EntityManager em) {
-    return new MyRepositoryFactory(em);
-  }
-
-  private static class MyRepositoryFactory<T, I extends Serializable>
-    extends JpaRepositoryFactory {
-
-    private final EntityManager em;
-
-    public MyRepositoryFactory(EntityManager em) {
-
-      super(em);
-      this.em = em;
-    }
-
-    protected Object getTargetRepository(RepositoryMetadata metadata) {
-      return new MyRepositoryImpl<T, I>((Class<T>) metadata.getDomainClass(), em);
-    }
-
-    protected Class<?> getRepositoryBaseClass(RepositoryMetadata metadata) {
-      return MyRepositoryImpl.class;
-    }
-  }
-}
+@Configuration
+@EnableJpaRepositories(repositoryBaseClass = MyRepositoryImpl.class)
+class ApplicationConfiguration { … }
 ----
 ====
 
-. Finally, either declare beans of the custom factory directly or use the `factory-class` attribute of the Spring namespace or `@Enable…` annotation to instruct the repository infrastructure to use your custom factory implementation.
-+
-.Using the custom factory with the namespace
+A corresponding attribute is available in the XML namespace.
+
+.Configuring a custom repository base class using XML
 ====
 [source, xml]
 ----
 <repositories base-package="com.acme.repository"
-  factory-class="com.acme.MyRepositoryFactoryBean" />
-----
-====
-+
-.Using the custom factory with the `@Enable…` annotation
-====
-[source, java]
-----
-@EnableJpaRepositories(factoryClass = "com.acme.MyRepositoryFactoryBean")
-class Config {}
+     repository-base-class="….MyRepositoryImpl" />
 ----
 ====
 

src/main/java/org/springframework/data/repository/config/AnnotationRepositoryConfigurationSource.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -54,6 +54,7 @@ public class AnnotationRepositoryConfigurationSource extends RepositoryConfigura
 	private static final String NAMED_QUERIES_LOCATION = "namedQueriesLocation";
 	private static final String QUERY_LOOKUP_STRATEGY = "queryLookupStrategy";
 	private static final String REPOSITORY_FACTORY_BEAN_CLASS = "repositoryFactoryBeanClass";
+	private static final String REPOSITORY_BASE_CLASS = "repositoryBaseClass";
 	private static final String CONSIDER_NESTED_REPOSITORIES = "considerNestedRepositories";
 
 	private final AnnotationMetadata configMetadata;
@@ -213,6 +214,17 @@ public String getRepositoryFactoryBeanName() {
 		return attributes.getClass(REPOSITORY_FACTORY_BEAN_CLASS).getName();
 	}
 
+	/* 
+	 * (non-Javadoc)
+	 * @see org.springframework.data.repository.config.RepositoryConfigurationSource#getRepositoryBaseClassName()
+	 */
+	@Override
+	public String getRepositoryBaseClassName() {
+
+		Class<? extends Object> repositoryBaseClass = attributes.getClass(REPOSITORY_BASE_CLASS);
+		return DefaultRepositoryBaseClass.class.equals(repositoryBaseClass) ? null : repositoryBaseClass.getName();
+	}
+
 	/**
 	 * Returns the {@link AnnotationAttributes} of the annotation configured.
 	 * 

src/main/java/org/springframework/data/repository/config/DefaultRepositoryBaseClass.java

@@ -0,0 +1,30 @@
+/*
+ * Copyright 2015 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
+ *
+ *      http://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.repository.config;
+
+/**
+ * Placeholder class to be used in {@code @Enable} annotation's {@code repositoryBaseClass} attribute. The configuration
+ * evaluation infrastructure can use this type to find out no special repository base class was configured and apply
+ * defaults.
+ * 
+ * @author Oliver Gierke
+ * @soundtrack Elen - Sink like a stone (Elen)
+ * @since 1.11
+ */
+public final class DefaultRepositoryBaseClass {
+
+	private DefaultRepositoryBaseClass() {}
+}

src/main/java/org/springframework/data/repository/config/DefaultRepositoryConfiguration.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2013 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -150,6 +150,15 @@ public String getRepositoryFactoryBeanName() {
 		return configurationSource.getRepositoryFactoryBeanName();
 	}
 
+	/* 
+	 * (non-Javadoc)
+	 * @see org.springframework.data.repository.config.RepositoryConfiguration#getRepositoryBaseClassName()
+	 */
+	@Override
+	public String getRepositoryBaseClassName() {
+		return configurationSource.getRepositoryBaseClassName();
+	}
+
 	/* 
 	 * (non-Javadoc)
 	 * @see org.springframework.data.repository.config.RepositoryConfiguration#isLazyInit()

src/main/java/org/springframework/data/repository/config/RepositoryBeanDefinitionBuilder.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -65,7 +65,8 @@ public RepositoryBeanDefinitionBuilder(BeanDefinitionRegistry registry, Reposito
 		this.extension = extension;
 		this.resourceLoader = resourceLoader;
 		this.metadataReaderFactory = new CachingMetadataReaderFactory(resourceLoader);
-		this.implementationDetector = new CustomRepositoryImplementationDetector(metadataReaderFactory, environment, resourceLoader);
+		this.implementationDetector = new CustomRepositoryImplementationDetector(metadataReaderFactory, environment,
+				resourceLoader);
 	}
 
 	/**
@@ -90,6 +91,7 @@ public BeanDefinitionBuilder build(RepositoryConfiguration<?> configuration) {
 		builder.addPropertyValue("repositoryInterface", configuration.getRepositoryInterface());
 		builder.addPropertyValue("queryLookupStrategyKey", configuration.getQueryLookupStrategyKey());
 		builder.addPropertyValue("lazyInit", configuration.isLazyInit());
+		builder.addPropertyValue("repositoryBaseClass", configuration.getRepositoryBaseClassName());
 
 		NamedQueriesBeanDefinitionBuilder definitionBuilder = new NamedQueriesBeanDefinitionBuilder(
 				extension.getDefaultNamedQueryLocation());
@@ -143,6 +145,4 @@ private String registerCustomImplementation(RepositoryConfiguration<?> configura
 
 		return beanName;
 	}
-
-
 }

src/main/java/org/springframework/data/repository/config/RepositoryConfiguration.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2013 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -72,9 +72,20 @@ public interface RepositoryConfiguration<T extends RepositoryConfigurationSource
 	 * Returns the name of the {@link FactoryBean} class to be used to create repository instances.
 	 * 
 	 * @return
+	 * @deprecated as of 1.11 in favor of a dedicated repository class name, see {@link #getRepositoryBaseClassName()}.
 	 */
+	@Deprecated
 	String getRepositoryFactoryBeanName();
 
+	/**
+	 * Returns the name of the repository base class to be used or {@literal null} if the store specific defaults shall be
+	 * applied.
+	 * 
+	 * @return
+	 * @since 1.11
+	 */
+	String getRepositoryBaseClassName();
+
 	/**
 	 * Returns the source of the {@link RepositoryConfiguration}.
 	 * 

src/main/java/org/springframework/data/repository/config/RepositoryConfigurationSource.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -68,9 +68,21 @@ public interface RepositoryConfigurationSource {
 	 * Returns the name of the class of the {@link FactoryBean} to actually create repository instances.
 	 * 
 	 * @return
+	 * @deprecated as of 1.11 in favor of using a dedicated repository base class name, see
+	 *             {@link #getRepositoryBaseClassName()}.
 	 */
+	@Deprecated
 	String getRepositoryFactoryBeanName();
 
+	/**
+	 * Returns the name of the repository base class to be used or {@literal null} if the store specific defaults shall be
+	 * applied.
+	 * 
+	 * @return
+	 * @since 1.11
+	 */
+	String getRepositoryBaseClassName();
+
 	/**
 	 * Returns the source {@link BeanDefinition}s of the repository interfaces to create repository instances for.
 	 * 

src/main/java/org/springframework/data/repository/config/XmlRepositoryConfigurationSource.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -42,6 +42,7 @@ public class XmlRepositoryConfigurationSource extends RepositoryConfigurationSou
 	private static final String NAMED_QUERIES_LOCATION = "named-queries-location";
 	private static final String REPOSITORY_IMPL_POSTFIX = "repository-impl-postfix";
 	private static final String REPOSITORY_FACTORY_BEAN_CLASS_NAME = "factory-class";
+	private static final String REPOSITORY_BASE_CLASS_NAME = "base-class";
 	private static final String CONSIDER_NESTED_REPOSITORIES = "consider-nested-repositories";
 
 	private final Element element;
@@ -148,6 +149,15 @@ public String getRepositoryFactoryBeanName() {
 		return getNullDefaultedAttribute(element, REPOSITORY_FACTORY_BEAN_CLASS_NAME);
 	}
 
+	/* 
+	 * (non-Javadoc)
+	 * @see org.springframework.data.repository.config.RepositoryConfigurationSource#getRepositoryBaseClassName()
+	 */
+	@Override
+	public String getRepositoryBaseClassName() {
+		return getNullDefaultedAttribute(element, REPOSITORY_BASE_CLASS_NAME);
+	}
+
 	private String getNullDefaultedAttribute(Element element, String attributeName) {
 		String attribute = element.getAttribute(attributeName);
 		return StringUtils.hasText(attribute) ? attribute : null;

src/main/java/org/springframework/data/repository/core/RepositoryInformation.java

@@ -74,9 +74,10 @@ public interface RepositoryInformation extends RepositoryMetadata {
 	/**
 	 * Returns the target class method that is backing the given method. This can be necessary if a repository interface
 	 * redeclares a method of the core repository interface (e.g. for transaction behaviour customization). Returns the
-	 * method itself if the target class does not implement the given method.
+	 * method itself if the target class does not implement the given method. Implementations need to make sure the
+	 * {@link Method} returned can be invoked via reflection, i.e. needs to be accessible.
 	 * 
-	 * @param method
+	 * @param method must not be {@literal null}.
 	 * @return
 	 */
 	Method getTargetClassMethod(Method method);

src/main/java/org/springframework/data/repository/core/support/DefaultRepositoryInformation.java

@@ -17,6 +17,7 @@
 
 import static org.springframework.core.GenericTypeResolver.*;
 import static org.springframework.data.repository.util.ClassUtils.*;
+import static org.springframework.util.ReflectionUtils.*;
 
 import java.io.Serializable;
 import java.lang.reflect.Method;
@@ -117,13 +118,20 @@ public Method getTargetClassMethod(Method method) {
 		Method result = getTargetClassMethod(method, customImplementationClass);
 
 		if (!result.equals(method)) {
-			methodCache.put(method, result);
-			return result;
+			return cacheAndReturn(method, result);
 		}
 
-		result = getTargetClassMethod(method, repositoryBaseClass);
-		methodCache.put(method, result);
-		return result;
+		return cacheAndReturn(method, getTargetClassMethod(method, repositoryBaseClass));
+	}
+
+	private Method cacheAndReturn(Method key, Method value) {
+
+		if (value != null) {
+			makeAccessible(value);
+		}
+
+		methodCache.put(key, value);
+		return value;
 	}
 
 	/**