Module io.ebean.annotation
Package io.ebean.annotation

Annotation Type CacheBeanTuning

@Target(TYPE) @Retention(RUNTIME) public @interface CacheBeanTuning
Cache tuning hints for the L2 bean cache of a specific entity type.

Note that this is not useful when distributed L2 bean caches are used like ElasticSearch, Hazelcast, Ignite etc.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    int
    maxIdleSecs
    The maximum time (in seconds) that a cache entry is allowed to stay in the cache when it has not been accessed.
    int
    maxSecsToLive
    The maximum time (in seconds) a cache entry is allowed to stay in the cache.
    int
    maxSize
    The maximum size for the cache.
    int
    trimFrequency
    The frequency (in seconds) that cache trimming should occur.

  • Element Details

    • maxSize

      int maxSize
      The maximum size for the cache.

      This defaults to 0 which means unlimited.

      Default:
      0

    • maxIdleSecs

      int maxIdleSecs
      The maximum time (in seconds) that a cache entry is allowed to stay in the cache when it has not been accessed.

      This defaults to 0 which means unlimited.

      Default:
      0

    • maxSecsToLive

      int maxSecsToLive
      The maximum time (in seconds) a cache entry is allowed to stay in the cache.

      This is not generally required as the cache entries are automatically evicted when related data changes are committed.

      This defaults to 0 which means unlimited.

      Default:
      0

    • trimFrequency

      int trimFrequency
      The frequency (in seconds) that cache trimming should occur.

      This is a hint for cache implementations that use background cache trimming.

      Default:
      0