Annotation Interface EnableReactiveNeo4jRepositories
@Target(TYPE)
@Retention(RUNTIME)
@Documented
@Inherited
@Import(org.springframework.data.neo4j.repository.config.ReactiveNeo4jRepositoriesRegistrar.class)
public @interface EnableReactiveNeo4jRepositories
Annotation to activate reactive Neo4j repositories. If no base package is configured through either
value()
,
basePackages()
or basePackageClasses()
it will trigger scanning of the package of annotated
configuration class.- Since:
- 6.0
- Author:
- Gerrit Meier, Michael J. Simons
-
Optional Element Summary
Modifier and TypeOptional ElementDescriptionClass<?>[]
Type-safe alternative tobasePackages()
for specifying the packages to scan for annotated components.String[]
Base packages to scan for annotated components.boolean
Configures whether nested repository-interfaces (e.g. defined as inner classes) should be discovered by the repositories infrastructure.Specifies which types are not eligible for component scanning.Specifies which types are eligible for component scanning.Configures the location of where to find the Spring Data named queries properties file.Configures the name of theNeo4jMappingContext
bean to be used with the repositories detected.Configures the name of theReactiveNeo4jTemplate
bean to be used with the repositories detected.Class<?>
Configure the repository base class to be used to create repository proxies for this particular configuration.Class<?>
Returns theFactoryBean
class to be used for each repository instance.Returns the postfix to be used when looking up custom repository implementations.Configures the name of theReactiveNeo4jTransactionManager
bean to be used with the repositories detected.String[]
Alias for thebasePackages()
attribute.
-
Element Details
-
value
Alias for thebasePackages()
attribute. Allows for more concise annotation declarations e.g.:@EnableReactiveNeo4jRepositories("org.my.pkg")
instead of@EnableReactiveNeo4jRepositories(basePackages="org.my.pkg")
.- Default:
- {}
-
basePackages
Base packages to scan for annotated components.value()
is an alias for (and mutually exclusive with) this attribute. UsebasePackageClasses()
for a type-safe alternative to String-based package names.- Default:
- {}
-
basePackageClasses
Class<?>[] basePackageClassesType-safe alternative tobasePackages()
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:
- {}
-
repositoryFactoryBeanClass
Class<?> repositoryFactoryBeanClassReturns theFactoryBean
class to be used for each repository instance. Defaults toReactiveNeo4jRepositoryFactoryBean
.- Default:
- org.springframework.data.neo4j.repository.support.ReactiveNeo4jRepositoryFactoryBean.class
-
repositoryBaseClass
Class<?> repositoryBaseClassConfigure the repository base class to be used to create repository proxies for this particular configuration.- Returns:
- The base class to be used when creating repository proxies.
- Default:
- org.springframework.data.repository.config.DefaultRepositoryBaseClass.class
-
neo4jMappingContextRef
String neo4jMappingContextRefConfigures the name of theNeo4jMappingContext
bean to be used with the repositories detected.- Default:
- "neo4jMappingContext"
-
neo4jTemplateRef
String neo4jTemplateRefConfigures the name of theReactiveNeo4jTemplate
bean to be used with the repositories detected.- Default:
- "reactiveNeo4jTemplate"
-
transactionManagerRef
String transactionManagerRefConfigures the name of theReactiveNeo4jTransactionManager
bean to be used with the repositories detected.- Default:
- "reactiveTransactionManager"
-
includeFilters
ComponentScan.Filter[] includeFiltersSpecifies which types are eligible for component scanning. Further narrows the set of candidate components from everything inbasePackages()
to everything in the base packages that matches the given filter or filters.- Default:
- {}
-
excludeFilters
ComponentScan.Filter[] excludeFiltersSpecifies which types are not eligible for component scanning.- Default:
- {}
-
namedQueriesLocation
String namedQueriesLocationConfigures the location of where to find the Spring Data named queries properties file. Will default toMETA-INFO/neo4j-named-queries.properties
.- Default:
- ""
-
repositoryImplementationPostfix
String repositoryImplementationPostfixReturns the postfix to be used when looking up custom repository implementations. Defaults to Impl. So for a repository namedPersonRepository
the corresponding implementation class will be looked up scanning forPersonRepositoryImpl
.- Default:
- "Impl"
-
considerNestedRepositories
boolean considerNestedRepositoriesConfigures whether nested repository-interfaces (e.g. defined as inner classes) should be discovered by the repositories infrastructure.- Default:
- false
-