Package lumis.portal.page.cache

Class PCGeneratorConfig

  • public class PCGeneratorConfig
extends java.lang.Object
    Page cache generator configuration. Contains the configurations for a cache generator that is to be run in some specified servers.
    Since:
    6.0.0
    Version:
    $Revision$ $Date$

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDisplayName()
      Returns the generator's display name.
      PageCacheGeneratorProfile getGeneratorProfile()
      Returns the generator profile for this generator.
      java.lang.String getId()
      Returns the identifier for this generator configuration.
      java.util.Collection<java.lang.String> getPriorityQueueIds()
      Returns the identifier of the queues that have priority for this generator.
      java.util.Collection<java.lang.String> getServerIds()
      Returns the persistent collection containing the associated servers.
      boolean isGenerateOtherQueues()
      Returns whether other queues may also be generated.
      void setDisplayName​(java.lang.String displayName)
      Sets the generator's display name.
      void setGenerateOtherQueues​(boolean generateOtherQueues)
      Sets whether other queues may also be generated.
      void setGenerationProfile​(PageCacheGeneratorProfile generatorProfile)
      Sets the generator profile to be used in this generator.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • PCGeneratorConfig

        public PCGeneratorConfig()

    • Method Detail

      • getId

        public java.lang.String getId()
        Returns the identifier for this generator configuration.
        Returns:
        the identifier.
        Since:
        6.0.0

      • getDisplayName

        public java.lang.String getDisplayName()
        Returns the generator's display name.
        Returns:
        the generator's display name.
        Since:
        6.0.0

      • setDisplayName

        public void setDisplayName​(java.lang.String displayName)
        Sets the generator's display name.
        Parameters:
        displayName - the generator's display name.
        Since:
        6.0.0

      • isGenerateOtherQueues

        public boolean isGenerateOtherQueues()
        Returns whether other queues may also be generated.
        Returns:
        true if other queues may also be generated, false if only queues listed by getPriorityQueueIds() may be generated.
        Since:
        6.0.0

      • setGenerateOtherQueues

        public void setGenerateOtherQueues​(boolean generateOtherQueues)
        Sets whether other queues may also be generated.
        Parameters:
        generateOtherQueues - true if other queues may also be generated, false if only queues listed by getPriorityQueueIds() may be generated.
        Since:
        6.0.0

      • getPriorityQueueIds

        public java.util.Collection<java.lang.String> getPriorityQueueIds()
        Returns the identifier of the queues that have priority for this generator.
        Returns:
        the queue identifiers.
        Since:
        6.0.0

      • getServerIds

        public java.util.Collection<java.lang.String> getServerIds()
        Returns the persistent collection containing the associated servers.

        A server identifier value of "*" may be used to represent all servers.

        Returns:
        the persistent collection containing the associated servers.
        Since:
        6.0.0

      • getGeneratorProfile

        public PageCacheGeneratorProfile getGeneratorProfile()
        Returns the generator profile for this generator.
        Returns:
        the generator profile.
        Since:
        6.0.0

      • setGenerationProfile

        public void setGenerationProfile​(PageCacheGeneratorProfile generatorProfile)
        Sets the generator profile to be used in this generator.
        Parameters:
        generatorProfile - the generator profile.
        Since:
        6.0.0