io.micronaut.cache.annotation.CachePut Maven / Gradle / Ivy
/*
* Copyright 2017-2020 original authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.micronaut.cache.annotation;
import io.micronaut.cache.interceptor.CacheInterceptor;
import io.micronaut.cache.interceptor.CacheKeyGenerator;
import io.micronaut.cache.interceptor.DefaultCacheKeyGenerator;
import io.micronaut.context.annotation.AliasFor;
import io.micronaut.context.annotation.Type;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* 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 {@link Cacheable} this annotation will never
* skip the original invocation.
*
* @author Graeme Rocher
* @since 1.0
*/
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
@CacheConfig
@Type(CacheInterceptor.class)
@Repeatable(PutOperations.class)
public @interface CachePut {
/**
* Alias for {@link CacheConfig#cacheNames}.
*
* @return The cache names
*/
@AliasFor(member = "cacheNames")
String[] value() default {};
/**
* Alias for {@link CacheConfig#cacheNames}.
*
* @return The cache names
*/
@AliasFor(annotation = CacheConfig.class, member = "cacheNames")
String[] cacheNames() default {};
/**
* Alias for {@link CacheConfig#keyGenerator}.
*
* @return The key generator class
*/
@AliasFor(annotation = CacheConfig.class, member = "keyGenerator")
Class keyGenerator() default DefaultCacheKeyGenerator.class;
/**
* Limit the automatic {@link CacheKeyGenerator} to the given parameter names. Mutually exclusive with
* {@link #keyGenerator()}
*
* @return The parameter names that make up the key.
*/
String[] parameters() default {};
/**
* Whether the {@link 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 {@link io.micronaut.cache.AsyncCacheErrorHandler}.
* - When the return type is a {@link java.util.concurrent.CompletableFuture} and the value is false
* the future will not complete until the {@link CachePut} operation is complete.
* - When the return type is a {@link java.util.concurrent.CompletableFuture} and the value is true
* the future will complete prior to any {@link CachePut} operations completing and the operations will be
* executing asynchronously with errors logged by {@link io.micronaut.cache.AsyncCacheErrorHandler}.
*
*
* @return True if cache writes should be done asynchronously
*/
boolean async() default false;
}