Package lumis.portal.page.cache

Class PageCacheConfig

  • public class PageCacheConfig
extends Object
    Stores information about the caching of a page.
    Since:
    4.0.0
    Version:
    $Revision: 20509 $ $Date: 2017-09-11 16:18:14 -0300 (Mon, 11 Sep 2017) $

    • Field Detail

      • STATUS_OUTDATED

        public static final int STATUS_OUTDATED
        Status that indicates the cache is outdated.
        Since:
        4.1.0
        See Also:
        Constant Field Values

      • STATUS_GENERATING

        public static final int STATUS_GENERATING
        Status that indicates the cache being generated.
        Since:
        4.1.0
        See Also:
        Constant Field Values

      • STATUS_GENERATING_OUTDATED

        public static final int STATUS_GENERATING_OUTDATED
        Status that indicates the cache is being generated, but the generation result will be outdated, because something changed after the generation started.
        Since:
        4.1.0
        See Also:
        Constant Field Values

      • STATUS_UPDATED

        public static final int STATUS_UPDATED
        Status that indicates the cache is updated.
        Since:
        4.1.0
        See Also:
        Constant Field Values

      • STATUS_OUTDATED_WITH_ERROR

        public static final int STATUS_OUTDATED_WITH_ERROR
        Status that indicates the cache is outdated and has quit generating due to errors.
        Since:
        4.1.0
        See Also:
        Constant Field Values

      • STATUS_DISABLED

        public static final int STATUS_DISABLED
        Status that indicates the cache is disabled.
        Since:
        4.1.0
        See Also:
        Constant Field Values

      • STATUS_NOT_PUBLISHED

        public static final int STATUS_NOT_PUBLISHED
        Status that indicates the target page is not published (its target content is not published).
        Since:
        10.2.0
        See Also:
        Constant Field Values

    • Constructor Detail

      • PageCacheConfig

        public PageCacheConfig​(WebResource webResource)
        Creates a PageCacheConfig for a web resource. The relationship on the this PageCacheConfig is set by this constructor, but not on the web resource side.
        Parameters:
        webResource - the web resource.
        Since:
        5.0.0

    • Method Detail

      • getId

        public String getId()

      • getStatus

        public int getStatus()

      • setStatus

        public void setStatus​(int status)

      • getInitialPriority

        public int getInitialPriority()
        Returns the initial priority value for this page cache.
        Returns:
        the initial priority value.
        Since:
        4.1.0

      • setInitialPriority

        public void setInitialPriority​(int initialPriority)
        Sets the initial priority value for this page cache.
        Parameters:
        initialPriority - the value to set.
        Since:
        4.1.0

      • getPriority

        public int getPriority()
        Returns the current priority value for this page cache.
        Returns:
        the current priority value.
        Since:
        4.1.0

      • getResourcePriority

        public int getResourcePriority()
        Returns the priority for generating the cache for the resource this cache is of. This is used to choose between caches with the same priority.
        Returns:
        the number of parameters.
        Since:
        5.0.0

      • getNumErrors

        public int getNumErrors()
        Returns the number of consecutive generation errors for this page cache.
        Returns:
        the the number of consecutive generation errors for this page cache.
        Since:
        4.1.0

      • getFilePath

        public String getFilePath()
        Returns the path to the cache file, relative to the portal application web root.
        Returns:
        the path, starting with '/'.
        Since:
        5.0.0

      • setFilePath

        public void setFilePath​(String filePath)
        Sets the path to the cache file, relative to the portal application web root.
        Parameters:
        filePath - the path, starting with '/'.
        Since:
        5.0.0

      • getServerId

        public String getServerId()
        Returns the identifier of the server that last generated this page cache.
        Returns:
        the server identifier.
        Since:
        6.0.0

      • getNextGenerationDate

        public Date getNextGenerationDate()
        Returns the date-time of the next generation of this page cache. If the value is null, the next generation doesn't have a fixed time to be started.
        Returns:
        the date-time of the next generation of this page cache.
        Since:
        6.2.0