lumis.portal.page.cache
Class HtmlGenerationConfig

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

public class HtmlGenerationConfig
extends Object

Contains configurations for the cache HTML generation.

Since:

4.1.0

Constructor Summary

HtmlGenerationConfig(Node htmlGenerationNode)

Method Summary

int	getErrorPriorityDecrement() Returns the amount by which the priority is decreased when an error during generation occurs.
String	getFrameworkUrl() Returns the frameworkUrl used to generate html cache.
String	getHtmlFileExtension() Returns the extension used for html files.
int	getIntervalAfterStabilization() Returns the interval after stabilization in milliseconds.
int	getIntervalBetweenPageGenerations() Returns the interval between page generations in milliseconds.
int	getMaxErrorCount() Returns the maximum number of consecutive errors that causes a page cache to be set into the PageCacheConfig.STATUS_OUTDATED_WITH_ERROR status.
int	getNumberOfThreads() Returns the number of generation threads.
int	getNumberOfThreadsForImmediateUseOnly() Returns the number of generation threads that are used only to generate caches required for immediate use.
int	getPageRequestTimeout() Returns the timeout, in milliseconds, for a cached page request.
String	getShtmlFileExtension() Returns the extension used for shtml files.
int	getSsiWaitBeforeSendRedirect() Returns the time to wait in milliseconds before sending a redirect for a SSI page that was not found.
int	getThreadPriority() Returns the priority of the generation threads.
boolean	isDeleteOutdated() Returns if outdated pages should be deleted.
boolean	isHtmlCacheLogNavigation() Returns if the access to cached html files should cause navigation log.
boolean	isOnDemandOnly() Indicates if pages are generated only if demanded.
boolean	isShadowCacheEnabled() Indicates if the shadow cache feature is enabled.
boolean	isSsiSendRedirectOnPageNotFound() Indicates if a send redirect should be used when a SSI page is not found, instead of directly streaming the generated html.

Methods inherited from class java.lang.Object

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

Constructor Detail

HtmlGenerationConfig

public HtmlGenerationConfig(Node htmlGenerationNode)
                     throws PortalException

Throws:

PortalException

Method Detail

isOnDemandOnly

public boolean isOnDemandOnly()

Indicates if pages are generated only if demanded. If false, outdated pages are generated even if not demanded.

Returns:

true if pages are generated only if demanded, false otherwise.

Since:

4.1.0

getIntervalBetweenPageGenerations

public int getIntervalBetweenPageGenerations()

Returns the interval between page generations in milliseconds.

Returns:

the interval between page generations in milliseconds.

Since:

4.1.0

getIntervalAfterStabilization

public int getIntervalAfterStabilization()

Returns the interval after stabilization in milliseconds. Stabilization is when no cache is required to be generated, according to the rules specified in this configuration.

Returns:

the interval after stabilization in milliseconds.

Since:

4.1.0

getNumberOfThreads

public int getNumberOfThreads()

Returns the number of generation threads.

Returns:

the number of generation threads.

Since:

4.1.0

getNumberOfThreadsForImmediateUseOnly

public int getNumberOfThreadsForImmediateUseOnly()

Returns the number of generation threads that are used only to generate caches required for immediate use.

Returns:

the number of generation threads for caches required for immediate use.

Since:

4.1.0

getThreadPriority

public int getThreadPriority()

Returns the priority of the generation threads.

Returns:

the priority of the generation threads.

Since:

4.1.0

See Also:

Thread

isHtmlCacheLogNavigation

public boolean isHtmlCacheLogNavigation()

Returns if the access to cached html files should cause navigation log.

Returns:

true to log navigation on cached html, false otherwise.

Since:

4.1.0

getFrameworkUrl

public String getFrameworkUrl()

Returns the frameworkUrl used to generate html cache.

Returns:

the frameworkUrl used to generate html cache.

Since:

4.1.0

getHtmlFileExtension

public String getHtmlFileExtension()

Returns the extension used for html files.

Returns:

the extension used for html files.

Since:

4.1.0

getShtmlFileExtension

public String getShtmlFileExtension()

Returns the extension used for shtml files.

Returns:

the extension used for shtml files.

Since:

4.1.0

getPageRequestTimeout

public int getPageRequestTimeout()

Returns the timeout, in milliseconds, for a cached page request. When a request for a page that does not have its cache available is done, a period up to this timeout limit is waited to allow the generator to generate the required cache. If the generation is not done within this timeout, an error is sent in the response.

Returns:

the pageRequestTimeout the timeout in milliseconds.

Since:

4.1.0

isDeleteOutdated

public boolean isDeleteOutdated()

Returns if outdated pages should be deleted.

Returns:

true if outdated pages should be deleted, false otherwise.

Since:

4.1.0

getMaxErrorCount

public int getMaxErrorCount()

Returns the maximum number of consecutive errors that causes a page cache to be set into the PageCacheConfig.STATUS_OUTDATED_WITH_ERROR status.

Returns:

the maximum number of consecutive errors.

Since:

4.1.0

getErrorPriorityDecrement

public int getErrorPriorityDecrement()

Returns the amount by which the priority is decreased when an error during generation occurs.

Returns:

the priority decrease amount.

Since:

4.1.0

isShadowCacheEnabled

public boolean isShadowCacheEnabled()

Indicates if the shadow cache feature is enabled.

Returns:

true if enabled, false if disabled.

Since:

4.1.0

isSsiSendRedirectOnPageNotFound

public boolean isSsiSendRedirectOnPageNotFound()

Indicates if a send redirect should be used when a SSI page is not found, instead of directly streaming the generated html.

Returns:

if true use send redirect, else stream the generated html.

Since:

4.1.0

getSsiWaitBeforeSendRedirect

public int getSsiWaitBeforeSendRedirect()

Returns the time to wait in milliseconds before sending a redirect for a SSI page that was not found. Used only if isSsiSendRedirectOnPageNotFound() is true.

Returns:

the time to wait in milliseconds.

Since:

4.1.0