DATAMONGO-476 - JavaConfig support for repositories.

spring-data-mongodb-parent/pom.xml

@@ -18,7 +18,7 @@
  <org.springframework.version.30>3.0.7.RELEASE</org.springframework.version.30>
  <org.springframework.version.40>4.0.0.RELEASE</org.springframework.version.40>
  <org.springframework.version.range>[${org.springframework.version.30}, ${org.springframework.version.40})</org.springframework.version.range>
- <data.commons.version>1.3.2.BUILD-SNAPSHOT</data.commons.version>
+ <data.commons.version>1.4.0.BUILD-SNAPSHOT</data.commons.version>
  <aspectj.version>1.6.11.RELEASE</aspectj.version>
  <bundlor.failOnWarnings>true</bundlor.failOnWarnings>
  </properties>

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/config/MongoNamespaceHandler.java

@@ -16,7 +16,9 @@
 package org.springframework.data.mongodb.config;
 
 import org.springframework.beans.factory.xml.NamespaceHandlerSupport;
-import org.springframework.data.mongodb.repository.config.MongoRepositoryConfigParser;
+import org.springframework.data.mongodb.repository.config.MongoRepositoryConfigurationExtension;
+import org.springframework.data.repository.config.RepositoryBeanDefinitionParser;
+import org.springframework.data.repository.config.RepositoryConfigurationExtension;
 
 /**
  * {@link org.springframework.beans.factory.xml.NamespaceHandler} for Mongo DB based repositories.
@@ -32,7 +34,10 @@ public class MongoNamespaceHandler extends NamespaceHandlerSupport {
 */
 public void init() {
 
-registerBeanDefinitionParser("repositories", new MongoRepositoryConfigParser());
+RepositoryConfigurationExtension extension = new MongoRepositoryConfigurationExtension();
+RepositoryBeanDefinitionParser repositoryBeanDefinitionParser = new RepositoryBeanDefinitionParser(extension);
+
+registerBeanDefinitionParser("repositories", repositoryBeanDefinitionParser);
 registerBeanDefinitionParser("mapping-converter", new MappingMongoConverterParser());
 registerBeanDefinitionParser("mongo", new MongoParser());
 registerBeanDefinitionParser("db-factory", new MongoDbFactoryParser());

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/config/EnableMongoRepositories.java

@@ -0,0 +1,120 @@
+/*
+ * Copyright 2012 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.mongodb.repository.config;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import org.springframework.beans.factory.FactoryBean;
+import org.springframework.context.annotation.ComponentScan.Filter;
+import org.springframework.context.annotation.Import;
+import org.springframework.data.mongodb.core.MongoTemplate;
+import org.springframework.data.mongodb.repository.support.MongoRepositoryFactoryBean;
+import org.springframework.data.repository.query.QueryLookupStrategy;
+import org.springframework.data.repository.query.QueryLookupStrategy.Key;
+
+/**
+ * Annotation to activate MongoDB repositories. If no base package is configured through either {@link #value()},
+ * {@link #basePackages()} or {@link #basePackageClasses()} it will trigger scanning of the package of annotated class.
+ * 
+ * @author Oliver Gierke
+ */
+@Target(ElementType.TYPE)
+@Retention(RetentionPolicy.RUNTIME)
+@Documented
+@Import(MongoRepositoriesRegistrar.class)
+public @interface EnableMongoRepositories {
+
+/**
+ * Alias for the {@link #basePackages()} attribute. Allows for more concise annotation declarations e.g.:
+ * {@code @EnableJpaRepositories("org.my.pkg")} instead of {@code @EnableJpaRepositories(basePackages="org.my.pkg")}.
+ */
+String[] value() default {};
+
+/**
+ * Base packages to scan for annotated components. {@link #value()} is an alias for (and mutually exclusive with) this
+ * attribute. Use {@link #basePackageClasses()} for a type-safe alternative to String-based package names.
+ */
+String[] basePackages() default {};
+
+/**
+ * Type-safe alternative to {@link #basePackages()} for specifying the packages to scan for annotated components. The
+ * package of each class specified will be scanned. Consider creating a special no-op marker class or interface in
+ * each package that serves no purpose other than being referenced by this attribute.
+ */
+Class<?>[] basePackageClasses() default {};
+
+/**
+ * Specifies which types are eligible for component scanning. Further narrows the set of candidate components from
+ * everything in {@link #basePackages()} to everything in the base packages that matches the given filter or filters.
+ */
+Filter[] includeFilters() default {};
+
+/**
+ * Specifies which types are not eligible for component scanning.
+ */
+Filter[] excludeFilters() default {};
+
+/**
+ * Returns the postfix to be used when looking up custom repository implementations. Defaults to {@literal Impl}. So
+ * for a repository named {@code PersonRepository} the corresponding implementation class will be looked up scanning
+ * for {@code PersonRepositoryImpl}.
+ * 
+ * @return
+ */
+String repositoryImplementationPostfix() default "";
+
+/**
+ * Configures the location of where to find the Spring Data named queries properties file. Will default to
+ * {@code META-INFO/mongo-named-queries.properties}.
+ * 
+ * @return
+ */
+String namedQueriesLocation() default "";
+
+/**
+ * Returns the key of the {@link QueryLookupStrategy} to be used for lookup queries for query methods. Defaults to
+ * {@link Key#CREATE_IF_NOT_FOUND}.
+ * 
+ * @return
+ */
+Key queryLookupStrategy() default Key.CREATE_IF_NOT_FOUND;
+
+/**
+ * Returns the {@link FactoryBean} class to be used for each repository instance. Defaults to
+ * {@link MongoRepositoryFactoryBean}.
+ * 
+ * @return
+ */
+Class<?> repositoryFactoryBeanClass() default MongoRepositoryFactoryBean.class;
+
+/**
+ * Configures the name of the {@link MongoTemplate} bean to be used with the repositories detected.
+ * 
+ * @return
+ */
+String mongoTemplateRef() default "mongoTemplate";
+
+/**
+ * Whether to automatically create indexes for query methods defined in the repository interface.
+ * 
+ * @return
+ */
+boolean createIndexesForQueryMethods() default false;
+}

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/config/MongoRepositoriesRegistrar.java

@@ -0,0 +1,48 @@
+/*
+ * Copyright 2012 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.mongodb.repository.config;
+
+import java.lang.annotation.Annotation;
+
+import org.springframework.context.annotation.ImportBeanDefinitionRegistrar;
+import org.springframework.data.repository.config.RepositoryBeanDefinitionRegistrarSupport;
+import org.springframework.data.repository.config.RepositoryConfigurationExtension;
+
+/**
+ * Mongo-specific {@link ImportBeanDefinitionRegistrar}.
+ * 
+ * @author Oliver Gierke
+ */
+class MongoRepositoriesRegistrar extends RepositoryBeanDefinitionRegistrarSupport {
+
+/* 
+ * (non-Javadoc)
+ * @see org.springframework.data.repository.config.RepositoryBeanDefinitionRegistrarSupport#getAnnotation()
+ */
+@Override
+protected Class<? extends Annotation> getAnnotation() {
+return EnableMongoRepositories.class;
+}
+
+/* 
+ * (non-Javadoc)
+ * @see org.springframework.data.repository.config.RepositoryBeanDefinitionRegistrarSupport#getExtension()
+ */
+@Override
+protected RepositoryConfigurationExtension getExtension() {
+return new MongoRepositoryConfigurationExtension();
+}
+}

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/config/MongoRepositoryConfigurationExtension.java

@@ -0,0 +1,82 @@
+/*
+ * Copyright 2012 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.mongodb.repository.config;
+
+import org.springframework.beans.factory.support.BeanDefinitionBuilder;
+import org.springframework.core.annotation.AnnotationAttributes;
+import org.springframework.data.mongodb.repository.support.MongoRepositoryFactoryBean;
+import org.springframework.data.repository.config.AnnotationRepositoryConfigurationSource;
+import org.springframework.data.repository.config.RepositoryConfigurationExtension;
+import org.springframework.data.repository.config.RepositoryConfigurationExtensionSupport;
+import org.springframework.data.repository.config.XmlRepositoryConfigurationSource;
+import org.w3c.dom.Element;
+
+/**
+ * {@link RepositoryConfigurationExtension} for MongoDB.
+ * 
+ * @author Oliver Gierke
+ */
+public class MongoRepositoryConfigurationExtension extends RepositoryConfigurationExtensionSupport {
+
+private static final String MONGO_TEMPLATE_REF = "mongo-template-ref";
+private static final String CREATE_QUERY_INDEXES = "create-query-indexes";
+
+/* 
+ * (non-Javadoc)
+ * @see org.springframework.data.repository.config.RepositoryConfigurationExtensionSupport#getModulePrefix()
+ */
+@Override
+protected String getModulePrefix() {
+return "mongo";
+}
+
+/*
+ * (non-Javadoc)
+ * @see org.springframework.data.repository.config.RepositoryConfigurationExtension#getRepositoryFactoryClassName()
+ */
+public String getRepositoryFactoryClassName() {
+return MongoRepositoryFactoryBean.class.getName();
+}
+
+/* 
+ * (non-Javadoc)
+ * @see org.springframework.data.repository.config.RepositoryConfigurationExtensionSupport#postProcess(org.springframework.beans.factory.support.BeanDefinitionBuilder, org.springframework.data.repository.config.XmlRepositoryConfigurationSource)
+ */
+@Override
+public void postProcess(BeanDefinitionBuilder builder, XmlRepositoryConfigurationSource config) {
+
+Element element = config.getElement();
+
+String attribute = element.getAttribute(MONGO_TEMPLATE_REF);
+builder.addPropertyReference("mongoOperations", attribute);
+
+attribute = element.getAttribute(CREATE_QUERY_INDEXES);
+builder.addPropertyValue("createIndexesForQueryMethods", attribute);
+}
+
+/* 
+ * (non-Javadoc)
+ * @see org.springframework.data.repository.config.RepositoryConfigurationExtensionSupport#postProcess(org.springframework.beans.factory.support.BeanDefinitionBuilder, org.springframework.data.repository.config.AnnotationRepositoryConfigurationSource)
+ */
+@Override
+public void postProcess(BeanDefinitionBuilder builder, AnnotationRepositoryConfigurationSource config) {
+
+AnnotationAttributes attributes = config.getAttributes();
+
+builder.addPropertyReference("mongoOperations", attributes.getString("mongoTemplateRef"));
+builder.addPropertyValue("createIndexesForQueryMethods", attributes.getBoolean("createIndexesForQueryMethods"));
+}
+}