Package org.springframework.data.redis.repository.configuration

Annotation Interface EnableRedisRepositories

@Target(TYPE) @Retention(RUNTIME) @Documented @Inherited @Import(RedisRepositoriesRegistrar.class) @QueryCreatorType(value=RedisQueryCreator.class, repositoryQueryType=RedisPartTreeQuery.class) public @interface EnableRedisRepositories
Annotation to activate Redis repositories. If no base package is configured through either value(), basePackages() or basePackageClasses() it will trigger scanning of the package of annotated class.
Since:
1.7
Author:
Christoph Strobl, Mark Paluch

  • Element Details

    • value

      String[] value
      Alias for the basePackages() attribute. Allows for more concise annotation declarations e.g.: @EnableRedisRepositories("org.my.pkg") instead of @EnableRedisRepositories(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:
      {}

    • excludeFilters

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

    • includeFilters

      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:
      {}

    • 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.
      Returns:
      Default:
      ""

    • queryLookupStrategy

      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 RedisRepositoryFactoryBean.
      Returns:
      Default:
      org.springframework.data.redis.repository.support.RedisRepositoryFactoryBean.class

    • repositoryBaseClass

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

    • keyValueTemplateRef

      String keyValueTemplateRef
      Configures the name of the KeyValueOperations bean to be used with the repositories detected.
      Returns:
      Default:
      "redisKeyValueTemplate"

    • considerNestedRepositories

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

    • redisTemplateRef

      String redisTemplateRef
      Configures the bean name of the RedisOperations to be used. Defaulted to redisTemplate.
      Returns:
      Default:
      "redisTemplate"

    • indexConfiguration

      Class<? extends IndexConfiguration> indexConfiguration
      Set up index patterns using simple configuration class.
      Returns:
      Default:
      org.springframework.data.redis.core.index.IndexConfiguration.class

    • keyspaceConfiguration

      Class<? extends KeyspaceConfiguration> keyspaceConfiguration
      Set up keyspaces for specific types.
      Returns:
      Default:
      org.springframework.data.redis.core.convert.KeyspaceConfiguration.class

    • enableKeyspaceEvents

      RedisKeyValueAdapter.EnableKeyspaceEvents enableKeyspaceEvents
      Configure usage of KeyExpirationEventMessageListener.
      Returns:
      Since:
      1.8
      Default:
      OFF

    • messageListenerContainerRef

      String messageListenerContainerRef
      Configure the name of the RedisMessageListenerContainer bean to be used for keyspace event subscriptions. Defaults to use an anonymous managed instance by RedisKeyValueAdapter.
      Returns:
      Since:
      2.7.2
      Default:
      ""

    • shadowCopy

      RedisKeyValueAdapter.ShadowCopy shadowCopy
      Configuration flag controlling storage of phantom keys (shadow copies) of expiring entities to read them later when publishing keyspace events.
      Returns:
      Since:
      2.4
      Default:
      DEFAULT

    • keyspaceNotificationsConfigParameter

      String keyspaceNotificationsConfigParameter
      Configure the notify-keyspace-events property if not already set.
      Use an empty String to keep (not alter) existing server configuration.
      Returns:
      Ex by default.
      Since:
      1.8
      Default:
      "Ex"