Package io.micronaut.controlpanel.panels.cache

Class AbstractCacheControlPanel<C extends io.micronaut.cache.SyncCache<?>>

java.lang.Object

io.micronaut.controlpanel.core.AbstractControlPanel<AbstractCacheControlPanel.Body>

io.micronaut.controlpanel.core.AbstractEachBeanControlPanel<AbstractCacheControlPanel.Body>

io.micronaut.controlpanel.panels.cache.AbstractCacheControlPanel<C>

Type Parameters:

C - the cache type

All Implemented Interfaces:

ConfigurableControlPanel, ControlPanel<AbstractCacheControlPanel.Body>, io.micronaut.core.naming.Named, io.micronaut.core.order.Ordered, io.micronaut.core.util.Toggleable

Direct Known Subclasses:

CaffeineCacheControlPanel, EhcacheControlPanel, HazelcastSyncCacheControlPanel, InfinispanSyncCacheControlPanel

public abstract class AbstractCacheControlPanel<C extends io.micronaut.cache.SyncCache<?>>
extends AbstractEachBeanControlPanel<AbstractCacheControlPanel.Body>

Base class for control panels for managing caches. This class provides common functionality for displaying cache information and operations in the Micronaut Control Panel.

Since:

2.0.0

Author:

Álvaro Sánchez-Mariscal

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	AbstractCacheControlPanel.Body	Record containing the data to display in the cache control panel.

Nested classes/interfaces inherited from interface io.micronaut.controlpanel.core.ControlPanel

ControlPanel.Category, ControlPanel.View

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ENABLED_PROPERTY	The property name to enable/disable cache control panels.
static final String	NAME	The name of the cache control panel category.

Fields inherited from class io.micronaut.controlpanel.core.AbstractControlPanel

configuration, controlPanelName

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractCacheControlPanel(String controlPanelName, ControlPanelConfiguration configuration)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getBadge()	Returns the badge displaying the cache size, or the default badge if size cannot be determined.
protected String	getBeanName()	Returns the name of the bean this control panel represents.
AbstractCacheControlPanel.Body	getBody()	Used to render the body of the control panel.
protected abstract C	getCache()
protected abstract Map<String,Object>	getCacheAsMap()
protected Optional<Long>	getCacheSize()	Attempts to determine the size of the cache.
ControlPanel.Category	getCategory()	Returns the category for cache control panels.
String	getIcon()	Returns the icon for cache control panels.
protected String	getPanelName()	Returns the name of the panel category.

Methods inherited from class io.micronaut.controlpanel.core.AbstractEachBeanControlPanel

getBodyView, getDetailedView, getName, getTitle

Methods inherited from class io.micronaut.controlpanel.core.AbstractControlPanel

getOrder, isEnabled

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.controlpanel.core.ControlPanel

hasDetails

Field Details

NAME

public static final String NAME

The name of the cache control panel category.

See Also:

• Constant Field Values

ENABLED_PROPERTY

public static final String ENABLED_PROPERTY

The property name to enable/disable cache control panels.

See Also:

• Constant Field Values

Constructor Details

AbstractCacheControlPanel

protected AbstractCacheControlPanel(String controlPanelName,
 @Named("cache")
 ControlPanelConfiguration configuration)

Constructor.

Parameters:

controlPanelName - the control panel name

configuration - the control panel configuration

Method Details

getCache

protected abstract C getCache()

getBeanName

protected String getBeanName()

Description copied from class: AbstractEachBeanControlPanel

Returns the name of the bean this control panel represents.

Specified by:

getBeanName in class AbstractEachBeanControlPanel<AbstractCacheControlPanel.Body>

Returns:

the bean name

getBody

public AbstractCacheControlPanel.Body getBody()

Description copied from interface: ControlPanel

Used to render the body of the control panel.

Returns:

the body of the control panel.

getPanelName

protected String getPanelName()

Description copied from class: AbstractEachBeanControlPanel

Returns the name of the panel category.

Specified by:

getPanelName in class AbstractEachBeanControlPanel<AbstractCacheControlPanel.Body>

Returns:

the panel name

getBadge

public String getBadge()

Returns the badge displaying the cache size, or the default badge if size cannot be determined.

Returns:

the badge text

getCacheSize

protected Optional<Long> getCacheSize()

Attempts to determine the size of the cache. Supports Map-based caches and Iterable-based caches. Subclasses can override this method to provide more accurate size calculations for specific cache implementations.

Returns:

an Optional containing the cache size, or empty if it cannot be determined

getCacheAsMap

protected abstract Map<String,Object> getCacheAsMap()

getCategory

public ControlPanel.Category getCategory()

Returns the category for cache control panels.

Returns:

the cache category

getIcon

public String getIcon()

Returns the icon for cache control panels.

Specified by:

getIcon in interface ConfigurableControlPanel

Overrides:

getIcon in class AbstractControlPanel<AbstractCacheControlPanel.Body>

Returns:

the icon name