public class PageCacheManager extends Object implements IPageCacheManagerSPI
| Modifier and Type | Class and Description |
|---|---|
protected static class |
PageCacheManager.HttpAccessResult
Structure used to hold the result of
doHttpAccess(URL, String). |
IPageCacheManager.GenerationOutcome| Modifier and Type | Field and Description |
|---|---|
static Long |
lastExcessiveCleaningTimestamp |
static String |
PAGE_CACHE_MANAGER_LANGUAGE_FILENAME_PREFIX |
CLEAR_CACHE_CHANGE_TYPE_DELETE, CLEAR_CACHE_CHANGE_TYPE_UPDATE, PAGE_CACHE_GEN_STATE_DISABLED, PAGE_CACHE_GEN_STATE_ENABLED| Constructor and Description |
|---|
PageCacheManager() |
| Modifier and Type | Method and Description |
|---|---|
void |
clearAllHTMLCache(ITransaction transaction)
Clears all page HTML cache.
|
void |
clearCacheByChannelIds(SessionConfig sessionConfig,
Collection<String> channelIds,
Map<String,String[]> parameters,
int changeType,
ITransaction transaction)
Clear the cache of the pages within the specified channels recursively.
|
void |
clearCacheByPagesIds(SessionConfig sessionConfig,
Collection<String> pagesIds,
Map<String,String[]> parameters,
Locale locale,
int changeType,
ITransaction transaction)
Clear the cache of the specified pages.
|
void |
clearPageCacheErrors(Collection<String> pageCacheIds,
ITransaction transaction)
Clear page cache errors in the database.
|
void |
delete(SessionConfig sessionConfig,
String pageCacheId,
ITransaction transaction)
Delete a page cache.
|
protected void |
deleteHtmlFiles(IWebsite website,
String filePath,
boolean deleteShadowCacheHtml)
Delete the HTML cache files for the specified path.
|
protected void |
deleteHtmlFiles(PageCacheConfig pageCache,
boolean deleteShadowCacheHtml)
Delete the HTML cache files for the specified path.
|
protected PageCacheManager.HttpAccessResult |
doHttpAccess(URL url,
String cookies) |
void |
enablePageCacheByPageParam(String paramName,
String paramValue,
Locale locale)
Enable page cache by a given page parameter name-value pair and locale.
|
void |
expirePageCache(PageCacheConfig pageCacheConfig)
Expires a single
PageCacheConfig |
PageCacheConfig |
generateNextPage(lumis.portal.page.cache.GenerationSelectStrategy generationSelectStrategy)
Generates next outdated page cache, according to the given strategy.
|
protected void |
generatePage(PageCacheConfig pageCacheConfig) |
PageCacheConfig |
generatePage(String pageCacheId)
Generates a page cache.
|
PageCacheConfig |
get(String pageCacheId)
Returns a page cache given its identifier.
|
protected PageCacheConfig |
getGenerationLock(String pageCacheId)
Gets a lock for generating a cached page.
|
protected PageCacheConfig |
getNextPageForGeneration(lumis.portal.page.cache.GenerationSelectStrategy generationSelectStrategy)
Returns the next page cache to be generated.
|
int |
getPageCacheGenerationState(SessionConfig sessionConfig,
ITransaction transaction)
Deprecated.
|
void |
initializePageCacheConfigurations()
Initializes page cache related configurations.
|
boolean |
isPageCacheGenerationEnabled()
Indicates if the page cache generation is globally enabled.
|
void |
pageCacheMissed(String pageCacheId,
boolean forImmediateUse)
Indicates a miss in the page cache occurred.
|
String |
processHTMLForPageCache(String htmlContent,
PageCacheConfig pageCache)
Processes a HTML code for storing for a page cache.
|
void |
recalculateCaches(String channelId)
Recalculates the attributes for the caches in the portal area inside the
specified channel.
|
protected void |
releaseGenerationLock(PageCacheConfig pageCacheConfig,
IPageCacheManager.GenerationOutcome outcome)
Releases the generation lock for a cached page.
|
void |
resetExpiredGeneratingPages()
Resets all pages that have been in the generating state for more than 30 minutes.
|
void |
setPageCacheGenerationState(SessionConfig sessionConfig,
int state,
ITransaction transaction)
Sets the page cache generation state.
|
void |
updateCachedFilesLastModifiedDate(SessionConfig sessionConfig,
PageConfig pageConfig,
Locale locale,
Date lastModifiedDate,
ITransaction transaction)
Updates the last modified date of the cached files that match the given pageId and locale.
|
String |
waitForGeneration(String pageCacheId,
long timeout)
Waits for the generation of a page cache.
|
void |
waitForPagesReadyToGenerate(long timeout,
boolean forImmediateUseOnly)
Waits for new pages to be ready to be generated.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitprocessHTMLForPageCachepublic static Long lastExcessiveCleaningTimestamp
public static final String PAGE_CACHE_MANAGER_LANGUAGE_FILENAME_PREFIX
public void expirePageCache(PageCacheConfig pageCacheConfig) throws PortalException
PageCacheConfigexpirePageCache in interface IPageCacheManagerpageCacheConfig - the page cache to expired.PortalExceptionpublic String waitForGeneration(String pageCacheId, long timeout) throws PortalException, InterruptedException
IPageCacheManagerwaitForGeneration in interface IPageCacheManagerpageCacheId - the page cache identifier.timeout - maximum time to wait.InterruptedException - if the thread was interrupted.PortalExceptionpublic void waitForPagesReadyToGenerate(long timeout,
boolean forImmediateUseOnly)
throws InterruptedException
IPageCacheManagerwaitForPagesReadyToGenerate in interface IPageCacheManagertimeout - maximum time to wait.forImmediateUseOnly - if true, wait until a page for
immediate use is ready to generate. If false, wait until any page is
ready to generate.InterruptedException - if the thread was interrupted.protected PageCacheManager.HttpAccessResult doHttpAccess(URL url, String cookies) throws UnsupportedEncodingException, IOException, PortalException
protected void generatePage(PageCacheConfig pageCacheConfig) throws ManagerException, PortalException
ManagerExceptionPortalExceptionpublic PageCacheConfig generateNextPage(lumis.portal.page.cache.GenerationSelectStrategy generationSelectStrategy) throws PortalException
generationSelectStrategy - contains informations for the strategy
for selecting the next to be generated.null
if the generation lock could not be obtained or if there is no
outdated page (as specified in the parameters).PortalExceptionpublic PageCacheConfig generatePage(String pageCacheId) throws PortalException
IPageCacheManagergeneratePage in interface IPageCacheManagerpageCacheId - the page cache identifier.PortalExceptionprotected void deleteHtmlFiles(IWebsite website, String filePath, boolean deleteShadowCacheHtml)
website - the website from where the file will be deleted.filePath - the relative cache file path.deleteShadowCacheHtml - if true, the shadow cache file is also deleted.protected void deleteHtmlFiles(PageCacheConfig pageCache, boolean deleteShadowCacheHtml)
pageCache - the page cache that will have its files deleted.deleteShadowCacheHtml - if true, the shadow cache file is also deleted.IOExceptionpublic void delete(SessionConfig sessionConfig, String pageCacheId, ITransaction transaction) throws ManagerException, PortalException
IPageCacheManagerdelete in interface IPageCacheManagerManagerExceptionPortalExceptionpublic PageCacheConfig get(String pageCacheId) throws PortalException
IPageCacheManagerget in interface IPageCacheManagerpageCacheId - the page cache identifier.PortalObjectNotFoundException - if no page cache with the given
identifier was found.PortalExceptionpublic String processHTMLForPageCache(String htmlContent, PageCacheConfig pageCache) throws PortalException
IPageCacheManagerprocessHTMLForPageCache in interface IPageCacheManagerhtmlContent - HTML code.pageCache - the page cache the code will be used in.PortalExceptionpublic void clearCacheByPagesIds(SessionConfig sessionConfig, Collection<String> pagesIds, Map<String,String[]> parameters, Locale locale, int changeType, ITransaction transaction) throws PortalException
IPageCacheManagerclearCacheByPagesIds in interface IPageCacheManagersessionConfig - the user session information.pagesIds - a collection of the pages identifiers.parameters - the page parameters. Used to filter which caches
are cleared.locale - specifies the locale to which the cache clearing is to
be applied. May be null to indicate any locale.changeType - the cause of the cache clear. Must be one of the
CLEAR_CACHE_CHANGE_TYPE_* constants.transaction - the transaction for persistence access.PortalExceptionpublic void clearCacheByChannelIds(SessionConfig sessionConfig, Collection<String> channelIds, Map<String,String[]> parameters, int changeType, ITransaction transaction) throws PortalException
IPageCacheManagerclearCacheByChannelIds in interface IPageCacheManagersessionConfig - the user session information.parameters - the page parameters. Used to filter which caches
are cleared.changeType - the cause of the cache clear. Must be one of the
CLEAR_CACHE_CHANGE_TYPE_* constants.transaction - the transaction for persistence access.PortalException@Deprecated public int getPageCacheGenerationState(SessionConfig sessionConfig, ITransaction transaction) throws PortalException
IPageCacheManagergetPageCacheGenerationState in interface IPageCacheManagerPortalExceptionpublic boolean isPageCacheGenerationEnabled()
IPageCacheManagerisPageCacheGenerationEnabled in interface IPageCacheManagertrue if enabled, false otherwise.public void setPageCacheGenerationState(SessionConfig sessionConfig, int state, ITransaction transaction) throws PortalException
The session provided must have MANAGE_CACHE permission at the portal level in order to execute this method successfully.
setPageCacheGenerationState in interface IPageCacheManagersessionConfig - state - transaction - PortalExceptionprotected PageCacheConfig getGenerationLock(String pageCacheId) throws PortalException
To get a lock successfully, the page cache status must be PageCacheConfig.STATUS_OUTDATED.
If successful, the page cache status will be changed to PageCacheConfig.STATUS_GENERATING.
pageCacheId - the page cache identifier.PortalExceptionprotected void releaseGenerationLock(PageCacheConfig pageCacheConfig, IPageCacheManager.GenerationOutcome outcome) throws PortalException
According to the outcome argument, the following happens:
GenerationOutcome#SUCCESS: If the current status is
generating, it is changed to
updated, else it is changed to
outdated. The
number of errors is reset
to zero.GenerationOutcome#CANCEL: The status is changed to
outdated.GenerationOutcome#ERROR: The
number of errors
is incremented, and the status is changed to
outdated or
outdated with error,
depending on whether the number of errors reached
max error count.pageCacheConfig - the page cache.outcome - the generation outcome.newStatus - the new status if the current status is generating.PortalExceptionpublic void updateCachedFilesLastModifiedDate(SessionConfig sessionConfig, PageConfig pageConfig, Locale locale, Date lastModifiedDate, ITransaction transaction) throws PortalException
IPageCacheManagerupdateCachedFilesLastModifiedDate in interface IPageCacheManagersessionConfig - the user session information.pageConfig - the portal page.locale - locale for which the cached files needs to be modified.lastModifiedDate - date to which the matched files must be modified to.transaction - the transaction for persistence access.PortalExceptionpublic void pageCacheMissed(String pageCacheId, boolean forImmediateUse) throws PortalException
IPageCacheManagerpageCacheMissed in interface IPageCacheManagerpageCacheId - the page cache identifier.forImmediateUse - if true, indicates that the missed page cache
is required for immediate use. This will greater boost the priority to
generate the corresponding page cache.PortalExceptionprotected PageCacheConfig getNextPageForGeneration(lumis.portal.page.cache.GenerationSelectStrategy generationSelectStrategy) throws PortalException
generationSelectStrategy - the strategy to select the cache to be
generated.PortalException#getGenerationLock(PageCacheConfig),
#releaseGenerationLock(PageCacheConfig, int)public void clearAllHTMLCache(ITransaction transaction) throws PortalException
IPageCacheManagerclearAllHTMLCache in interface IPageCacheManagertransaction - the transaction for persistence access.PortalExceptionpublic void clearPageCacheErrors(Collection<String> pageCacheIds, ITransaction transaction) throws PortalException
IPageCacheManagerclearPageCacheErrors in interface IPageCacheManagerpageCacheIds - the page cache identifiers.transaction - the transaction for persistence access.PortalExceptionpublic void initializePageCacheConfigurations()
Populates the database with the page cache related default configurations.
public void recalculateCaches(String channelId) throws PortalException
channelId - the channel identifier.PortalExceptionpublic void resetExpiredGeneratingPages()
throws PortalException
IPageCacheManagerSPIresetExpiredGeneratingPages in interface IPageCacheManagerSPIPortalExceptionpublic void enablePageCacheByPageParam(String paramName, String paramValue, Locale locale)
paramName - the parameter name.paramValue - the parameter value.locale - the locale.LumisXP 12.5.0.200928 - Copyright © 2006–2020 Lumis EIP Tecnologia da Informação LTDA. All Rights Reserved.