com.netflix.hystrix.contrib.javanica.cache

Class CacheInvocationContext<A extends java.lang.annotation.Annotation>

java.lang.Object

com.netflix.hystrix.contrib.javanica.cache.CacheInvocationContext<A>

public class CacheInvocationContext<A extends java.lang.annotation.Annotation>
extends java.lang.Object

Runtime information about an intercepted method invocation for a method annotated with CacheResult, CacheRemove annotations.

Constructor Summary

Constructors

Constructor and Description
CacheInvocationContext(A cacheAnnotation, MethodExecutionAction cacheKeyMethod, java.lang.Object target, java.lang.reflect.Method method, java.lang.Object... args) Constructor to create CacheInvocationContext based on passed parameters.

Method Summary

Modifier and Type	Method and Description
java.util.List<CacheInvocationParameter>	getAllParameters() Gets all method parameters.
A	getCacheAnnotation()
MethodExecutionAction	getCacheKeyMethod() Gets action that invokes cache key method, the result of execution is used as cache key.
java.lang.String	getCacheKeyMethodName() Gets method name to be used to get a key for request caching.
ExecutionType	getExecutionType() Gets execution type of cache key action.
java.util.List<CacheInvocationParameter>	getKeyParameters() Returns a clone of the array of all method parameters annotated with CacheKey annotation to be used by the HystrixCacheKeyGenerator in creating a HystrixGeneratedCacheKey.
java.lang.reflect.Method	getMethod() Gets intercepted method that annotated with caching annotation.
java.lang.Object	getTarget() Gets current instance that can be used to invoke cacheKeyMethod or for another needs.
boolean	hasKeyParameters() Checks whether any method argument annotated with CacheKey annotation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CacheInvocationContext

public CacheInvocationContext(A cacheAnnotation,
                              MethodExecutionAction cacheKeyMethod,
                              java.lang.Object target,
                              java.lang.reflect.Method method,
                              java.lang.Object... args)

Constructor to create CacheInvocationContext based on passed parameters.

Parameters:

cacheAnnotation - the caching annotation, like CacheResult

cacheKeyMethod - the method to generate cache key

target - the current instance of intercepted method

method - the method annotated with on of caching annotations

args - the method arguments

Method Detail

getMethod

public java.lang.reflect.Method getMethod()

Gets intercepted method that annotated with caching annotation.

Returns:

method

getTarget

public java.lang.Object getTarget()

Gets current instance that can be used to invoke cacheKeyMethod or for another needs.

Returns:

current instance

getCacheAnnotation

public A getCacheAnnotation()

getAllParameters

public java.util.List<CacheInvocationParameter> getAllParameters()

Gets all method parameters.

Returns:

immutable list of CacheInvocationParameter objects

getKeyParameters

public java.util.List<CacheInvocationParameter> getKeyParameters()

Returns a clone of the array of all method parameters annotated with CacheKey annotation to be used by the HystrixCacheKeyGenerator in creating a HystrixGeneratedCacheKey. The returned array may be the same as or a subset of the array returned by getAllParameters().

Parameters in this array are selected by the following rules:

• If no parameters are annotated with CacheKey then all parameters are included
• If one or more CacheKey annotations exist only those parameters with the CacheKey annotation are included

Returns:

immutable list of CacheInvocationParameter objects

hasKeyParameters

public boolean hasKeyParameters()

Checks whether any method argument annotated with CacheKey annotation.

Returns:

true if at least one method argument with CacheKey annotation

getCacheKeyMethodName

public java.lang.String getCacheKeyMethodName()

Gets method name to be used to get a key for request caching.

Returns:

method name

getCacheKeyMethod

public MethodExecutionAction getCacheKeyMethod()

Gets action that invokes cache key method, the result of execution is used as cache key.

Returns:

cache key method execution action, see MethodExecutionAction.

getExecutionType

public ExecutionType getExecutionType()

Gets execution type of cache key action.

Returns:

execution type