Package org.springframework.data.mongodb.repository.config

Annotation Interface EnableReactiveMongoRepositories

@Target(TYPE) @Retention(RUNTIME) @Documented @Inherited @Import(org.springframework.data.mongodb.repository.config.ReactiveMongoRepositoriesRegistrar.class) public @interface EnableReactiveMongoRepositories
Annotation to activate reactive MongoDB repositories. If no base package is configured through either value(), basePackages() or basePackageClasses() it will trigger scanning of the package of annotated class.
Since:
2.0
Author:
Mark Paluch

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    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
    considerNestedRepositories
    Configures whether nested repository-interfaces (e.g. defined as inner classes) should be discovered by the repositories infrastructure.
    boolean
    createIndexesForQueryMethods
    Whether to automatically create indexes for query methods defined in the repository interface.
    org.springframework.context.annotation.ComponentScan.Filter[]
    excludeFilters
    Specifies which types are not eligible for component scanning.
    org.springframework.context.annotation.ComponentScan.Filter[]
    includeFilters
    Specifies which types are eligible for component scanning.
    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.
    String
    reactiveMongoTemplateRef
    Configures the name of the MongoTemplate bean to be used with the repositories detected.
    Class<?>
    repositoryBaseClass
    Configure the repository base class to be used to create repository proxies for this particular configuration.
    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 Details

    • value

      String[] value
      Alias for the basePackages() attribute. Allows for more concise annotation declarations e.g.: @EnableReactiveMongoRepositories("org.my.pkg") instead of @EnableReactiveMongoRepositories(basePackages="org.my.pkg").
      Default:
      {}

    • basePackages

      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

      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

      org.springframework.context.annotation.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

      org.springframework.context.annotation.ComponentScan.Filter[] excludeFilters
      Specifies which types are not eligible for component scanning.
      Default:
      {}

    • repositoryImplementationPostfix

      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:
      Impl by default.
      Default:
      "Impl"

    • namedQueriesLocation

      String namedQueriesLocation
      Configures the location of where to find the Spring Data named queries properties file. Will default to META-INF/mongo-named-queries.properties.
      Returns:
      empty String by default.
      Default:
      ""

    • queryLookupStrategy

      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:
      QueryLookupStrategy.Key.CREATE_IF_NOT_FOUND by default.
      Default:
      CREATE_IF_NOT_FOUND

    • repositoryFactoryBeanClass

      Class<?> repositoryFactoryBeanClass
      Returns the FactoryBean class to be used for each repository instance. Defaults to MongoRepositoryFactoryBean.
      Returns:
      ReactiveMongoRepositoryFactoryBean by default.
      Default:
      org.springframework.data.mongodb.repository.support.ReactiveMongoRepositoryFactoryBean.class

    • repositoryBaseClass

      Class<?> repositoryBaseClass
      Configure the repository base class to be used to create repository proxies for this particular configuration.
      Returns:
      DefaultRepositoryBaseClass by default.
      Default:
      org.springframework.data.repository.config.DefaultRepositoryBaseClass.class

    • reactiveMongoTemplateRef

      String reactiveMongoTemplateRef
      Configures the name of the MongoTemplate bean to be used with the repositories detected.
      Returns:
      reactiveMongoTemplate by default.
      Default:
      "reactiveMongoTemplate"

    • createIndexesForQueryMethods

      boolean createIndexesForQueryMethods
      Whether to automatically create indexes for query methods defined in the repository interface.
      Returns:
      false by default.
      Default:
      false

    • considerNestedRepositories

      boolean considerNestedRepositories
      Configures whether nested repository-interfaces (e.g. defined as inner classes) should be discovered by the repositories infrastructure.
      Returns:
      false by default.
      Default:
      false