lumis.portal.page.cache

Class PageCacheUtil

java.lang.Object

lumis.portal.page.cache.PageCacheUtil

public class PageCacheUtil
extends Object

Utility class for dealing with page cache.

Since:

10.1.0

Version:

$Revision: 21880 $ $Date: 2018-09-21 20:07:19 +0000 (Fri, 21 Sep 2018) $

Constructor Summary

Constructors

Constructor and Description
PageCacheUtil()

Method Summary

Modifier and Type	Method and Description
static PageConfig	getPageByPageCache(SessionConfig sessionConfig, PageCacheConfig pageCacheConfig, ITransaction transaction) Returns the page that will be rendered when accessing a web resource.
static String	getPageCacheGeneratorUserAgent() Returns the user agent string to be used when requesting a page for cache generation.
static boolean	isIncludedInAutomaticBulkExpiration(PageCacheConfig pageCacheConfig) Returns whether the given page cache is included in automatic bulk operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

PageCacheUtil

public PageCacheUtil()

Method Detail

getPageByPageCache

public static PageConfig getPageByPageCache(SessionConfig sessionConfig,
                                            PageCacheConfig pageCacheConfig,
                                            ITransaction transaction)
                                     throws PortalException

Returns the page that will be rendered when accessing a web resource.

Parameters:

sessionConfig - the user session information.

pageCacheConfig - the page cache config.

transaction - the transaction for persistence access.

Returns:

the page.

Throws:

PortalObjectNotFoundException - if no page was found for the specified web resource.

IllegalArgumentException - if webResource is of an unsupported class.

PortalException

Since:

10.1.0

isIncludedInAutomaticBulkExpiration

public static boolean isIncludedInAutomaticBulkExpiration(PageCacheConfig pageCacheConfig)

Returns whether the given page cache is included in automatic bulk operation.

Parameters:

pageCacheConfig - the page cache.

Returns:

whether the given page cache is included in automatic bulk operation.

Since:

10.2.0

getPageCacheGeneratorUserAgent

public static String getPageCacheGeneratorUserAgent()
                                             throws PortalException

Returns the user agent string to be used when requesting a page for cache generation.

Returns:

the user agent string to be used when requesting a page for cache generation.

Throws:

PortalException

Since:

11.0.0