	Language
	English
	English
	English
	French
	German
	German
	German
	Italian
	Korean
	Spanish
	Catalan
	Dutch
	Portuguese
	Portuguese
	Arabic
	Arabic
	Bulgarian
	Bangla
	Bosnian
	Czech
	Greek
	Estonian
	Persian
	Finnish
	Danish
	Hindi
	Indonesian
	Icelandic
	Croatian
	Japanese
	Hungarian
	Hebrew
	Georgian
	Central Kurdish
	Khmer
	Kyrgyz
	Kazakh
	Lithuanian
	Latvian
	Malay
	Norwegian
	Polish
	Romanian
	Russian
	Slovak
	Slovenian
	Serbian
	Serbian
	Swedish
	Thai
	Turkish
	Ukrainian
	Uzbek
	Vietnamese
	Chinese
	Chinese

Cache

Cache component is used to reduce page load time by caching the content in a global cache after the initial rendering. Various cache providers are supported like ehcache and hazelcast. Showcase use actually this component to render source examples for every PrimeFaces components because parsing an xhtml file takes time, and since the rendering won't change during the whole lifecycle of the application, it's better to cache the content.

Cache Tag Documentation

Cache component is used to reduce page load time by caching the content after initial rendering.

Name	Type	Required	Default	Description
id	String	false	generated	Unique identifier of the component in a namingContainer.
rendered	boolean	false	true	Boolean value to specify the rendering of the component, when set to false component will not be rendered.
binding	UIComponent	false	generated	An EL expression referring to a server side UIComponent instance in a backing bean.
disabled	boolean	false	false	Disables caching.
key	String	false	Client Id	Unique id of the cache entry in region.
processEvents	boolean	false	false	When enabled, lifecycle events such as button actions are executed.
region	String	false	View Id	Unique id of the cache region.

Name	Description
No records found.

Name	Type	Default	Description
No records found.

Name	Library	Target
No records found.

Family org.primefaces.component

Type org.primefaces.component.Cache

Class org.primefaces.component.cache.UICache

Renderer Type org.primefaces.component.UICacheRenderer

Renderer Class org.primefaces.component.cache.UICacheRenderer

RESOURCES

Tag DocumentationNew DocumentationNew Documentation

tabscode.xhtml demonstrate how to use cache component declaratively
ShowcaseUtil demonstrate how to use cache API programmatically

tabscode.xhtml
ShowcaseUtil.java


<p:tabView var="entry" value="#{value}" touchable="false">
<p:tab title="#{entry.title}" >
    <p:cache region="sources" key="#{entry}">
<pre class="line-numbers"><code class="language-#{entry.type}">
#{entry.value}

</code></pre>
    </p:cache>
</p:tab>

<f:facet name="static-tabs">
    <ui:insert />
</f:facet>
    </p:tabView>


package org.primefaces.showcase.util;

import org.primefaces.cache.CacheProvider;
import org.primefaces.component.tabview.Tab;

import java.beans.IntrospectionException;
import java.beans.PropertyDescriptor;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.logging.Logger;

import jakarta.enterprise.inject.spi.CDI;
import jakarta.faces.application.ProjectStage;
import jakarta.faces.component.UIComponent;
import jakarta.faces.component.UIPanel;
import jakarta.faces.context.FacesContext;

public class ShowcaseUtil {

    private static final Logger LOGGER = Logger.getLogger(ShowcaseUtil.class.getName());

    private ShowcaseUtil() {

    }

    public static List<FileContent> getFilesContent(String fullPath, Boolean readBeans) {
        CacheProvider provider = CDI.current().select(ShowcaseCacheProvider.class).get().getCacheProvider();
        List<FileContent> files = (List<FileContent>) provider.get("contents", fullPath);

        if (files == null) {
            FacesContext facesContext = FacesContext.getCurrentInstance();
            FileContent srcContent = getFileContent(fullPath, readBeans);
            if (srcContent == null) {
                LOGGER.severe("File " + fullPath + " not found");
            }
            else {
                UIComponent tabs = UIComponent.getCurrentComponent(facesContext).getFacet("static-tabs");
                if (tabs != null) {
                    attach(tabs, srcContent);
                }
                files = new ArrayList<>();
                flatFileContent(srcContent, files);
            }

            if (facesContext.isProjectStage(ProjectStage.Production)) {
                provider.put("contents", fullPath, files);
            }
        }
        return files;
    }

    public static Object getPropertyValueViaReflection(Object o, String field)
            throws ReflectiveOperationException, IllegalArgumentException, IntrospectionException {
        return new PropertyDescriptor(field, o.getClass()).getReadMethod().invoke(o);
    }


}

Cache

Cache Tag Documentation

Reloading page