Package org.opencms.pdftools

Class CmsPdfCache

java.lang.Object

org.opencms.cache.CmsVfsNameBasedDiskCache

org.opencms.pdftools.CmsPdfCache

public class CmsPdfCache
extends CmsVfsNameBasedDiskCache

Cache class for storing generated PDFs in the RFS.

This class stores all cached files in a single folder.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PDF_CACHE_FOLDER	The folder name for the cache folder.

Constructor Summary

Constructors

Constructor	Description
CmsPdfCache()	Creates a new cache instance.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getCacheName(CmsResource resource, java.lang.String parameters)	Returns the RFS name to use for caching the given VFS resource with parameters in the disk cache.

Methods inherited from class org.opencms.cache.CmsVfsNameBasedDiskCache

getCacheContent, getRepositoryPath, hasCacheContent, saveCacheFile

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PDF_CACHE_FOLDER

public static final java.lang.String PDF_CACHE_FOLDER

The folder name for the cache folder.

See Also:

Constant Field Values

Constructor Detail

CmsPdfCache

public CmsPdfCache()

Creates a new cache instance.

Method Detail

getCacheName

public java.lang.String getCacheName(CmsResource resource,
                                     java.lang.String parameters)

Description copied from class: CmsVfsNameBasedDiskCache

Returns the RFS name to use for caching the given VFS resource with parameters in the disk cache.

Overrides:

getCacheName in class CmsVfsNameBasedDiskCache

Parameters:

resource - the VFS resource to generate the cache name for

parameters - the parameters of the request to the VFS resource

Returns:

the RFS name to use for caching the given VFS resource with parameters

See Also:

CmsVfsNameBasedDiskCache.getCacheName(org.opencms.file.CmsResource, java.lang.String)