com.groupdocs.viewer.caching

Class CacheKeys

java.lang.Object

com.groupdocs.viewer.caching.CacheKeys

public class CacheKeys
extends Object

Provides methods to retrieve the unique identifier for a cache entry.

The class allows you to generate cache keys based on different parameters, such as the document path, rendering options, and resource name. These cache keys can be used to store and retrieve cached data for efficient document rendering.

Example usage:

 // Generate a cache key for a file
 String fileKey = CacheKeys.getFileKey("filename.pdf");

 // Generate a cache key for a page
 String pageKey = CacheKeys.getPageKey(pageNumber, FileType.HTML.getExtension());

 // Generate a cache key for a resource
 Resource resource = new Resource("styles.css", false);
 String pageKey = CacheKeys.getResourceKey(pageNumber, resource);
 

See Also:

FileType, Resource

Field Summary

Fields

Modifier and Type	Field and Description
static String	PAGE_NUMBER

Method Summary

Modifier and Type	Method and Description
static String	getAttachmentKey(String attachmentId) Retrieves the unique identifier for the cache entry representing an attachment file.
static String	getAttachmentsKey() Returns the unique identifier for the cache entry that represents a collection of Attachment objects.
static String	getFileInfoKey() Retrieves the unique identifier for the cache entry that represents a ViewInfo object.
static String	getFileKey(String extension) Retrieves the unique identifier for the cache entry that represents a file.
static String	getPageKey(int pageNumber, String extension) Retrieves the unique identifier for the cache entry that represents a page file.
static String	getResourceFilter(int pageNumber) Returns a filter string to search for cache entries that represent Resource objects.
static String	getResourceKey(int pageNumber, Resource resource) Returns a unique identifier for the cache entry that represents a Resource object.
static String	getViewInfoKey() Retrieves the unique identifier for the cache entry that represents a ViewInfo object.

Methods inherited from class java.lang.Object

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

Field Detail

PAGE_NUMBER

public static final String PAGE_NUMBER

See Also:

Constant Field Values

Method Detail

getAttachmentKey

public static String getAttachmentKey(String attachmentId)

Retrieves the unique identifier for the cache entry representing an attachment file.

Parameters:

attachmentId - The unique identifier of the attachment (in the context of a single file).

Returns:

the unique identifier for the attachment file cache entry.

Throws:

IllegalArgumentException - If the attachmentId is null or empty.

See Also:

Attachment

getAttachmentsKey

public static String getAttachmentsKey()

Returns the unique identifier for the cache entry that represents a collection of Attachment objects.

Returns:

the unique identifier for the attachments cache entry.

getFileInfoKey

public static String getFileInfoKey()

Retrieves the unique identifier for the cache entry that represents a ViewInfo object.

Returns:

the unique identifier for the cache entry representing a ViewInfo object.

See Also:

ViewInfo

getFileKey

public static String getFileKey(String extension)

Retrieves the unique identifier for the cache entry that represents a file.

Parameters:

extension - The filename suffix (including the period ".") e.g. ".doc".

Returns:

the unique identifier for the cache entry representing a file.

Throws:

IllegalArgumentException - Thrown when extension is null or empty.

getPageKey

public static String getPageKey(int pageNumber,
                                String extension)

Retrieves the unique identifier for the cache entry that represents a page file.

Parameters:

pageNumber - The number of the page.

extension - The filename suffix (including the period ".") e.g. ".doc".

Returns:

the unique identifier for the cache entry representing a page file.

Throws:

IllegalArgumentException - Thrown when pageNumber is less than or equal to zero.

IllegalArgumentException - Thrown when extension is null or empty.

getResourceFilter

public static String getResourceFilter(int pageNumber)

Returns a filter string to search for cache entries that represent Resource objects.

Parameters:

pageNumber - The number of the page.

Returns:

the filter string to search for cache entries.

Throws:

IllegalArgumentException - Thrown when pageNumber is less than or equal to zero.

getResourceKey

public static String getResourceKey(int pageNumber,
                                    Resource resource)

Returns a unique identifier for the cache entry that represents a Resource object.

Parameters:

pageNumber - The number of the page.

resource - The HTML resource.

Returns:

the unique identifier for the cache entry.

Throws:

IllegalArgumentException - Thrown when pageNumber is less than or equal to zero.

IllegalArgumentException - Thrown when resource is null.

See Also:

Resource

getViewInfoKey

public static String getViewInfoKey()

Retrieves the unique identifier for the cache entry that represents a ViewInfo object.

Returns:

the unique identifier for the cache entry.

See Also:

ViewInfo