Package org.springframework.data.solr.repository.config

Annotation Interface EnableSolrRepositories

@Target(TYPE)
@Retention(RUNTIME)
@Documented
@Inherited
@Import(org.springframework.data.solr.repository.config.SolrRepositoriesRegistrar.class)
public @interface EnableSolrRepositories

Annotation to enable Solr repositories. Will scan the package of the annotated configuration class for Spring Data repositories by default.

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.
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.
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.
boolean	schemaCreationSupport	Configure schema creation support using the solr schema api.
String	solrClientRef	Configures the name of the org.apache.solr.client.solrj bean definition to be used for creating templates
String	solrTemplateRef	Configures the name of the SolrTemplate bean definition to be used to create repositories discovered through this annotation.
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.: @EnableSolrRepositories("org.my.pkg") instead of @EnableSolrRpositories(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:

Default:

"Impl"

namedQueriesLocation

String namedQueriesLocation

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

Returns:

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:

Default:

CREATE_IF_NOT_FOUND

repositoryFactoryBeanClass

Class<?> repositoryFactoryBeanClass

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

Returns:

Default:

org.springframework.data.solr.repository.support.SolrRepositoryFactoryBean.class

repositoryBaseClass

Class<?> repositoryBaseClass

Configure the repository base class to be used to create repository proxies for this particular configuration.

Returns:

Since:

1.5

Default:

org.springframework.data.repository.config.DefaultRepositoryBaseClass.class

solrTemplateRef

String solrTemplateRef

Configures the name of the SolrTemplate bean definition to be used to create repositories discovered through this annotation. Defaults to solrTemplate.

Returns:

Default:

"solrTemplate"

solrClientRef

String solrClientRef

Configures the name of the org.apache.solr.client.solrj bean definition to be used for creating templates

Since:

1.1

Default:

"solrClient"

schemaCreationSupport

boolean schemaCreationSupport

Configure schema creation support using the solr schema api.

Since:

1.3

Default:

false

considerNestedRepositories

boolean considerNestedRepositories

Configures whether nested repository-interfaces (e.g. defined as inner classes) should be discovered by the repositories infrastructure.

Since:

2.1

Default:

false