io.micronaut.cache.management

Class CachesEndpoint

java.lang.Object

io.micronaut.cache.management.CachesEndpoint

@Endpoint(id="caches",
          defaultEnabled=false)
public class CachesEndpoint
extends Object

Exposes an Endpoint to manage caches.

Since:

1.1.0

Author:

Marcel Overdijk, graemerocher

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME Endpoint name.

Constructor Summary

Constructors

Constructor and Description
CachesEndpoint(CacheManager<Object> cacheManager)

Method Summary

Modifier and Type	Method and Description
reactor.core.publisher.Mono<Map<String,Object>>	getCache(@NotBlank String name) Returns the cache as a Mono.
reactor.core.publisher.Mono<Map<String,Object>>	getCaches() Returns the caches as a Mono.
reactor.core.publisher.Mono<Boolean>	invalidateCache(@NotBlank String name) Invalidates the cache.
reactor.core.publisher.Mono<Boolean>	invalidateCacheKey(@NotBlank String name, @NotBlank String key) Invalidates a key within the provided cache.
reactor.core.publisher.Mono<Boolean>	invalidateCaches() Invalidates all the caches.

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

Endpoint name.

See Also:

Constant Field Values

Constructor Detail

CachesEndpoint

public CachesEndpoint(CacheManager<Object> cacheManager)

Parameters:

cacheManager - The CacheManager

Method Detail

getCaches

@Read
public reactor.core.publisher.Mono<Map<String,Object>> getCaches()

Returns the caches as a Mono.

Returns:

The caches as a Mono

getCache

@Read
public reactor.core.publisher.Mono<Map<String,Object>> getCache(@NotBlank @Selector
                                                                      @NotBlank String name)

Returns the cache as a Mono.

Parameters:

name - The name of the cache to retrieve

Returns:

The cache as a Mono

invalidateCaches

@Delete
public reactor.core.publisher.Mono<Boolean> invalidateCaches()

Invalidates all the caches.

Returns:

A maybe that emits a boolean.

invalidateCache

@Delete
public reactor.core.publisher.Mono<Boolean> invalidateCache(@NotBlank @Selector
                                                                    @NotBlank String name)

Invalidates the cache.

Parameters:

name - The name of the cache to invalidate

Returns:

A maybe that emits a boolean if the operation was successful

invalidateCacheKey

@Delete
public reactor.core.publisher.Mono<Boolean> invalidateCacheKey(@NotBlank @Selector
                                                                       @NotBlank String name,
                                                                       @NotBlank @Selector
                                                                       @NotBlank String key)

Invalidates a key within the provided cache.

Parameters:

name - The name of the cache

key - the key within the cache to invalidate

Returns:

A maybe that emits a boolean if the operation was successful