lumis.portal.page.cache

Class PCGeneratorConfig

java.lang.Object

lumis.portal.page.cache.PCGeneratorConfig

public class PCGeneratorConfig
extends 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: 23092 $ $Date: 2019-08-28 18:42:35 +0000 (Wed, 28 Aug 2019) $

Constructor Summary

Constructors

Constructor and Description
PCGeneratorConfig()

Method Summary

Modifier and Type	Method and Description
String	getDisplayName() Returns the generator's display name.
PageCacheGeneratorProfile	getGeneratorProfile() Returns the generator profile for this generator.
String	getId() Returns the identifier for this generator configuration.
Collection<String>	getPriorityQueueIds() Returns the identifier of the queues that have priority for this generator.
Collection<String>	getServerIds() Returns the persistent collection containing the associated servers.
boolean	isGenerateOtherQueues() Returns whether other queues may also be generated.
void	setDisplayName(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 String getId()

Returns the identifier for this generator configuration.

Returns:

the identifier.

Since:

6.0.0

getDisplayName

public String getDisplayName()

Returns the generator's display name.

Returns:

the generator's display name.

Since:

6.0.0

setDisplayName

public void setDisplayName(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 Collection<String> getPriorityQueueIds()

Returns the identifier of the queues that have priority for this generator.

Returns:

the queue identifiers.

Since:

6.0.0

getServerIds

public Collection<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