Package org.socialsignin.spring.data.dynamodb.repository.config

Annotation Type EnableDynamoDBRepositories

@Target(TYPE)
@Retention(RUNTIME)
@Documented
@Inherited
@Import(DynamoDBRepositoriesRegistrar.class)
public @interface EnableDynamoDBRepositories

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

Author:

Michael Lavelle, Sebastian Just

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	amazonDynamoDBRef	Returns the AmazonDynamoDB reference to be used for each repository instance
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.
String	dynamoDBMapperConfigRef	Returns the DynamoDBMapperConfig reference to be used for to configure AmazonDynamoDB
String	dynamoDBOperationsRef	Returns the Validator reference to be used for to validate DynamoDB entities
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	mappingContextRef	Returns the DynamoDBMappingContext reference for the MappingContext for AmazonDynamoDB.
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

String[] value

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

Returns:

The package name for scanning

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.

Returns:

The package name for scanning

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.

Returns:

The class to figure out the base package for scanning

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.

Returns:

All the include filters

Default:

{}

excludeFilters

org.springframework.context.annotation.ComponentScan.Filter[] excludeFilters

Specifies which types are not eligible for component scanning.

Returns:

All the exclude filters

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. Defaults to 'Impl'.

Returns:

The implementation postfix that's used

Default:

"Impl"

namedQueriesLocation

String namedQueriesLocation

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

Returns:

The location itself

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:

The lookup strategy

Default:

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

repositoryFactoryBeanClass

Class<?> repositoryFactoryBeanClass

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

Returns:

The repository factory bean cleass

Default:

org.socialsignin.spring.data.dynamodb.repository.support.DynamoDBRepositoryFactoryBean.class

amazonDynamoDBRef

String amazonDynamoDBRef

Returns the AmazonDynamoDB reference to be used for each repository instance

Returns:

The AmazonDynamoDB bean name

Default:

""

dynamoDBMapperConfigRef

String dynamoDBMapperConfigRef

Returns the DynamoDBMapperConfig reference to be used for to configure AmazonDynamoDB

Returns:

The DynamoDBMapperConfig bean name

Default:

""

dynamoDBOperationsRef

String dynamoDBOperationsRef

Returns the Validator reference to be used for to validate DynamoDB entities

Returns:

The DynamoDBOperations bean name

Default:

""

mappingContextRef

String mappingContextRef

Returns the DynamoDBMappingContext reference for the MappingContext for AmazonDynamoDB.

Returns:

The DynamoDBMappingContext bean name

Default:

""