ContentViewCache (Nuxeo ECM Projects 9.2-SNAPSHOT API)

java.lang.Object
- org.nuxeo.ecm.platform.contentview.jsf.ContentViewCache

All Implemented Interfaces:

Serializable
```
public class ContentViewCache
extends Object
implements Serializable
```
Cache for content views, handling cache keys set on content views.
Each content view instance will be cached if its cache key is not null. Each instance will be cached using the cache key so its state is restored. Also handles refresh of caches when receiving events configured on the content view.

Since:

5.4

Author:

Anahide Tchertchian

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Map<String,Map<String,ContentView>>`	`cacheInstances`
`static Integer`	`DEFAULT_CACHE_SIZE` Default cache size, set to 5 instances per content view
`protected Map<String,String>`	`namedCacheKeys`
`protected Map<String,ContentView>`	`namedContentViews`
`protected Map<String,Set<String>>`	`refreshEventToContentViewName` Map holding content view names that need their page provider to be refreshed for a given event
`protected Map<String,Set<String>>`	`resetEventToContentViewName` Map holding content view names that need their page provider to be reset for a given event

Constructor Summary

Constructors
Constructor and Description

ContentViewCache()

Constructors
Constructor and Description
`ContentViewCache()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(ContentView cView)` Add given content view to the cache, resolving its cache key and initializing it with its cache size.
`ContentView`	`get(String name)` Returns cached content view with given name, or null if not found.
`void`	`refresh(String contentViewName, boolean rewind)` Refresh page providers for content views in the cache with given name.refreshEventToContentViewName
`void`	`refreshAll()` Iterates over all cached content view instances to refresh them.
`protected void`	`refreshAll(boolean rewind)`
`void`	`refreshAndRewindAll()` Iterates over all cached content view instances to refresh them.
`void`	`refreshOnEvent(String eventName)` Refresh page providers for content views having declared given event as a refresh event.
`void`	`reset(String contentViewName)` Resets all cached information for given content view.
`void`	`resetAll()` Resets all cached information for all content views, as well as configuration caches (refresh and reset events linked to content views).
`void`	`resetAllContent()` Resets all cached information for all content views
`void`	`resetPageProvider(String contentViewName)` Resets page providers for content views in the cache with given name.
`void`	`resetPageProviderAggregates(String contentViewName)` Resets page providers aggregates.
`void`	`resetPageProviderOnEvent(String eventName)` Resets page providers for content views having declared given event as a reset event.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_CACHE_SIZE
```
public static final Integer DEFAULT_CACHE_SIZE
```
    Default cache size, set to 5 instances per content view
  - namedCacheKeys
```
protected final Map<String,String> namedCacheKeys
```
  - namedContentViews
```
protected final Map<String,ContentView> namedContentViews
```
  - cacheInstances
```
protected final Map<String,Map<String,ContentView>> cacheInstances
```
  - refreshEventToContentViewName
```
protected final Map<String,Set<String>> refreshEventToContentViewName
```
    Map holding content view names that need their page provider to be refreshed for a given event
  - resetEventToContentViewName
```
protected final Map<String,Set<String>> resetEventToContentViewName
```
    Map holding content view names that need their page provider to be reset for a given event
- Constructor Detail
  - ContentViewCache
```
public ContentViewCache()
```
- Method Detail
  - add
```
public void add(ContentView cView)
```
    Add given content view to the cache, resolving its cache key and initializing it with its cache size.
    Since 5.7, content views with a cache size <= 0 will be cached anyhow to handle selections, and rendering is in charge of forcing cache reset when re-displaying the page.
  - get
```
public ContentView get(String name)
```
    Returns cached content view with given name, or null if not found.
  - refresh
```
public void refresh(String contentViewName,
                    boolean rewind)
```
    Refresh page providers for content views in the cache with given name.refreshEventToContentViewName
    Other contextual information set on the content view and the page provider will be kept.
  - resetPageProvider
```
public void resetPageProvider(String contentViewName)
```
    Resets page providers for content views in the cache with given name.
    Other contextual information set on the content view will be kept.
  - resetPageProviderAggregates
```
public void resetPageProviderAggregates(String contentViewName)
```
    Resets page providers aggregates.
    
    Since:
    
    6.0
  - refreshOnEvent
```
public void refreshOnEvent(String eventName)
```
    Refresh page providers for content views having declared given event as a refresh event.
    Other contextual information set on the content view and the page provider will be kept.
  - resetPageProviderOnEvent
```
public void resetPageProviderOnEvent(String eventName)
```
    Resets page providers for content views having declared given event as a reset event.
    Other contextual information set on the content view will be kept.
  - reset
```
public void reset(String contentViewName)
```
    Resets all cached information for given content view.
  - resetAllContent
```
public void resetAllContent()
```
    Resets all cached information for all content views
  - resetAll
```
public void resetAll()
```
    Resets all cached information for all content views, as well as configuration caches (refresh and reset events linked to content views).
  - refreshAll
```
public void refreshAll()
```
    Iterates over all cached content view instances to refresh them.
    Can be costly if some page providers need to fetch content or perform costly operations at refresh.
    
    Since:
    
    5.7
  - refreshAndRewindAll
```
public void refreshAndRewindAll()
```
    Iterates over all cached content view instances to refresh them.
    Can be costly if some page providers need to fetch content or perform costly operations at refresh.
    
    Since:
    
    5.7
  - refreshAll
```
protected void refreshAll(boolean rewind)
```
    Since:
    
    5.7

Class ContentViewCache

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_CACHE_SIZE

namedCacheKeys

namedContentViews

cacheInstances

refreshEventToContentViewName

resetEventToContentViewName

Constructor Detail

ContentViewCache

Method Detail

add

get

refresh

resetPageProvider

resetPageProviderAggregates

refreshOnEvent

resetPageProviderOnEvent

reset

resetAllContent

resetAll

refreshAll

refreshAndRewindAll

refreshAll