io.micronaut.cache.management

Class CachesEndpoint

java.lang.Object

io.micronaut.cache.management.CachesEndpoint

@Endpoint(id="caches",
          defaultEnabled=false)
public class CachesEndpoint
extends java.lang.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 java.lang.String	NAME Endpoint name.

Constructor Summary

Constructors

Constructor and Description
CachesEndpoint(CacheManager<java.lang.Object> cacheManager)

Method Summary

Modifier and Type	Method and Description
io.reactivex.Maybe<java.util.Map<java.lang.String,java.lang.Object>>	getCache(@NotBlank java.lang.String name) Returns the cache as a Maybe.
io.reactivex.Single<java.util.Map<java.lang.String,java.lang.Object>>	getCaches() Returns the caches as a Single.
io.reactivex.Maybe<java.lang.Boolean>	invalidateCache(@NotBlank java.lang.String name) Invalidates the cache.
io.reactivex.Maybe<java.lang.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 java.lang.String NAME

Endpoint name.

See Also:

Constant Field Values

Constructor Detail

CachesEndpoint

public CachesEndpoint(CacheManager<java.lang.Object> cacheManager)

Parameters:

cacheManager - The CacheManager

Method Detail

getCaches

@Read
public io.reactivex.Single<java.util.Map<java.lang.String,java.lang.Object>> getCaches()

Returns the caches as a Single.

Returns:

The caches as a Single

getCache

@Read
public io.reactivex.Maybe<java.util.Map<java.lang.String,java.lang.Object>> getCache(@NotBlank @Selector
                                                                                           @NotBlank java.lang.String name)

Returns the cache as a Maybe.

Parameters:

name - The name of the cache to retrieve

Returns:

The cache as a Single

invalidateCaches

@Delete
public io.reactivex.Maybe<java.lang.Boolean> invalidateCaches()

Invalidates all the caches.

Returns:

A maybe that emits a boolean.

invalidateCache

@Delete
public io.reactivex.Maybe<java.lang.Boolean> invalidateCache(@NotBlank @Selector
                                                                     @NotBlank java.lang.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