org.springframework.boot.actuate.endpoint.cache

Class CachingOperationInvoker

java.lang.Object

org.springframework.boot.actuate.endpoint.cache.CachingOperationInvoker

All Implemented Interfaces:

OperationInvoker

public class CachingOperationInvoker
extends Object
implements OperationInvoker

An OperationInvoker that caches the response of an operation with a configurable time to live.

Since:

2.0.0

Author:

Stephane Nicoll

Constructor Summary

Constructors

Constructor and Description
CachingOperationInvoker(OperationInvoker target, long timeToLive) Create a new instance with the target OperationInvoker to use to compute the response and the time to live for the cache.

Method Summary

Modifier and Type	Method and Description
static OperationInvoker	apply(OperationInvoker invoker, long timeToLive) Apply caching configuration when appropriate to the given invoker.
long	getTimeToLive() Return the maximum time in milliseconds that a response can be cached.
Object	invoke(Map<String,Object> arguments) Invoke the underlying operation using the given arguments.

Methods inherited from class java.lang.Object

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

Constructor Detail

CachingOperationInvoker

public CachingOperationInvoker(OperationInvoker target,
                               long timeToLive)

Create a new instance with the target OperationInvoker to use to compute the response and the time to live for the cache.

Parameters:

target - the OperationInvoker this instance wraps

timeToLive - the maximum time in milliseconds that a response can be cached

Method Detail

getTimeToLive

public long getTimeToLive()

Return the maximum time in milliseconds that a response can be cached.

Returns:

the time to live of a response

invoke

public Object invoke(Map<String,Object> arguments)

Description copied from interface: OperationInvoker

Invoke the underlying operation using the given arguments.

Specified by:

invoke in interface OperationInvoker

Parameters:

arguments - the arguments to pass to the operation

Returns:

the result of the operation, may be null

apply

public static OperationInvoker apply(OperationInvoker invoker,
                                     long timeToLive)

Apply caching configuration when appropriate to the given invoker.

Parameters:

invoker - the invoker to wrap

timeToLive - the maximum time in milliseconds that a response can be cached

Returns:

a caching version of the invoker or the original instance if caching is not required