Class HtmlGenerationConfig


  • public class HtmlGenerationConfig
    extends Object
    Contains configurations for the cache HTML generation.
    Since:
    4.1.0
    Version:
    $Revision: 18135 $ $Date: 2015-12-15 17:31:03 -0200 (Tue, 15 Dec 2015) $
    • Method Detail

      • isHtmlCacheLogNavigation

        public boolean isHtmlCacheLogNavigation()
        Returns if the access to cached html files should cause collecting page view monitoring event data.
        Returns:
        true to monitor page view 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
      • 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
      • getConnecTimeout

        public int getConnecTimeout()
        Returns the HTTP connect timeout.
        Returns:
        the timeout in milliseconds.
        Since:
        5.6.0
        See Also:
        URLConnection.setConnectTimeout(int)
      • getExpirationLimit

        public int getExpirationLimit()
        Returns the maximum number of web resource caches that can be expired in a single render data changed event.

        The default value is 0 and represents a unlimited number of web resource cache that can be expired.

        Returns:
        the maximum number of web resource caches that can be expired in a single render data changed event.
        Since:
        6.2.0