lumis.portal.page.cache
Class PageCacheManager

java.lang.Object
  lumis.portal.page.cache.PageCacheManager

All Implemented Interfaces:

IPageCacheManager

public class PageCacheManager
extends Object
implements IPageCacheManager

Manager for page cache information.

Since:

4.0.0

Nested Class Summary

protected static class

PageCacheManager.HttpAccessResult Structure used to hold the result of doHttpAccess(URL, String).

Nested classes/interfaces inherited from interface lumis.portal.page.cache.IPageCacheManager

IPageCacheManager.GenerationOutcome

Field Summary

static String

PAGE_CACHE_MANAGER_LANGUAGE_FILENAME_PREFIX

Fields inherited from interface lumis.portal.page.cache.IPageCacheManager

CLEAR_CACHE_CHANGE_TYPE_DELETE, CLEAR_CACHE_CHANGE_TYPE_UPDATE, PAGE_CACHE_GEN_STATE_DISABLED, PAGE_CACHE_GEN_STATE_ENABLED

Constructor Summary

PageCacheManager()

Method Summary

void	clearAllHTMLCache(ITransaction transaction) Clears all page HTML cache.
void	clearCacheByChannelIds(SessionConfig sessionConfig, Collection<String> channelIds, Map<String,String[]> parameters, int changeType, boolean clearImmediately, 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, boolean clearImmediately, 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(String filePath, boolean deleteShadowCacheHtml) Delete the HTML cache files for the specified path.
protected PageCacheManager.HttpAccessResult	doHttpAccess(URL url, String cookies)
PageCacheConfig	generateNextPage(boolean forImmediateUseOnly) Generates next outdated page cache, according to its priority.
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(boolean forImmediateUseOnly) Returns the next page cache to be generated.
int	getPageCacheGenerationState(SessionConfig sessionConfig, ITransaction transaction) Deprecated.
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.
void	pageCacheMissedByFilePath(String filePath, boolean forImmediateUse) Indicates a miss in the page cache occurred.
String	processHTMLForPageCache(String htmlContent, PageCacheConfig pageCache, boolean convertGuestOnlyCaches) Processes a HTML code for storing for a page cache.
protected void	releaseGenerationLock(PageCacheConfig pageCacheConfig, IPageCacheManager.GenerationOutcome outcome) Releases the generation lock for a cached page.
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.

Methods inherited from class java.lang.Object

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

Field Detail

PAGE_CACHE_MANAGER_LANGUAGE_FILENAME_PREFIX

public static final String PAGE_CACHE_MANAGER_LANGUAGE_FILENAME_PREFIX

See Also:

Constant Field Values

Constructor Detail

PageCacheManager

public PageCacheManager()

Method Detail

waitForGeneration

public String waitForGeneration(String pageCacheId,
                                long timeout)
                         throws PortalException,
                                InterruptedException

Description copied from interface: IPageCacheManager

Waits for the generation of a page cache.

Specified by:

waitForGeneration in interface IPageCacheManager

Parameters:

pageCacheId - the page cache identifier.

timeout - maximum time to wait.

Returns:

the generated page content.

Throws:

InterruptedException - if the thread was interrupted.

PortalException

waitForPagesReadyToGenerate

public void waitForPagesReadyToGenerate(long timeout,
                                        boolean forImmediateUseOnly)
                                 throws InterruptedException

Description copied from interface: IPageCacheManager

Waits for new pages to be ready to be generated.

Specified by:

waitForPagesReadyToGenerate in interface IPageCacheManager

Parameters:

timeout - 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.

Throws:

InterruptedException - if the thread was interrupted.

doHttpAccess

protected PageCacheManager.HttpAccessResult doHttpAccess(URL url,
                                                         String cookies)
                                                  throws UnsupportedEncodingException,
                                                         IOException

Throws:

UnsupportedEncodingException

IOException

generatePage

protected void generatePage(PageCacheConfig pageCacheConfig)
                     throws ManagerException,
                            PortalException

Throws:

ManagerException

PortalException

generateNextPage

public PageCacheConfig generateNextPage(boolean forImmediateUseOnly)
                                 throws PortalException

Description copied from interface: IPageCacheManager

Generates next outdated page cache, according to its priority. If the generation lock could not be obtained, the page is not generated.

Specified by:

generateNextPage in interface IPageCacheManager

Parameters:

forImmediateUseOnly - if true, only pages whose priority is higher than PageCacheConfig.MAX_INITIAL_PRIORITY are taken in account.

Returns:

the generated page cache information, or null if the generation lock could not be obtained or if there is no outdated page (as specified in the parameters).

Throws:

PortalException

generatePage

public PageCacheConfig generatePage(String pageCacheId)
                             throws PortalException

Description copied from interface: IPageCacheManager

Generates a page cache. If the generation lock could not be obtained, the page is not generated.

Specified by:

generatePage in interface IPageCacheManager

Parameters:

pageCacheId - the page cache identifier.

Returns:

the generated page cache information, or null if the generation lock could not be obtained.

Throws:

PortalException

deleteHtmlFiles

protected void deleteHtmlFiles(String filePath,
                               boolean deleteShadowCacheHtml)

Delete the HTML cache files for the specified path.

Parameters:

filePath - the relative cache file path.

deleteShadowCacheHtml - if true, the shadow cache file is also deleted.

Since:

5.0.0

delete

public void delete(SessionConfig sessionConfig,
                   String pageCacheId,
                   ITransaction transaction)
            throws ManagerException,
                   PortalException

Description copied from interface: IPageCacheManager

Delete a page cache.

Specified by:

delete in interface IPageCacheManager

Throws:

ManagerException

PortalException

get

public PageCacheConfig get(String pageCacheId)
                    throws PortalException

Description copied from interface: IPageCacheManager

Returns a page cache given its identifier.

Specified by:

get in interface IPageCacheManager

Parameters:

pageCacheId - the page cache identifier.

Returns:

the persistent page cache instance.

Throws:

PortalObjectNotFoundException - if no page cache with the given identifier was found.

PortalException

processHTMLForPageCache

public String processHTMLForPageCache(String htmlContent,
                                      PageCacheConfig pageCache,
                                      boolean convertGuestOnlyCaches)
                               throws PortalException

Description copied from interface: IPageCacheManager

Processes a HTML code for storing for a page cache.

Specified by:

processHTMLForPageCache in interface IPageCacheManager

Parameters:

htmlContent - HTML code.

pageCache - the page cache the code will be used in.

convertGuestOnlyCaches - if true, pages with cache enabled only for guest will also have their dynamic paths converted.

Returns:

the processed HTML code.

Throws:

PortalException

clearCacheByPagesIds

public void clearCacheByPagesIds(SessionConfig sessionConfig,
                                 Collection<String> pagesIds,
                                 Map<String,String[]> parameters,
                                 Locale locale,
                                 int changeType,
                                 boolean clearImmediately,
                                 ITransaction transaction)
                          throws PortalException

Description copied from interface: IPageCacheManager

Clear the cache of the specified pages. This method always clears the specified pages cache after the transaction commits. If clearImmediately is set to true, it will also clear the specified pages cache immediately, synchronously.

Specified by:

clearCacheByPagesIds in interface IPageCacheManager

Parameters:

sessionConfig - 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.

clearImmediately - if the cache clearing is also to be executed immediately.

transaction - the transaction for persistence access.

Throws:

PortalException

clearCacheByChannelIds

public void clearCacheByChannelIds(SessionConfig sessionConfig,
                                   Collection<String> channelIds,
                                   Map<String,String[]> parameters,
                                   int changeType,
                                   boolean clearImmediately,
                                   ITransaction transaction)
                            throws PortalException

Description copied from interface: IPageCacheManager

Clear the cache of the pages within the specified channels recursively. This method always clears the specified pages cache after the transaction commits. If clearImmediately is set to true, it will also clear the specified pages cache immediately, synchronously.

Specified by:

clearCacheByChannelIds in interface IPageCacheManager

Parameters:

sessionConfig - 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.

clearImmediately - if the cache clearing is also to be executed immediately.

transaction - the transaction for persistence access.

Throws:

PortalException

getPageCacheGenerationState

@Deprecated
public int getPageCacheGenerationState(SessionConfig sessionConfig,
                                                  ITransaction transaction)
                                throws PortalException

Deprecated.

Description copied from interface: IPageCacheManager

Returns whether page cache generation is enabled or not

Specified by:

getPageCacheGenerationState in interface IPageCacheManager

Returns:

Throws:

PortalException

isPageCacheGenerationEnabled

public boolean isPageCacheGenerationEnabled()

Description copied from interface: IPageCacheManager

Indicates if the page cache generation is globally enabled.

Specified by:

isPageCacheGenerationEnabled in interface IPageCacheManager

Returns:

true if enabled, false otherwise.

setPageCacheGenerationState

public void setPageCacheGenerationState(SessionConfig sessionConfig,
                                        int state,
                                        ITransaction transaction)
                                 throws PortalException

Sets the page cache generation state.

The session provided must have MANAGE_CACHE permission at the portal level in order to execute this method successfully.

Specified by:

setPageCacheGenerationState in interface IPageCacheManager

Parameters:

sessionConfig -

state -

transaction -

Throws:

PortalException

Since:

4.0.11

getGenerationLock

protected PageCacheConfig getGenerationLock(String pageCacheId)
                                     throws PortalException

Gets a lock for generating a cached page.

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.

Parameters:

pageCacheId - the page cache identifier.

Returns:

the locked page cache, or null if it could not be locked for generation.

Throws:

PortalException

releaseGenerationLock

protected void releaseGenerationLock(PageCacheConfig pageCacheConfig,
                                     IPageCacheManager.GenerationOutcome outcome)
                              throws PortalException

Releases the generation lock for a cached page.

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.

Parameters:

pageCacheConfig - the page cache.

outcome - the generation outcome.

newStatus - the new status if the current status is generating.

Throws:

PortalException

Since:

4.1.0

updateCachedFilesLastModifiedDate

public void updateCachedFilesLastModifiedDate(SessionConfig sessionConfig,
                                              PageConfig pageConfig,
                                              Locale locale,
                                              Date lastModifiedDate,
                                              ITransaction transaction)
                                       throws PortalException

Description copied from interface: IPageCacheManager

Updates the last modified date of the cached files that match the given pageId and locale.

Specified by:

updateCachedFilesLastModifiedDate in interface IPageCacheManager

Parameters:

sessionConfig - 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.

Throws:

PortalException

pageCacheMissed

public void pageCacheMissed(String pageCacheId,
                            boolean forImmediateUse)
                     throws PortalException

Description copied from interface: IPageCacheManager

Indicates a miss in the page cache occurred. This provokes an asynchronous page cache generation and causes an increase in its priority due to the interest in accessing it.

Specified by:

pageCacheMissed in interface IPageCacheManager

Parameters:

pageCacheId - 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.

Throws:

PortalException

pageCacheMissedByFilePath

public void pageCacheMissedByFilePath(String filePath,
                                      boolean forImmediateUse)
                               throws PortalException

Description copied from interface: IPageCacheManager

Indicates a miss in the page cache occurred. This provokes an asynchronous page cache generation and causes an increase in its priority due to the interest in accessing it.

Specified by:

pageCacheMissedByFilePath in interface IPageCacheManager

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.

Throws:

PortalObjectNotFoundException - if no page cache for the specified file path was found.

PortalException

getNextPageForGeneration

protected PageCacheConfig getNextPageForGeneration(boolean forImmediateUseOnly)
                                            throws PortalException

Returns the next page cache to be generated. It is locked for generation before being returned.

Parameters:

forImmediateUseOnly - if true, only pages whose priority is higher than PageCacheConfig.MAX_INITIAL_PRIORITY are taken in account.

Returns:

the next page cache to be generated, or null if no suitable page was found.

Throws:

PortalException

Since:

4.1.0

See Also:

#getGenerationLock(PageCacheConfig), #releaseGenerationLock(PageCacheConfig, int)

clearAllHTMLCache

public void clearAllHTMLCache(ITransaction transaction)
                       throws PortalException

Description copied from interface: IPageCacheManager

Clears all page HTML cache.

Specified by:

clearAllHTMLCache in interface IPageCacheManager

Parameters:

transaction - the transaction for persistence access.

Throws:

PortalException

clearPageCacheErrors

public void clearPageCacheErrors(Collection<String> pageCacheIds,
                                 ITransaction transaction)
                          throws PortalException

Description copied from interface: IPageCacheManager

Clear page cache errors in the database. It is locked for update before being updated.

Specified by:

clearPageCacheErrors in interface IPageCacheManager

Parameters:

pageCacheIds - the page cache identifiers.

transaction - the transaction for persistence access.

Throws:

PortalException