org.springframework.data.mongodb.repository.config

Annotation Type EnableMongoRepositories

@Target(value=TYPE)
@Retention(value=RUNTIME)
@Documented
@Inherited
@Import(value=org.springframework.data.mongodb.repository.config.MongoRepositoriesRegistrar.class)
public @interface EnableMongoRepositories

Annotation to activate MongoDB repositories. If no base package is configured through either value(), basePackages() or basePackageClasses() it will trigger scanning of the package of annotated class.

Author:

Oliver Gierke

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<?>[]	basePackageClasses Type-safe alternative to basePackages() for specifying the packages to scan for annotated components.
String[]	basePackages Base packages to scan for annotated components.
boolean	createIndexesForQueryMethods Whether to automatically create indexes for query methods defined in the repository interface.
ComponentScan.Filter[]	excludeFilters Specifies which types are not eligible for component scanning.
ComponentScan.Filter[]	includeFilters Specifies which types are eligible for component scanning.
String	mongoTemplateRef Configures the name of the MongoTemplate bean to be used with the repositories detected.
String	namedQueriesLocation Configures the location of where to find the Spring Data named queries properties file.
org.springframework.data.repository.query.QueryLookupStrategy.Key	queryLookupStrategy Returns the key of the QueryLookupStrategy to be used for lookup queries for query methods.
Class<?>	repositoryFactoryBeanClass Returns the FactoryBean class to be used for each repository instance.
String	repositoryImplementationPostfix Returns the postfix to be used when looking up custom repository implementations.
String[]	value Alias for the basePackages() attribute.

Element Detail

value

public abstract String[] value

Alias for the basePackages() attribute. Allows for more concise annotation declarations e.g.: @EnableJpaRepositories("org.my.pkg") instead of @EnableJpaRepositories(basePackages="org.my.pkg").

Default:

{}

basePackages

public abstract String[] basePackages

Base packages to scan for annotated components. value() is an alias for (and mutually exclusive with) this attribute. Use basePackageClasses() for a type-safe alternative to String-based package names.

Default:

{}

basePackageClasses

public abstract Class<?>[] basePackageClasses

Type-safe alternative to 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.

Default:

{}

includeFilters

public abstract ComponentScan.Filter[] includeFilters

Specifies which types are eligible for component scanning. Further narrows the set of candidate components from everything in basePackages() to everything in the base packages that matches the given filter or filters.

Default:

{}

excludeFilters

public abstract ComponentScan.Filter[] excludeFilters

Specifies which types are not eligible for component scanning.

Default:

{}

repositoryImplementationPostfix

public abstract String repositoryImplementationPostfix

Returns the postfix to be used when looking up custom repository implementations. Defaults to Impl. So for a repository named PersonRepository the corresponding implementation class will be looked up scanning for PersonRepositoryImpl.

Returns:

Default:

""

namedQueriesLocation

public abstract String namedQueriesLocation

Configures the location of where to find the Spring Data named queries properties file. Will default to META-INFO/mongo-named-queries.properties.

Returns:

Default:

""

queryLookupStrategy

public abstract org.springframework.data.repository.query.QueryLookupStrategy.Key queryLookupStrategy

Returns the key of the QueryLookupStrategy to be used for lookup queries for query methods. Defaults to QueryLookupStrategy.Key.CREATE_IF_NOT_FOUND.

Returns:

Default:

org.springframework.data.repository.query.QueryLookupStrategy.Key.CREATE_IF_NOT_FOUND

repositoryFactoryBeanClass

public abstract Class<?> repositoryFactoryBeanClass

Returns the FactoryBean class to be used for each repository instance. Defaults to MongoRepositoryFactoryBean.

Returns:

Default:

org.springframework.data.mongodb.repository.support.MongoRepositoryFactoryBean.class

mongoTemplateRef

public abstract String mongoTemplateRef

Configures the name of the MongoTemplate bean to be used with the repositories detected.

Returns:

Default:

"mongoTemplate"

createIndexesForQueryMethods

public abstract boolean createIndexesForQueryMethods

Whether to automatically create indexes for query methods defined in the repository interface.

Returns:

Default:

false