Class WarmerConfig

java.lang.Object

org.frontcache.warmer.WarmerConfig

public final class WarmerConfig
extends Object

The front-cache.warmer.* keys of frontcache.properties, read once per call site. Each run's own parameters (list, mode, key base, client type, delay, concurrency) are NOT here - they come from the Run form, change from run to run, and are recorded in the checkpoint and the run summary instead. See docs/cache-warmer-proposal.md section 11.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTO_PAUSE_AFTER_FAILURES
static final String	DEFAULT_DELAY_MS
static final String	DEFAULT_USER_AGENT	Names a bot, to match the default client type - so what the origin and its logs see agrees with what the cache stores the entry for.
static final String	EDIT_MAX_BYTES
static final String	ENABLED
static final int	HARD_MAX_CONCURRENCY	No configuration raises concurrency above this: 32 loopback workers is already a lot of origin.
static final String	KEY_BASE
static final String	LIST_WRITE
static final String	LOOPBACK_URL
static final String	MAX_CONCURRENCY
static final String	MAX_LIST_BYTES
static final String	MAX_LIST_ENTRIES
static final String	REQUEST_TIMEOUT_MS
static final String	USER_AGENT

Method Summary

Modifier and Type	Method	Description
static WarmerConfig	current()	The node's current settings.
int	getAutoPauseAfterFailures()
long	getDefaultDelayMs()
long	getEditMaxBytes()
String	getKeyBase()
String	getLoopbackUrl()
int	getMaxConcurrency()
long	getMaxListBytes()
long	getMaxListEntries()
String	getPublicDomain()
int	getRequestTimeoutMs()
String	getUserAgent()
boolean	isEnabled()
boolean	isListWrite()

Methods inherited from class Object

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

Field Details

ENABLED

public static final String ENABLED

See Also:

• Constant Field Values

LIST_WRITE

public static final String LIST_WRITE

See Also:

• Constant Field Values

KEY_BASE

public static final String KEY_BASE

See Also:

• Constant Field Values

LOOPBACK_URL

public static final String LOOPBACK_URL

See Also:

• Constant Field Values

DEFAULT_DELAY_MS

public static final String DEFAULT_DELAY_MS

See Also:

• Constant Field Values

MAX_CONCURRENCY

public static final String MAX_CONCURRENCY

See Also:

• Constant Field Values

REQUEST_TIMEOUT_MS

public static final String REQUEST_TIMEOUT_MS

See Also:

• Constant Field Values

AUTO_PAUSE_AFTER_FAILURES

public static final String AUTO_PAUSE_AFTER_FAILURES

See Also:

• Constant Field Values

USER_AGENT

public static final String USER_AGENT

See Also:

• Constant Field Values

EDIT_MAX_BYTES

public static final String EDIT_MAX_BYTES

See Also:

• Constant Field Values

MAX_LIST_BYTES

public static final String MAX_LIST_BYTES

See Also:

• Constant Field Values

MAX_LIST_ENTRIES

public static final String MAX_LIST_ENTRIES

See Also:

• Constant Field Values

HARD_MAX_CONCURRENCY

public static final int HARD_MAX_CONCURRENCY

No configuration raises concurrency above this: 32 loopback workers is already a lot of origin.

See Also:

• Constant Field Values

DEFAULT_USER_AGENT

public static final String DEFAULT_USER_AGENT

Names a bot, to match the default client type - so what the origin and its logs see agrees with what the cache stores the entry for. The client type itself is still set explicitly on the warm request rather than classified from this string, so no bots.conf rule can turn a bot run into a guest run.

See Also:

• Constant Field Values

Method Details

current

public static WarmerConfig current()

The node's current settings.

isEnabled

public boolean isEnabled()

isListWrite

public boolean isListWrite()

getKeyBase

public String getKeyBase()

getLoopbackUrl

public String getLoopbackUrl()

getDefaultDelayMs

public long getDefaultDelayMs()

getMaxConcurrency

public int getMaxConcurrency()

getRequestTimeoutMs

public int getRequestTimeoutMs()

getAutoPauseAfterFailures

public int getAutoPauseAfterFailures()

getUserAgent

public String getUserAgent()

getEditMaxBytes

public long getEditMaxBytes()

getMaxListBytes

public long getMaxListBytes()

getMaxListEntries

public long getMaxListEntries()

getPublicDomain

public String getPublicDomain()