io.micronaut.cache.annotation

Annotation Type CachePut

@Target(value={METHOD,TYPE})
 @Retention(value=RUNTIME)
 @Inherited
 @Documented
 @CacheConfig
 @Type(value=CacheInterceptor.class)
 @Repeatable(value=PutOperations.class)
public @interface CachePut

An annotation that can be applied at the type or method level to indicate that the annotated operation should cause the return value to be cached within the given cache name. Unlike Cacheable this annotation will never skip the original invocation.

Since:

1.0

Author:

Graeme Rocher

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	async Whether the CachePut operation should be performed asynchronously and not block the returning value
java.lang.String[]	cacheNames Alias for CacheConfig.cacheNames().
java.lang.Class<? extends CacheKeyGenerator>	keyGenerator Alias for CacheConfig.keyGenerator().
java.lang.String[]	parameters Limit the automatic CacheKeyGenerator to the given parameter names.
java.lang.String[]	value Alias for CacheConfig.cacheNames().

Element Detail

value

@AliasFor(member="cacheNames")
public abstract java.lang.String[] value

Alias for CacheConfig.cacheNames().

Returns:

The cache names

Default:

{}

cacheNames

@AliasFor(annotation=CacheConfig.class,
          member="cacheNames")
public abstract java.lang.String[] cacheNames

Alias for CacheConfig.cacheNames().

Returns:

The cache names

Default:

{}

keyGenerator

@AliasFor(annotation=CacheConfig.class,
          member="keyGenerator")
public abstract java.lang.Class<? extends CacheKeyGenerator> keyGenerator

Alias for CacheConfig.keyGenerator().

Returns:

The key generator class

Default:

io.micronaut.cache.interceptor.DefaultCacheKeyGenerator.class

parameters

public abstract java.lang.String[] parameters

Limit the automatic CacheKeyGenerator to the given parameter names. Mutually exclusive with keyGenerator()

Returns:

The parameter names that make up the key.

Default:

{}

async

public abstract boolean async

Whether the CachePut operation should be performed asynchronously and not block the returning value

The value if async impacts behaviour in the following ways:

• For blocking return types when the value is false the method will not return until the value has been written and any cache write errors will be propagated back to the client.
• For blocking return types when the value is true the method will return prior to cache writes occurring and errors will be logged via the AsyncCacheErrorHandler.
• When the return type is a CompletableFuture and the value is false the future will not complete until the CachePut operation is complete.
• When the return type is a CompletableFuture and the value is true the future will complete prior to any CachePut operations completing and the operations will be executing asynchronously with errors logged by AsyncCacheErrorHandler.

Returns:

True if cache writes should be done asynchronously

Default:

false