SiteCacheWarmerImpl (Crafter Engine 4.0.2 API)

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

All Implemented Interfaces:

SiteCacheWarmer
```
public class SiteCacheWarmerImpl
extends Object
implements SiteCacheWarmer
```
Default implementation for SiteCacheWarmerImpl.

Since:

3.1.4

Author:

avasquez

Field Summary

Fields
Modifier and Type Field Description

protected org.craftercms.core.service.CacheService cacheService

protected List<ContextCacheWarmer> contextCacheWarmers

Constructor Summary

Constructors
Constructor Description

SiteCacheWarmerImpl()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`setCacheService(org.craftercms.core.service.CacheService cacheService)`	Sets the `CacheService`
`void`	`setContextCacheWarmers(List<ContextCacheWarmer> contextCacheWarmers)`	Sets the list of `ContextCacheWarmer` used to perfotm the warm up
`void`	`warmUpCache(SiteContext siteContext, boolean switchCache)`	Warms up the cache for the specified site context.

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

- Field Detail
  - cacheService
```
protected org.craftercms.core.service.CacheService cacheService
```
  - contextCacheWarmers
```
protected List<ContextCacheWarmer> contextCacheWarmers
```
- Constructor Detail
  - SiteCacheWarmerImpl
```
public SiteCacheWarmerImpl()
```
- Method Detail
  - setCacheService
```
public void setCacheService(org.craftercms.core.service.CacheService cacheService)
```
    Sets the CacheService
  - setContextCacheWarmers
```
public void setContextCacheWarmers(List<ContextCacheWarmer> contextCacheWarmers)
```
    Sets the list of ContextCacheWarmer used to perfotm the warm up
  - warmUpCache
```
public void warmUpCache(SiteContext siteContext,
                        boolean switchCache)
```
    Warms up the cache for the specified site context. If switchCache is true, then a new cache is created, warmed up and then switched with the current cache of the site.
    
    Specified by:
    
    warmUpCache in interface SiteCacheWarmer
    
    Parameters:
    
    siteContext - the site context
    
    switchCache - if a new cache should be warmed and then switched with the current cache