ContentStoreServiceTreeBasedContextCacheWarmer (Crafter Engine 4.0.2 API)

java.lang.Object
- org.craftercms.engine.cache.ContentStoreServiceTreeBasedContextCacheWarmer

All Implemented Interfaces:

ContextCacheWarmer
```
public class ContentStoreServiceTreeBasedContextCacheWarmer
extends Object
implements ContextCacheWarmer
```
ContextCacheWarmer that performs warm up at the ContentStoreService level by preloading a list of folder trees.

Since:

3.1.4

Author:

avasquez

Field Summary

Fields
Modifier and Type	Field	Description
`protected org.craftercms.core.service.ContentStoreService`	`contentStoreService`
`protected Map<String,Integer>`	`descriptorPreloadFolders`
`protected boolean`	`warmUpEnabled`

Constructor Summary

Constructors
Constructor Description

ContentStoreServiceTreeBasedContextCacheWarmer()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected Map<String,Integer>`	`getDescriptorPreloadFolders()`
`void`	`setContentStoreService(org.craftercms.core.service.ContentStoreService contentStoreService)`	Sets the content store service
`void`	`setDescriptorPreloadFolders(String[] descriptorPreloadFolders)`	Sets the list of descriptor folder trees to preload in the cache.
`void`	`setWarmUpEnabled(boolean warmUpEnabled)`	Sets if warm up is enabled
`void`	`warmUpCache(org.craftercms.core.service.Context context)`	Warm ups the cache associate to the context

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

Field Detail

warmUpEnabled
```
protected boolean warmUpEnabled
```

contentStoreService

protected org.craftercms.core.service.ContentStoreService contentStoreService

descriptorPreloadFolders

protected Map<String,Integer> descriptorPreloadFolders

Constructor Detail
- ContentStoreServiceTreeBasedContextCacheWarmer
```
public ContentStoreServiceTreeBasedContextCacheWarmer()
```

Method Detail
- setWarmUpEnabled
```
public void setWarmUpEnabled(boolean warmUpEnabled)
```
  Sets if warm up is enabled
- setContentStoreService
```
public void setContentStoreService(org.craftercms.core.service.ContentStoreService contentStoreService)
```
  Sets the content store service
- setDescriptorPreloadFolders
```
public void setDescriptorPreloadFolders(String[] descriptorPreloadFolders)
```
  Sets the list of descriptor folder trees to preload in the cache. Each folder can have it's depth specified after a colon, like PATH:DEPTH
- warmUpCache
```
public void warmUpCache(org.craftercms.core.service.Context context)
```
  Warm ups the cache associate to the context
  
  Specified by:
  
  warmUpCache in interface ContextCacheWarmer
  
  Parameters:
  
  context - the context
- getDescriptorPreloadFolders
```
protected Map<String,Integer> getDescriptorPreloadFolders()
```