com.netflix.hystrix.contrib.javanica.cache.annotation

Annotation Type CacheResult

@Target(value=METHOD)
@Retention(value=RUNTIME)
@Documented
public @interface CacheResult

Marks a methods that results should be cached for a Hystrix command. This annotation must be used in conjunction with HystrixCommand annotation.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	cacheKeyMethod Method name to be used to get a key for request caching.

Element Detail

cacheKeyMethod

public abstract java.lang.String cacheKeyMethod

Method name to be used to get a key for request caching. The command and cache key method should be placed in the same class and have same method signature except cache key method return type, that should be String.

cacheKeyMethod has higher priority than an arguments of a method, that means what actual arguments of a method that annotated with CacheResult will not be used to generate cache key, instead specified cacheKeyMethod fully assigns to itself responsibility for cache key generation. By default this returns empty string which means "do not use cache method".

Returns:

method name or empty string

Default:

""