io.micronaut.cache.interceptor

Class CacheInterceptor

java.lang.Object

io.micronaut.cache.interceptor.CacheInterceptor

All Implemented Interfaces:

Interceptor<Object,Object>, MethodInterceptor<Object,Object>, Ordered

@Singleton
public class CacheInterceptor
extends Object
implements MethodInterceptor<Object,Object>

An AOP MethodInterceptor implementation for the Cache annotations Cacheable, CachePut and CacheInvalidate.

Since:

1.0

Author:

Graeme Rocher

Field Summary

Fields

Modifier and Type	Field and Description
static int	POSITION The position on the interceptor in the chain.

Fields inherited from interface io.micronaut.aop.Interceptor

HOTSWAP, LAZY, PROXY_TARGET

Fields inherited from interface io.micronaut.core.order.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
CacheInterceptor(CacheManager cacheManager, CacheErrorHandler errorHandler, AsyncCacheErrorHandler asyncCacheErrorHandler, ExecutorService ioExecutor, BeanContext beanContext) Create Cache Interceptor with given arguments.

Method Summary

Modifier and Type	Method and Description
int	getOrder()
Object	intercept(MethodInvocationContext<Object,Object> context) Extended version of the MethodInterceptor.intercept(InvocationContext) method that accepts a MethodInvocationContext.
protected Object	interceptCompletableFuture(MethodInvocationContext<Object,Object> context, ReturnType<?> returnTypeObject, Class returnType) Intercept the async method invocation.
protected Object	interceptSync(MethodInvocationContext context, ReturnType returnTypeObject, Class returnType) Intercept the annotated method invocation with sync.
protected List<AnnotationValue<CacheInvalidate>>	invalidateOperations(MethodInvocationContext context) Evict from the cache.
protected List<AnnotationValue<CachePut>>	putOperations(MethodInvocationContext context) Saving inside the cache.
protected CacheKeyGenerator	resolveKeyGenerator(Class<? extends CacheKeyGenerator> type) Resolve the cache key generator from the give type.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.aop.MethodInterceptor

intercept

Field Detail

POSITION

public static final int POSITION

The position on the interceptor in the chain.

Constructor Detail

CacheInterceptor

public CacheInterceptor(CacheManager cacheManager,
                        CacheErrorHandler errorHandler,
                        AsyncCacheErrorHandler asyncCacheErrorHandler,
                        @Named(value="io")
                        ExecutorService ioExecutor,
                        BeanContext beanContext)

Create Cache Interceptor with given arguments.

Parameters:

cacheManager - The cache manager

errorHandler - Cache error handler

asyncCacheErrorHandler - Async cache error handlers

ioExecutor - The executor to create tasks

beanContext - The bean context to allow DI

Method Detail

getOrder

public int getOrder()

Specified by:

getOrder in interface Ordered

Returns:

The order of the object. Defaults to zero (no order).

intercept

public Object intercept(MethodInvocationContext<Object,Object> context)

Description copied from interface: MethodInterceptor

Extended version of the MethodInterceptor.intercept(InvocationContext) method that accepts a MethodInvocationContext.

Specified by:

intercept in interface MethodInterceptor<Object,Object>

Parameters:

context - The context

Returns:

The result

interceptSync

protected Object interceptSync(MethodInvocationContext context,
                               ReturnType returnTypeObject,
                               Class returnType)

Intercept the annotated method invocation with sync.

Parameters:

context - Contains information about method invocation

returnTypeObject - The return type of the method in Micronaut

returnType - The return type class

Returns:

The value from the cache

interceptCompletableFuture

protected Object interceptCompletableFuture(MethodInvocationContext<Object,Object> context,
                                            ReturnType<?> returnTypeObject,
                                            Class returnType)

Intercept the async method invocation.

Parameters:

context - Contains information about method invocation

returnTypeObject - The return type of the method in Micronaut

returnType - The return type class

Returns:

The value from the cache

putOperations

protected List<AnnotationValue<CachePut>> putOperations(MethodInvocationContext context)

Saving inside the cache.

Parameters:

context - Contains information about method invocation

Returns:

The operations to cause the return value to be cached within the given cache name.

invalidateOperations

protected List<AnnotationValue<CacheInvalidate>> invalidateOperations(MethodInvocationContext context)

Evict from the cache.

Parameters:

context - Extended version of InvocationContext for MethodInterceptor instances

Returns:

The operations to cause the eviction of the given caches

resolveKeyGenerator

protected CacheKeyGenerator resolveKeyGenerator(Class<? extends CacheKeyGenerator> type)

Resolve the cache key generator from the give type.

Parameters:

type - The key generator

Returns:

The cache key generator