OpenCms Documentation

Caches

 Show GitHub edit links  Hide GitHub edit links
In OpenCms since: 6.0 Valid for OpenCms: 11.0.0

Via the caches app, you can flush the different caches and also get an overview of the cached items for flex and image cache.

The caches apps

Caches is a collection of three cache administration apps:

  • Cache statistics: Provides options to flush caches and an overview on the current memory consumption.
  • Flex cache: Provides an overview on all flex cache entries and their variations.
  • Image cache: Provides an overview on all cached images and their variations.
Fig. [cache_administration]: The apps for cache administration

Cache statistics

The Cache statistics app provides easy access for flushing the various caches. Moreover, it provides a statistics on the memory consumption of your system and the specifically on the memory consumption of the flex cache.

Fig. [cache_statistics_app]: The Cache statistics app

Flush caches

Some of the cache flushing tools provide extra options. Here we provide an overview of these options.

Flushing tools and options
Core Cache

Core cache flushing always flushes the whole cache. No options are available. What exactly happens depends on your installation. Technically, an event is sent that can be handled in various places.

Flex Cache

For flushing, you can choose if you want to flush the cache for online resources and if you want to flush the whole cache (keys and variations), or only the stored variations of HTML output.

Image Cache

The image cache flushing tool allows a date to be specified, such that only images (image variations) are removed that have not been requested after the given date.

Initialize the workplace

Reinitializes workplace related options, e.g. the workplace message bundle.Calls org.opencms.workplace.CmsWorkplaceManager#initialize(CmsObject). Additionally the core cache is flushed.

JSP Repository

The JSP repository can only be flushed completely. Afterwards, all JSPs that are requested must be exported to the server again, before they are executed.

Flex cache

The Flex cache app lists all cached entries and via the context menu you can show the single cached variations. Moreover, in the toolbar, you can get the statistics of the cache's memory consumption and access to the cache flushing options for all caches.

Fig. [Flex cache app]: The flex cache app
Get more information on the flex cache here.

Image cache

The image cache app allows to search via a regex on the image paths to search for cached images. For each image, an overview on the cached variations is provided. Moreover, in the toolbar, you can get the statistics of the cache's memory consumption and access to the cache flushing options for all caches.

Fig. [Image cache app]: The image cache app

Get some more information on image handling in OpenCms here.

You can improve this page

Please contribute your suggestions or comments regarding this topic on our wiki. For support questions, please use the OpenCms mailing list or go for professional support.