Index (frontcache-core 2.10.0 API)

A B C D E F G H I J K L M N O P Q R S T U V W X
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

ACCEPT - Static variable in class org.frontcache.core.FCHeaders
ACCEPT_ENCODING - Static variable in class org.frontcache.core.FCHeaders
AccessDeniedActionResponse - Class in org.frontcache.io
AccessDeniedActionResponse() - Constructor for class org.frontcache.io.AccessDeniedActionResponse
ActionResponse - Class in org.frontcache.io: Base of every management-API response.
ActionResponse() - Constructor for class org.frontcache.io.ActionResponse
actionsDescriptionMap - Static variable in class org.frontcache.io.FrontcacheAction
add(String) - Method in class org.frontcache.include.combine.CombineResponse: A part with no echo, no explicit status and no headers - i.e.
add(String, int, Map, String) - Method in class org.frontcache.include.combine.CombineResponse
add(String, String, Map) - Method in class org.frontcache.include.combine.CombineResponse: A part with cache directives.
add(CombinePart) - Method in class org.frontcache.include.combine.CombineEnvelope
addComponent(String, String, String, String) - Method in class org.frontcache.include.combine.CombineResponse: A cacheable part, spelled the way the <fc:component> tag spells it.
addError(String, int) - Method in class org.frontcache.include.combine.CombineResponse: A member the origin could not render.
addHeader(String, String) - Method in class org.frontcache.core.WebResponse
addOriginResponseHeader(String, String) - Method in class org.frontcache.core.RequestContext: adds a header to the origin response headers
addPublicForwardedHeaders(Map, RequestContext) - Static method in class org.frontcache.core.FCUtils: Adds X-Forwarded-Host / X-Forwarded-Proto naming the public site to an origin call, when front-cache.origin.forward-public-host is on.
addTags(Collection) - Method in class org.frontcache.core.WebResponse
addWarning(String) - Method in class org.frontcache.io.SetConfigActionResponse
all() - Static method in class org.frontcache.resilience.FcCommandMetrics
all() - Static method in class org.frontcache.resilience.FcThreadPools: Every pool, unfiltered.
allow() - Static method in class org.frontcache.guard.GuardAction
ALLOW - Enum constant in enum class org.frontcache.guard.GuardAction.Type
andCommandKey(String) - Method in class org.frontcache.resilience.FcCommand.Setter
andThreadPoolKey(String) - Method in class org.frontcache.resilience.FcCommand.Setter
ApacheFcHttpClient - Class in org.frontcache.core: The Apache-backed FcHttpClient.
ApacheFcHttpClient(HttpClient) - Constructor for class org.frontcache.core.ApacheFcHttpClient
A parse error refuses the whole save - Section in class org.frontcache.io.ConfigFileValidator
API_KEY_PROPERTY - Static variable in class org.frontcache.core.ApiKey: Public so a refusal message can name the property the operator has to set.
ApiKey - Class in org.frontcache.core: The front-cache.api-key check, in one place.
A ping means the node predates this action - Section in org.frontcache.client.FrontCacheClient.setConfig(ConfigFile, String, String, boolean)
applyFallbackHeaders(HttpServletResponse, WebResponse) - Static method in class org.frontcache.core.FCUtils: Apply a fallback WebResponse's status code and headers (content type plus the non-cacheable Cache-Control/Pragma markers) to the servlet response.
Authorization: Bearer <api-key> is the way to send it - Section in class org.frontcache.core.ApiKey
AUTO_PAUSE_AFTER_FAILURES - Static variable in class org.frontcache.warmer.WarmerConfig

B

backup() - Method in interface org.frontcache.cache.CacheProcessor: Backs up the on-disk index (L2) to a sibling directory at the edge.
backup() - Method in class org.frontcache.cache.impl.L1L2CacheProcessor: Backs up the L2 (Lucene) index to a sibling directory of the index dir.
backup() - Method in class org.frontcache.cache.impl.LuceneIndexManager: Takes a consistent, hot backup of the index into a .zip archive sibling to the index dir, named l2-lucene-index.backup-{yyyyMMdd_HHmmss}.zip.
backup() - Method in class org.frontcache.client.FrontCacheClient: Triggers a backup of the on-disk (L2) index on the edge.
backup(File) - Static method in class org.frontcache.io.ConfigFileStore: Copies the current file aside as <name>.backup-<yyyyMMdd_HHmmss>, the naming backup-index already uses for the Lucene index.
BACKUP_INDEX - Static variable in class org.frontcache.io.FrontcacheAction
BackupActionResponse - Class in org.frontcache.io
BackupActionResponse() - Constructor for class org.frontcache.io.BackupActionResponse
BAD_REQUEST - Enum constant in enum class org.frontcache.resilience.FcEventType
baseOf(String) - Static method in class org.frontcache.warmer.KeyBase: scheme://host[:port] of a key, normalized like a key base; null when it has none.
BIN_FIELD - Static variable in class org.frontcache.cache.impl.LuceneIndexManager
bind(String) - Method in class org.frontcache.guard.ratelimit.RateLimitPredicate: Resolves the bucket (defaulting to the rule name) and its limiter.
BotClassifier - Class in org.frontcache.bots: Decides a request's client type - bot or guest - from conf/bots.conf.
BotRule - Class in org.frontcache.bots: One classification rule from conf/bots.conf: name | condition | verdict [| dry-run].
BotRule(String, List, String, boolean) - Constructor for class org.frontcache.bots.BotRule
BotRuleEntry - Class in org.frontcache.bots: Wire/DTO view of a BotRule - what the management API (get-bots) returns and the console renders, alongside the flat botKeywords an older console knows how to read.
BotRuleEntry() - Constructor for class org.frontcache.bots.BotRuleEntry
BotRuleEntry(String, String, String, boolean, long) - Constructor for class org.frontcache.bots.BotRuleEntry
BotRuleParser - Class in org.frontcache.bots: Parses one line of conf/bots.conf.
BOTS - Enum constant in enum class org.frontcache.guard.GuardPredicateFactory.Scope
BOTS - Enum constant in enum class org.frontcache.io.ConfigFile
BOTS_CONFIG_FILE - Static variable in class org.frontcache.bots.BotClassifier
Bounding it - Section in class org.frontcache.include.combine.CombineUnsupportedMemo
BUDGET_OVERRUN_OBSERVED - Enum constant in enum class org.frontcache.resilience.FcEventType: NOT a Hystrix event, and deliberately so.
buildCombinedQuery(List) - Static method in class org.frontcache.include.combine.CombineProtocol: The combined query string, including the leading ?.
buildRequestHeaders(HttpServletRequest) - Static method in class org.frontcache.core.FCUtils
buildRequestHeaders(HttpServletRequest, boolean) - Static method in class org.frontcache.core.FCUtils
buildRequestURI(HttpServletRequest) - Static method in class org.frontcache.core.FCUtils
buildRequestURI(String) - Static method in class org.frontcache.core.FCUtils: http://localhost:8080/coin_instance_details.htm? -> /coin_instance_details.htm?
buildWebComponent(String, byte[], Map) - Static method in class org.frontcache.core.FCUtils: Builds a WebResponse from a body and a header map, applying the same x-frontcache-component-* reading every origin response goes through.
bulkhead(FcCommandConfig) - Static method in class org.frontcache.resilience.FcResilienceRegistry
bulkheadConfig() - Method in class org.frontcache.resilience.FcCommandConfig: maxWaitDuration is ZERO on purpose: Hystrix's semaphore is a non-blocking tryAcquire, so a non-zero wait here would silently turn rejections into queued waits.
bulkheadRegistry() - Static method in class org.frontcache.resilience.FcResilienceRegistry
byId(String) - Static method in enum class org.frontcache.io.ConfigFile

C

CACHE_BYPASS - Static variable in class org.frontcache.resilience.FcCommandKeys: The origin call for a request that bypasses the cache entirely.
CACHE_CONTROL - Static variable in class org.frontcache.core.FCHeaders
CACHE_FOREVER - Static variable in interface org.frontcache.cache.CacheProcessor
CACHE_HIT - Static variable in class org.frontcache.resilience.FcCommandKeys: A cache lookup - every lookup, whether it hits or misses.
CACHE_LEVEL_L1 - Static variable in class org.frontcache.core.FCHeaders
CACHE_LEVEL_L2 - Static variable in class org.frontcache.core.FCHeaders
CACHE_MISS - Static variable in class org.frontcache.resilience.FcCommandKeys: The origin call behind a cache miss, whichever transport reaches the origin.
CACHED - Enum constant in enum class org.frontcache.include.combine.FcCombineMetrics.Member: The cache probe served it, so it never joined a batch.
CACHED_ENTRIES - Static variable in interface org.frontcache.cache.CacheProcessor
cachedHash(String) - Method in class org.frontcache.warmer.WarmerListStore: WarmerListStore.hash(String), remembered per (mtime, size).
CacheManager - Class in org.frontcache.cache
Cache-Miss is two pre-2.9.0 keys combined - Section in class org.frontcache.resilience.FcCommandKeys
CacheProcessor - Interface in org.frontcache.cache
CacheProcessorBase - Class in org.frontcache.cache
CacheProcessorBase() - Constructor for class org.frontcache.cache.CacheProcessorBase
CacheReplicator - Class in org.frontcache.replication: Replicates cache entries from a source edge to a target edge.
CacheReplicator(FrontCacheClient, FrontCacheClient) - Constructor for class org.frontcache.replication.CacheReplicator
CacheStats - Class in org.frontcache.cache: A cheap size-and-churn snapshot of a cache processor, for the metrics exporter.
CacheStats(long, long, long, long) - Constructor for class org.frontcache.cache.CacheStats: Kept for cache processors that do not track L1's byte size - CacheProcessor is a reflection-loaded extension point, so an implementation outside this repo still compiles and still reports honestly: not tracking a number is what CacheStats.UNKNOWN is for, and unlike the FallbackResolver case a default here cannot silently answer a question wrongly.
CacheStats(long, long, long, long, long) - Constructor for class org.frontcache.cache.CacheStats
CacheStatusActionResponse - Class in org.frontcache.io
CacheStatusActionResponse() - Constructor for class org.frontcache.io.CacheStatusActionResponse
CacheStatusActionResponse(Map) - Constructor for class org.frontcache.io.CacheStatusActionResponse
CacheWarmer - Class in org.frontcache.warmer: Runs one URI list through this node's own front door, paced, and reports what happened.
CacheWarmer.RefusedException - Exception Class in org.frontcache.warmer: A start, update or control call that was refused, with a reason fit for an operator.
CacheWarmer.State - Enum Class in org.frontcache.warmer
callInclude(String, String, Map, FcHttpClient, RequestContext, String, String) - Method in class org.frontcache.include.IncludeProcessorBase: Resolve one include: from cache when it is there, from the origin when it is not.
cancel() - Method in class org.frontcache.replication.CacheReplicator: Requests cancellation of the running replication.
canonicalizeURL(String) - Static method in class org.frontcache.core.FCUtils: The URL a request for urlStr will actually be made with: scheme and host untouched, path and query normalised exactly as FCUtils.buildRequestURI(String) normalises them for the wire.
Cardinality - Section in class org.frontcache.metrics.FcMetricsExport
checkAndCount(long, long) - Method in class org.frontcache.guard.ratelimit.WindowLimiter: Counts one request for keyHash and says whether it is over the limit.
checkpointFile() - Method in class org.frontcache.warmer.WarmerListStore: warmer/.state/run.json - a fixed name, never caller-supplied.
Cidr - Class in org.frontcache.core: An address block, compared on raw address bytes so v4 and v6 never match each other.
circuitBreaker(FcCommandConfig) - Static method in class org.frontcache.resilience.FcResilienceRegistry
circuitBreakerConfig() - Method in class org.frontcache.resilience.FcCommandConfig: Two Resilience4j defaults have to be overridden or production behavior changes silently: permittedNumberOfCallsInHalfOpenState (R4j 10, Hystrix probes with exactly 1) and the exception exclusions below.
circuitBreakerRegistry() - Static method in class org.frontcache.resilience.FcResilienceRegistry: The registries themselves, for the Micrometer binders in org.frontcache.metrics.
classify(RequestContext) - Method in class org.frontcache.bots.BotClassifier: Classifies one request.
clear() - Method in class org.frontcache.include.combine.CombineUnsupportedMemo: Forget everything - for tests, and for a config reload that changes the TTL.
CLIENT_TYPE_RULE - Static variable in class org.frontcache.warmer.WarmRequest: What RequestContext.getClientTypeRule() reports for a warm request.
ClientIpResolver - Class in org.frontcache.core: Resolves the client IP address that rate limiting counts against.
ClientIpResolver(String, String) - Constructor for class org.frontcache.core.ClientIpResolver
close() - Method in class org.frontcache.cache.impl.LuceneIndexManager
close() - Method in class org.frontcache.client.FrontCacheCluster
close() - Method in class org.frontcache.warmer.LoopbackWarmTransport
close() - Method in interface org.frontcache.warmer.WarmTransport
COLLAPSED - Enum constant in enum class org.frontcache.resilience.FcEventType: Never emitted - Frontcache registers no collapsers.
Collisions - Section in class org.frontcache.guard.ratelimit.WindowLimiter
COMBINED - Enum constant in enum class org.frontcache.include.combine.FcCombineMetrics.Member: Served from a part of a combined response.
CombineEnvelope - Class in org.frontcache.include.combine: The combined response: one part per requested member, in the order the members were sent.
CombineEnvelope() - Constructor for class org.frontcache.include.combine.CombineEnvelope
CombinePart - Class in org.frontcache.include.combine: One member's answer inside a CombineEnvelope.
CombinePart() - Constructor for class org.frontcache.include.combine.CombinePart
CombinePart(String, int, Map, String) - Constructor for class org.frontcache.include.combine.CombinePart
CombineProtocol - Class in org.frontcache.include.combine: The combine-and-reduce wire contract, in one place: parameter names, the encoding of a member's query string, and the small URL arithmetic both ends need.
CombineRequest - Class in org.frontcache.include.combine: The origin's half of the combine contract: read a combined request.
CombineResponse - Class in org.frontcache.include.combine: The origin's half of the combine contract: build and write the response envelope.
CombineResponse() - Constructor for class org.frontcache.include.combine.CombineResponse
CombineUnsupportedMemo - Class in org.frontcache.include.combine: Remembers, per batch group, that the origin does not implement combining.
CombineUnsupportedMemo() - Constructor for class org.frontcache.include.combine.CombineUnsupportedMemo
COMMAND_KEY_INCLUDE_REQUEST - Static variable in class org.frontcache.resilience.FC_Total: Requests that are a Frontcache include arriving back through the front door.
COMMAND_KEY_INPUT_REQUEST - Static variable in class org.frontcache.resilience.FC_Total: Requests from a client - what an operator reads as "how much traffic is this node taking".
COMMAND_KEY_WARM_REQUEST - Static variable in class org.frontcache.resilience.FC_Total: The cache warmer's own requests - see org.frontcache.warmer.WarmRequest.
commandFrame(FcCommandMetrics) - Static method in class org.frontcache.resilience.stream.FcDashboardJson
commit() - Method in class org.frontcache.cache.impl.LuceneIndexManager: Commits pending changes now, instead of waiting for the scheduled commit.
COMPONENT_ASYNC_INCLUDE - Static variable in class org.frontcache.core.FCHeaders
COMPONENT_COMBINED_INCLUDE - Static variable in class org.frontcache.core.FCHeaders: A sync include that was resolved as one member of a combined origin call (docs/archive/combine-reduce-proposal.md).
COMPONENT_INCLUDE - Static variable in class org.frontcache.core.FCHeaders
COMPONENT_REFRESH_TYPE_REGULAR - Static variable in class org.frontcache.core.FCHeaders
COMPONENT_REFRESH_TYPE_SOFT - Static variable in class org.frontcache.core.FCHeaders
COMPONENT_TAGS_SEPARATOR - Static variable in class org.frontcache.core.FCHeaders
COMPONENT_TOPLEVEL - Static variable in class org.frontcache.core.FCHeaders
ConcurrentIncludeProcessor - Class in org.frontcache.include.impl: Processing URL example invalid input: '<'fc:include url="/some/url/here" />
ConcurrentIncludeProcessor() - Constructor for class org.frontcache.include.impl.ConcurrentIncludeProcessor
config() - Method in class org.frontcache.warmer.CacheWarmer: The node's current front-cache.warmer.* settings.
CONFIG_WRITE_PROPERTY - Static variable in class org.frontcache.io.ConfigWriteAction: Property that turns runtime config writes off for this node.
ConfigFile - Enum Class in org.frontcache.io: The config files the management API will write, and the only names set-config accepts.
ConfigFileStore - Class in org.frontcache.io: Reads, hashes, backs up and atomically replaces a config file under FRONTCACHE_HOME/conf.
ConfigFileValidator - Class in org.frontcache.io: Dry-parses a candidate config file before set-config writes it.
configured() - Static method in class org.frontcache.core.ApiKey
configuredCommandKeys() - Method in class org.frontcache.resilience.FcResilienceConfig: Every command key the file mentions - used by tests and by the config dump.
ConfigWriteAction - Class in org.frontcache.io: What set-config actually does, with no HttpServletRequest in sight.
CONNECTION_TIMEOUT - Static variable in class org.frontcache.client.FrontCacheClient
cont(List) - Static method in class org.frontcache.guard.GuardOutcome
contains(String) - Method in class org.frontcache.core.Cidr
contains(InetAddress) - Method in class org.frontcache.core.Cidr
CONTENT_TYPE - Static variable in class org.frontcache.core.FCHeaders
CONTINUE - Static variable in class org.frontcache.guard.GuardOutcome: no rule matched - the request continues as usual
convertHeaders(Map) - Static method in class org.frontcache.core.FCUtils
copy() - Method in class org.frontcache.core.RequestContext
copy() - Method in class org.frontcache.core.WebResponse: A shallow copy: the content byte[] is SHARED, not cloned.
count(FcCacheMetrics.Outcome) - Static method in class org.frontcache.cache.FcCacheMetrics
count(FcCombineMetrics.Batch) - Static method in class org.frontcache.include.combine.FcCombineMetrics
count(FcCombineMetrics.Error) - Static method in class org.frontcache.include.combine.FcCombineMetrics
count(FcCombineMetrics.Member) - Static method in class org.frontcache.include.combine.FcCombineMetrics
COUNT - Enum constant in enum class org.frontcache.include.combine.FcCombineMetrics.Error: The part count did not match the member count.
Counters, not a distribution summary - Section in class org.frontcache.include.combine.FcCombineMetrics
countHit() - Method in class org.frontcache.bots.BotRule
countHit() - Method in class org.frontcache.guard.GuardRule
createFailedList(String) - Method in class org.frontcache.warmer.WarmerListStore: A new file for a run's failed entries.
CRLF is the one that bites - Section in org.frontcache.io.ConfigFileStore.normalize(String)
current() - Static method in class org.frontcache.core.FcNodeStats: Reads the JVM now.
current() - Static method in class org.frontcache.warmer.WarmerConfig: The node's current settings.
currentContent is only filled on a conflict - Section in class org.frontcache.io.SetConfigActionResponse

D

debugComments - Static variable in class org.frontcache.FrontCacheEngine
decodePart(String) - Static method in class org.frontcache.include.combine.CombineProtocol: Inverse of CombineProtocol.encodePart(String).
decrementCurrentConcurrentConnections() - Method in class org.frontcache.resilience.stream.FcDashboardStreamServlet
decrementCurrentConcurrentConnections() - Method in class org.frontcache.resilience.stream.FcSampleSseServlet
DEFAULT_DELAY_MS - Static variable in class org.frontcache.warmer.WarmerConfig
DEFAULT_DOMAIN - Static variable in class org.frontcache.FCConfig
DEFAULT_FRONTCACHE_HOST_NAME_VALUE - Static variable in class org.frontcache.FrontCacheEngine
DEFAULT_FRONTCACHE_ID - Static variable in class org.frontcache.FCConfig
DEFAULT_PAUSE_POLLER_THREAD_DELAY_IN_MS - Static variable in class org.frontcache.resilience.stream.FcSampleSseServlet: Publish cadence in ms.
DEFAULT_ROLLING_STATS_MS - Static variable in class org.frontcache.resilience.FcResilienceConfig
DEFAULT_USER_AGENT - Static variable in class org.frontcache.warmer.WarmerConfig: 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.
DefaultFallbackResolver - Class in org.frontcache.resilience.fr
DefaultFallbackResolver() - Constructor for class org.frontcache.resilience.fr.DefaultFallbackResolver
defaultKeyBase(WarmerConfig, boolean) - Static method in class org.frontcache.warmer.CacheWarmer: The default key base: front-cache.warmer.key-base, else <scheme>://<default-domain>, else null - in which case a run cannot start until the operator names one.
defaults() - Static method in class org.frontcache.cache.impl.LuceneIndexManager.Tuning
delete(String) - Method in class org.frontcache.cache.impl.LuceneIndexManager: Removes documents by url or tag.
delete(String) - Method in class org.frontcache.warmer.WarmerListStore: Removes one list.
DELETE_WARMER_LIST - Static variable in class org.frontcache.io.FrontcacheAction
deleteAll() - Method in class org.frontcache.cache.impl.LuceneIndexManager: Removes every document from the index.
deleteExpired() - Method in class org.frontcache.cache.impl.LuceneIndexManager: Removes all documents whose effective expiration timestamp is in the past.
deleteList(CacheWarmer, String, boolean) - Static method in class org.frontcache.io.WarmerActions
deleteWarmerList(String) - Method in class org.frontcache.client.FrontCacheClient
describe() - Method in interface org.frontcache.guard.GuardPredicate
describe() - Method in class org.frontcache.guard.ratelimit.RateLimitPredicate
destroy() - Method in interface org.frontcache.cache.CacheProcessor
destroy() - Method in class org.frontcache.cache.CacheProcessorBase
destroy() - Method in class org.frontcache.cache.impl.InMemoryCacheProcessor
destroy() - Method in class org.frontcache.cache.impl.L1L2CacheProcessor
destroy() - Static method in class org.frontcache.FCConfig
destroy() - Static method in class org.frontcache.FrontCacheEngine
destroy() - Method in class org.frontcache.FrontCacheFilter
destroy() - Method in class org.frontcache.FrontCacheServlet
destroy() - Method in class org.frontcache.include.impl.ConcurrentIncludeProcessor
destroy() - Method in interface org.frontcache.include.IncludeProcessor
destroy() - Method in class org.frontcache.include.IncludeProcessorBase
destroy() - Method in class org.frontcache.io.FrontCacheIOServlet
destroy() - Static method in class org.frontcache.resilience.fr.FallbackResolverFactory
destroy() - Method in class org.frontcache.resilience.stream.FcSampleSseServlet
DISPOSITION_DRY_RUN - Static variable in class org.frontcache.guard.GuardAction
DISPOSITION_REDIRECTED - Static variable in class org.frontcache.guard.GuardAction
DISPOSITION_REJECTED - Static variable in class org.frontcache.guard.GuardAction: disposition written to the failed-requests log (the is_cached column)
doEndTag() - Method in class org.frontcache.tags.IncludeSupport
doEndTag() - Method in class org.frontcache.tags.WebComponentSupport
doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class org.frontcache.FrontCacheFilter
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.frontcache.io.FrontCacheIOServlet
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.frontcache.metrics.FcMetricsServlet
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.frontcache.resilience.stream.FcSampleSseServlet
doPost(HttpServletRequest, HttpServletResponse) - Method in class org.frontcache.io.FrontCacheIOServlet
doSoftInvalidation(String, String, Map, FcHttpClient, RequestContext) - Method in interface org.frontcache.cache.CacheProcessor
doSoftInvalidation(String, String, Map, FcHttpClient, RequestContext) - Method in class org.frontcache.cache.CacheProcessorBase: perform async invalidation
doStartTag() - Method in class org.frontcache.tags.IncludeSupport
doStartTag() - Method in class org.frontcache.tags.WebComponentSupport
downloadWarmerList(String, OutputStream) - Method in class org.frontcache.client.FrontCacheClient: Streams a whole list into os (raw=true) - never through memory, so a 64 MB list can pass through the console to a browser.
DUMP_KEYS - Static variable in class org.frontcache.io.FrontcacheAction
dumpKeys() - Method in class org.frontcache.client.FrontCacheClient: Triggers dumping of cached keys to a file on the edge (./warmer dir).
DumpKeysActionResponse - Class in org.frontcache.io
DumpKeysActionResponse() - Constructor for class org.frontcache.io.DumpKeysActionResponse
DYNAMIC_URLS - Enum constant in enum class org.frontcache.io.ConfigFile
dynamicCall(String, Map, FcHttpClient, RequestContext) - Static method in class org.frontcache.core.FCUtils: GET method only for text requests for cache processor - it can use both (httpClient or filter)

E

ECHO - Enum constant in enum class org.frontcache.include.combine.FcCombineMetrics.Error: A q echo named a member other than the one sent at that position.
EDIT_MAX_BYTES - Static variable in class org.frontcache.warmer.WarmerConfig
EMPTY_USER_AGENT_IS_BOT_PROPERTY - Static variable in class org.frontcache.bots.BotClassifier
emptyPart() - Static method in class org.frontcache.include.combine.CombineRequest: Unmodifiable empty member, for a handler that wants a non-null default.
ENABLED - Static variable in class org.frontcache.warmer.WarmerConfig
ENABLED_PROPERTY - Static variable in class org.frontcache.guard.ratelimit.GuardRateLimiterRegistry
encodePart(String) - Static method in class org.frontcache.include.combine.CombineProtocol: Percent-encodes one member query string for transport as a single parameter value.
END_MARKER - Static variable in class org.frontcache.include.IncludeProcessorBase
endpointOf(String) - Static method in class org.frontcache.include.combine.CombineProtocol: Everything before the ? - the endpoint a batch is grouped by and addressed to.
entriesTotal(String) - Static method in class org.frontcache.warmer.CacheWarmer
ENTRY - Enum constant in enum class org.frontcache.warmer.WarmerEntry.Kind
ENVELOPE_CONTENT_TYPE - Static variable in class org.frontcache.include.combine.CombineProtocol
equals(Object) - Method in class org.frontcache.client.FrontCacheClient
equals(Object) - Method in record class org.frontcache.resilience.FcResilienceReload.Result: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class org.frontcache.warmer.KeyBase
ERROR - Enum constant in enum class org.frontcache.include.combine.FcCombineMetrics.Batch: The origin claims support and sent something unusable - see FcCombineMetrics.Error.
evaluate(RequestContext) - Method in class org.frontcache.guard.GuardRuleEngine: Runs the rules for one request.
EXCEPTION_THROWN - Enum constant in enum class org.frontcache.resilience.FcEventType: The command threw out of execute() instead of returning a fallback.
execute() - Method in class org.frontcache.resilience.FcCommand
existing(String) - Static method in class org.frontcache.resilience.FcCommandMetrics
existing(String) - Static method in class org.frontcache.resilience.FcThreadPools
existingCircuitBreaker(String) - Static method in class org.frontcache.resilience.FcResilienceRegistry: The breaker for a command key if one was ever created, else null.
existingInstance() - Static method in class org.frontcache.cache.CacheManager
existingInstance() - Static method in class org.frontcache.FrontCacheEngine: The engine if one has been built, without building one.
existingInstance() - Static method in class org.frontcache.warmer.CacheWarmer: The warmer if one has been created, without creating one - for the metrics exporter.
exists(String) - Method in class org.frontcache.warmer.WarmerListStore
EXPIRE_DATE_FIELD - Static variable in class org.frontcache.cache.impl.LuceneIndexManager

F

FAILED - Enum constant in enum class org.frontcache.include.combine.FcCombineMetrics.Batch: The call itself did not produce an origin answer: timeout, circuit open, 5xx, bulkhead.
failedListName(String, String) - Static method in class org.frontcache.warmer.WarmerListStore: The name the failed entries of a run over listName go to.
FAILURE - Enum constant in enum class org.frontcache.resilience.FcEventType
failureType(List) - Static method in class org.frontcache.resilience.FallbackLogger: Maps command execution events to the failure category shown on the realtime dashboard (Short-Circuited | Bad Request | Timeout | Rejected | Failure).
FALLBACK - Enum constant in enum class org.frontcache.include.combine.FcCombineMetrics.Member: Got no content and fell back: the batch failed, or its part carried a non-2xx status.
FALLBACK_CACHE_CONTROL - Static variable in class org.frontcache.resilience.fr.FileBasedFallbackResolver
FALLBACK_FAILURE - Enum constant in enum class org.frontcache.resilience.FcEventType
FALLBACK_HTTP_STATUS - Static variable in class org.frontcache.resilience.fr.FileBasedFallbackResolver
FALLBACK_REJECTION - Enum constant in enum class org.frontcache.resilience.FcEventType: Never emitted.
FALLBACK_SUCCESS - Enum constant in enum class org.frontcache.resilience.FcEventType
FallbackConfigEntry - Class in org.frontcache.resilience.fr
FallbackConfigEntry() - Constructor for class org.frontcache.resilience.fr.FallbackConfigEntry
FallbackConfigEntryImpl - Class in org.frontcache.resilience.fr
FallbackConfigEntryImpl() - Constructor for class org.frontcache.resilience.fr.FallbackConfigEntryImpl
FallbackLogger - Class in org.frontcache.resilience: Marker for Logger
FallbackLogger() - Constructor for class org.frontcache.resilience.FallbackLogger
FallbackResolver - Interface in org.frontcache.resilience.fr: Resolves the canned response served when an origin call fails or its circuit is open.
FallbackResolverFactory - Class in org.frontcache.resilience.fr
FALLBACKS - Enum constant in enum class org.frontcache.io.ConfigFile
FC_BypassCache - Class in org.frontcache.resilience
FC_BypassCache(HttpClient, RequestContext) - Constructor for class org.frontcache.resilience.FC_BypassCache
FC_ThroughCache - Class in org.frontcache.resilience: All GET requests which flows through cache (cached invalid input: '&' not)
FC_ThroughCache(CacheProcessorBase, String, RequestContext) - Constructor for class org.frontcache.resilience.FC_ThroughCache
FC_ThroughCache_HttpClient - Class in org.frontcache.resilience
FC_ThroughCache_HttpClient(String, Map, HttpClient, RequestContext) - Constructor for class org.frontcache.resilience.FC_ThroughCache_HttpClient
FC_ThroughCache_WebFilter - Class in org.frontcache.resilience
FC_ThroughCache_WebFilter(RequestContext) - Constructor for class org.frontcache.resilience.FC_ThroughCache_WebFilter
FC_Total - Class in org.frontcache.resilience: All requests through Frontcache engine Must use SEMAPHORE to access the same thread
FC_Total(FrontCacheEngine, RequestContext) - Constructor for class org.frontcache.resilience.FC_Total
FcBadRequestException - Exception Class in org.frontcache.resilience: Replaces com.netflix.hystrix.exception.HystrixBadRequestException: the caller asked for something invalid, so the failure says nothing about the health of the dependency.
FcBadRequestException(String) - Constructor for exception class org.frontcache.resilience.FcBadRequestException
FcBadRequestException(String, Throwable) - Constructor for exception class org.frontcache.resilience.FcBadRequestException
FcCacheMetrics - Class in org.frontcache.cache: Cache read outcomes, counted per tier.
FcCacheMetrics.Outcome - Enum Class in org.frontcache.cache: Where a cache read was answered from, or that it was not.
FcCombineMetrics - Class in org.frontcache.include.combine: Combine-and-reduce outcomes, counted per batch and per member.
FcCombineMetrics.Batch - Enum Class in org.frontcache.include.combine: How a combined origin call ended.
FcCombineMetrics.Error - Enum Class in org.frontcache.include.combine: Why an envelope was rejected.
FcCombineMetrics.Member - Enum Class in org.frontcache.include.combine: How one combine candidate was ultimately resolved.
FcCommand<T> - Class in org.frontcache.resilience: The seam.
FcCommand(FcCommand.Setter) - Constructor for class org.frontcache.resilience.FcCommand
FcCommand.Setter - Class in org.frontcache.resilience: Mirrors HystrixCommand.Setter so the constructor bodies of the five commands change by one type name and nothing else.
FcCommandConfig - Class in org.frontcache.resilience: The resolved settings for one command key, read from conf/resilience.properties by FcResilienceConfig and translated to Resilience4j configs here.
FcCommandConfig.Isolation - Enum Class in org.frontcache.resilience
FcCommandException - Exception Class in org.frontcache.resilience: Replaces com.netflix.hystrix.exception.HystrixRuntimeException: thrown out of FcCommand.execute() when the command failed AND the fallback could not supply a value.
FcCommandException(String, FcEventType, String, Throwable) - Constructor for exception class org.frontcache.resilience.FcCommandException
FcCommandKeys - Class in org.frontcache.resilience: The command keys, in one place.
FcCommandMetrics - Class in org.frontcache.resilience: Rolling metrics for one command, shaped to the Hystrix dashboard JSON rather than to Resilience4j's data model.
FcCommandMetrics.LatencySnapshot - Class in org.frontcache.resilience: The mean and the nine percentiles, read from ONE merge of the bucket ring.
FCConfig - Class in org.frontcache
FCConfig() - Constructor for class org.frontcache.FCConfig
FcDashboardJson - Class in org.frontcache.resilience.stream: Serializes FcCommandMetrics and FcThreadPools into the Hystrix dashboard's JSON, replacing SerialHystrixDashboardData.
FcDashboardStreamServlet - Class in org.frontcache.resilience.stream
FcDashboardStreamServlet() - Constructor for class org.frontcache.resilience.stream.FcDashboardStreamServlet
FcEventType - Enum Class in org.frontcache.resilience: Execution outcomes of an FcCommand, replacing com.netflix.hystrix.HystrixEventType.
FCHeaders - Class in org.frontcache.core
FCHeaders() - Constructor for class org.frontcache.core.FCHeaders
FcHttpClient - Interface in org.frontcache.core: Frontcache's own origin-fetch abstraction - the extension points' view of "go get this URL".
FcMetricsExport - Class in org.frontcache.metrics: Prometheus / OTLP export, additive alongside the SSE stream.
FcMetricsServlet - Class in org.frontcache.metrics: The Prometheus scrape endpoint, /fc-metrics.
FcMetricsServlet() - Constructor for class org.frontcache.metrics.FcMetricsServlet
FcNodeStats - Class in org.frontcache.core: A cheap snapshot of the JVM this node runs in: heap, process CPU, uptime.
FcNodeStats(long, long, double, long) - Constructor for class org.frontcache.core.FcNodeStats
FcResilienceConfig - Class in org.frontcache.resilience: Reads conf/resilience.properties into plain Properties and resolves per-command settings from it, replacing the Archaius ConfigurationManager.install() path.
FcResilienceRegistry - Class in org.frontcache.resilience: Holds the Resilience4j registries, keyed by command key.
FcResilienceReload - Class in org.frontcache.resilience: Applies an edited conf/resilience.properties to a running node, for the reload-resilience management action.
FcResilienceReload.Result - Record Class in org.frontcache.resilience
FcSampleSseServlet - Class in org.frontcache.resilience.stream: Serves the SSE dashboard stream at /fc-dashboard.stream and at the pre-2.7 /hystrix.stream, from Frontcache's own metrics instead of Hystrix's.
FcSampleSseServlet(int) - Constructor for class org.frontcache.resilience.stream.FcSampleSseServlet
FcThreadPools - Class in org.frontcache.resilience: The named thread pools Frontcache owns, replacing HystrixThreadPool.
FCUtils - Class in org.frontcache.core
fetch(String) - Method in class org.frontcache.core.ApacheFcHttpClient
fetch(String) - Method in interface org.frontcache.core.FcHttpClient: One-shot GET with no resilience wrapper and no request context - for bootstrap-time downloads such as prefetching fallback pages.
fetch(String, Map, RequestContext) - Method in class org.frontcache.core.ApacheFcHttpClient
fetch(String, Map, RequestContext) - Method in interface org.frontcache.core.FcHttpClient: Fetch through whichever origin transport this node uses: an HTTP call in standalone mode, the origin app's own filter chain in webfilter mode.
fetchIncludeFromOrigin(String, String, Map, FcHttpClient, RequestContext, String, String, long) - Method in class org.frontcache.include.IncludeProcessorBase: The origin half of IncludeProcessorBase.callInclude(String, String, Map, FcHttpClient, RequestContext, String, String), reached when IncludeProcessorBase.getIncludeFromCache(String, String, Map, FcHttpClient, RequestContext, String, String, long) found nothing serveable.
fetchOverHttp(String, Map, RequestContext) - Method in class org.frontcache.core.ApacheFcHttpClient
fetchOverHttp(String, Map, RequestContext) - Method in interface org.frontcache.core.FcHttpClient: Fetch over HTTP specifically, never the filter chain.
FileBasedFallbackResolver - Class in org.frontcache.resilience.fr
FileBasedFallbackResolver() - Constructor for class org.frontcache.resilience.fr.FileBasedFallbackResolver
fileName - Variable in class org.frontcache.resilience.fr.FallbackConfigEntry
forCommand(String, String) - Method in class org.frontcache.resilience.FcResilienceConfig
forNode() - Static method in class org.frontcache.warmer.WarmerListStore: The store for this node: FRONTCACHE_HOME/warmer, created if absent.
FORWARD_PUBLIC_HOST_KEY - Static variable in class org.frontcache.FrontCacheEngine: Whether origin calls carry X-Forwarded-Host / X-Forwarded-Proto naming the public site.
frames() - Static method in class org.frontcache.resilience.stream.FcDashboardJson: One frame per command plus one per thread pool.
fromJson(byte[]) - Static method in class org.frontcache.include.combine.CombineEnvelope
fromJson(String) - Static method in class org.frontcache.include.combine.CombineEnvelope
FRONT_CACHE_HOME_ENVIRONMENT_KEY - Static variable in class org.frontcache.FCConfig
FRONT_CACHE_HOME_SYSTEM_KEY - Static variable in class org.frontcache.FCConfig
FRONTCACHE_ID_KEY - Static variable in class org.frontcache.FCConfig
FrontcacheAction - Class in org.frontcache.io
FrontcacheAction() - Constructor for class org.frontcache.io.FrontcacheAction
FrontCacheClient - Class in org.frontcache.client
FrontCacheClient(String, String) - Constructor for class org.frontcache.client.FrontCacheClient
FrontCacheCluster - Class in org.frontcache.client
FrontCacheCluster() - Constructor for class org.frontcache.client.FrontCacheCluster
FrontCacheCluster(String) - Constructor for class org.frontcache.client.FrontCacheCluster
FrontCacheCluster(Collection, String) - Constructor for class org.frontcache.client.FrontCacheCluster
FrontCacheCluster(Collection) - Constructor for class org.frontcache.client.FrontCacheCluster
FrontCacheEngine - Class in org.frontcache
FrontCacheException - Exception Class in org.frontcache.core
FrontCacheException() - Constructor for exception class org.frontcache.core.FrontCacheException
FrontCacheException(String) - Constructor for exception class org.frontcache.core.FrontCacheException
FrontCacheException(String, Throwable) - Constructor for exception class org.frontcache.core.FrontCacheException
FrontCacheException(String, Throwable, boolean, boolean) - Constructor for exception class org.frontcache.core.FrontCacheException
FrontCacheException(Throwable) - Constructor for exception class org.frontcache.core.FrontCacheException
FrontCacheFilter - Class in org.frontcache
FrontCacheFilter() - Constructor for class org.frontcache.FrontCacheFilter
FrontCacheHttpResponseWrapper - Interface in org.frontcache.wrapper
FrontCacheIOServlet - Class in org.frontcache.io
FrontCacheIOServlet() - Constructor for class org.frontcache.io.FrontCacheIOServlet
FrontCacheServlet - Class in org.frontcache
FrontCacheServlet() - Constructor for class org.frontcache.FrontCacheServlet

G

GET_BOTS - Static variable in class org.frontcache.io.FrontcacheAction
GET_BOTS_CONFIG - Static variable in class org.frontcache.io.FrontcacheAction: The raw conf/bots.conf, as FrontcacheAction.GET_GUARD_CONFIG is to FrontcacheAction.GET_GUARD_RULES: this one returns the file, FrontcacheAction.GET_BOTS returns what the node parsed out of it.
GET_CACHE_STATE - Static variable in class org.frontcache.io.FrontcacheAction
GET_CACHED_KEYS - Static variable in class org.frontcache.io.FrontcacheAction
GET_DYNAMIC_URLS - Static variable in class org.frontcache.io.FrontcacheAction
GET_DYNAMIC_URLS_CONFIG - Static variable in class org.frontcache.io.FrontcacheAction: The raw conf/dynamic-urls.conf, as FrontcacheAction.GET_GUARD_CONFIG is to FrontcacheAction.GET_GUARD_RULES: this one returns the file, FrontcacheAction.GET_DYNAMIC_URLS returns the patterns parsed from it.
GET_FALLBACK_CONFIGS - Static variable in class org.frontcache.io.FrontcacheAction
GET_FALLBACKS_CONFIG - Static variable in class org.frontcache.io.FrontcacheAction: The raw conf/fallbacks.conf, as FrontcacheAction.GET_GUARD_CONFIG is to FrontcacheAction.GET_GUARD_RULES: this one returns the file, FrontcacheAction.GET_FALLBACK_CONFIGS returns the entries parsed from it.
GET_FROM_CACHE - Static variable in class org.frontcache.io.FrontcacheAction
GET_GUARD_CONFIG - Static variable in class org.frontcache.io.FrontcacheAction
GET_GUARD_RULES - Static variable in class org.frontcache.io.FrontcacheAction
GET_HYSTRIX_CONFIGS - Static variable in class org.frontcache.io.FrontcacheAction: Deprecated.
send FrontcacheAction.GET_RESILIENCE_CONFIGS instead
GET_NODE_STATS - Static variable in class org.frontcache.io.FrontcacheAction: The cheap, pollable companion of FrontcacheAction.GET_CACHE_STATE: typed cache sizes plus the JVM's heap, CPU and uptime, all read from state the process already holds.
GET_RESILIENCE_CONFIGS - Static variable in class org.frontcache.io.FrontcacheAction
GET_WARMER_LIST - Static variable in class org.frontcache.io.FrontcacheAction: One list: the whole content when small enough to edit, else a head/tail preview; grep= searches, raw=true streams it.
getAction() - Method in class org.frontcache.guard.GuardOutcome
getAction() - Method in class org.frontcache.guard.GuardRule
getAction() - Method in class org.frontcache.guard.GuardRuleEntry
getAction() - Method in class org.frontcache.io.ActionResponse
getActionsDescription() - Method in class org.frontcache.io.HelpActionResponse
getApacheClient() - Method in class org.frontcache.core.ApacheFcHttpClient: The underlying Apache client.
getAt() - Method in class org.frontcache.warmer.WarmerError
getAutoPauseAfterFailures() - Method in class org.frontcache.warmer.WarmerConfig
getBackupFile() - Method in class org.frontcache.io.SetConfigActionResponse
getBody() - Method in class org.frontcache.guard.GuardAction
getBody() - Method in class org.frontcache.include.combine.CombinePart
getBoolean(String) - Method in class org.frontcache.core.RequestContext: Convenience method to return a boolean value for a given key
getBoolean(String, boolean) - Method in class org.frontcache.core.RequestContext: Convenience method to return a boolean value for a given key
getBotKeywords() - Method in class org.frontcache.client.FrontCacheClient
getBotKeywords() - Method in class org.frontcache.io.GetBotsActionResponse
getBotRules() - Method in class org.frontcache.client.FrontCacheClient
getBotRules() - Method in class org.frontcache.io.GetBotsActionResponse: The rules in evaluation order (built-ins included), each with its hit count since load.
getBots() - Method in class org.frontcache.client.FrontCacheClient: Deprecated.
pre-2.7 shape: a single-entry map keyed by domain. Use FrontCacheClient.getBotKeywords().
getBots() - Method in class org.frontcache.io.GetBotsActionResponse: Deprecated.
pre-2.7 shape of GetBotsActionResponse.getBotKeywords() - a single-entry map keyed by domain.
getBotsActionResponse() - Method in class org.frontcache.client.FrontCacheClient
GetBotsActionResponse - Class in org.frontcache.io: Bot classification config from ./conf/bots.conf: the ordered rules, and the bare User-Agent keywords.
GetBotsActionResponse() - Constructor for class org.frontcache.io.GetBotsActionResponse
getBotsConfig() - Method in class org.frontcache.client.FrontCacheClient
getBotsConfig() - Method in class org.frontcache.io.GetBotsConfigActionResponse
getBotsConfigActionResponse() - Method in class org.frontcache.client.FrontCacheClient: The raw conf/bots.conf of this edge - what the console's Bot Configs screen renders.
GetBotsConfigActionResponse - Class in org.frontcache.io: The raw ./conf/bots.conf of one node, for the console's Bot Configs screen.
GetBotsConfigActionResponse() - Constructor for class org.frontcache.io.GetBotsConfigActionResponse
getBotUserAgentKeywords() - Static method in class org.frontcache.FCConfig: Bare bot user-agent keywords from conf/bots.conf.
getBucket() - Method in class org.frontcache.guard.ratelimit.RateLimitPredicate
getBucket() - Method in class org.frontcache.guard.ratelimit.RateLimitSpec
getBucket() - Method in class org.frontcache.guard.ratelimit.WindowLimiter
getBytes() - Method in class org.frontcache.warmer.WarmerListInfo
getBytes() - Method in class org.frontcache.warmer.WarmerListView
getBytes() - Method in class org.frontcache.warmer.WarmerPreflight
getCachedEntries() - Method in class org.frontcache.io.NodeStatsActionResponse: Entries across both tiers, or -1 when either tier does not report.
getCachedFresh() - Method in class org.frontcache.warmer.WarmerPreflight
getCachedKeys() - Method in interface org.frontcache.cache.CacheProcessor
getCachedKeys() - Method in class org.frontcache.cache.impl.InMemoryCacheProcessor
getCachedKeys() - Method in class org.frontcache.cache.impl.L1L2CacheProcessor
getCachedKeys() - Method in class org.frontcache.cache.impl.NoopCacheProcessor
getCachedKeys(int) - Method in interface org.frontcache.cache.CacheProcessor: At most limit cached keys, in no particular order - for a caller that samples the key space (the cache warmer's key-base check) rather than listing it.
getCachedKeys(int) - Method in class org.frontcache.cache.impl.L1L2CacheProcessor
getCachedKeys(OutputStream) - Method in class org.frontcache.client.FrontCacheClient: Writes keys to provided output stream
getCachedKeysSet() - Method in class org.frontcache.client.FrontCacheClient: Fetches all cached keys from the remote node and returns them as a Set.
getCachedSampled() - Method in class org.frontcache.warmer.WarmerPreflight
getCacheLevel() - Method in class org.frontcache.core.WebResponse
getCacheState() - Method in class org.frontcache.client.FrontCacheClient
getCacheStateActionResponse() - Method in class org.frontcache.client.FrontCacheClient
getCacheStats() - Method in interface org.frontcache.cache.CacheProcessor: A cheap size-and-churn snapshot for the metrics exporter.
getCacheStats() - Method in class org.frontcache.cache.impl.InMemoryCacheProcessor: One tier, in memory, so only the L1 entry count is real.
getCacheStats() - Method in class org.frontcache.cache.impl.L1L2CacheProcessor: Read from the live Ehcache and the live IndexWriter - no reader opened, no directory rescanned beyond a file listing.
getCacheStatus() - Method in interface org.frontcache.cache.CacheProcessor
getCacheStatus() - Method in class org.frontcache.cache.CacheProcessorBase
getCacheStatus() - Method in class org.frontcache.cache.impl.InMemoryCacheProcessor
getCacheStatus() - Method in class org.frontcache.cache.impl.L1L2CacheProcessor
getCacheStatus() - Method in class org.frontcache.io.CacheStatusActionResponse
getCheckpoint() - Method in class org.frontcache.warmer.WarmerStatus
getClientIP() - Method in class org.frontcache.core.RequestContext: The client IP of this request, resolved once.
getClientIP(HttpServletRequest) - Static method in class org.frontcache.core.FCUtils
getClientType() - Method in class org.frontcache.bots.BotRule: bot or guest
getClientType() - Method in class org.frontcache.bots.BotRuleEntry
getClientType() - Method in class org.frontcache.core.RequestContext
getClientType() - Method in class org.frontcache.warmer.WarmerRunParams
getClientTypeRule() - Method in class org.frontcache.core.RequestContext: Name of the bots.conf rule that decided RequestContext.getClientType().
getCommandKey() - Method in class org.frontcache.resilience.FcCommand
getCommandKey() - Method in class org.frontcache.resilience.FcCommandConfig
getCommandKey() - Method in exception class org.frontcache.resilience.FcCommandException
getCommandKey() - Method in class org.frontcache.resilience.FcCommandMetrics
getConcurrency() - Method in class org.frontcache.warmer.WarmerRunParams
getCondition() - Method in class org.frontcache.bots.BotRule
getCondition() - Method in class org.frontcache.bots.BotRuleEntry
getCondition() - Method in class org.frontcache.guard.GuardRule
getCondition() - Method in class org.frontcache.guard.GuardRuleEntry
getConfigFile(ConfigFile) - Method in class org.frontcache.client.FrontCacheClient: The raw content of any of the five editable config files, by logical id.
getConfigInputStream(String) - Static method in class org.frontcache.FCConfig: 1.
getContent() - Method in class org.frontcache.core.WebResponse
getContent() - Method in class org.frontcache.warmer.WarmerListView
getContentLenth() - Method in class org.frontcache.core.WebResponse: content length in bytes
getContentString() - Method in interface org.frontcache.wrapper.FrontCacheHttpResponseWrapper
getContentString() - Method in class org.frontcache.wrapper.HttpResponseWrapperImpl
getCookieNames() - Method in class org.frontcache.core.RequestContext: Names of the cookies the client sent, parsed once per request and memoized.
getCounters() - Method in class org.frontcache.warmer.WarmerCheckpoint
getCounters() - Method in class org.frontcache.warmer.WarmerRunSummary
getCounters() - Method in class org.frontcache.warmer.WarmerStatus
getCpuProcessLoad() - Method in class org.frontcache.core.FcNodeStats: Recent CPU used by THIS JVM as a fraction of all available cores (0..1), or FcNodeStats.UNKNOWN_LOAD.
getCpuProcessLoad() - Method in class org.frontcache.io.NodeStatsActionResponse: 0..1 across all cores, or -1 when the JVM does not report it.
getCurrentConcurrentExecutionCount() - Method in class org.frontcache.resilience.FcCommandMetrics
getCurrentContent() - Method in class org.frontcache.io.SetConfigActionResponse
getCurrentEntry() - Method in class org.frontcache.warmer.WarmerStatus
getCurrentHash() - Method in class org.frontcache.io.WarmerListActionResponse
getCurrentHash() - Method in exception class org.frontcache.warmer.WarmerListStore.RefusedException: Set on a baseHash conflict: the hash of what is on disk now.
getCurrentLine() - Method in class org.frontcache.warmer.WarmerStatus
getCurrentRequestURL() - Method in class org.frontcache.core.RequestContext
getCurrentResult() - Method in class org.frontcache.replication.CacheReplicator: Returns the current result snapshot (safe to call while running).
getDefaultClientType() - Method in class org.frontcache.warmer.WarmerStatus
getDefaultDelayMs() - Method in class org.frontcache.warmer.WarmerConfig
getDefaultDelayMs() - Method in class org.frontcache.warmer.WarmerStatus
getDefaultKeyBase() - Method in class org.frontcache.warmer.WarmerStatus
getDelayMs() - Method in class org.frontcache.warmer.WarmerRunParams
getDirectory() - Method in class org.frontcache.warmer.WarmerListStore
getDisposition() - Method in class org.frontcache.guard.GuardAction
getDomain() - Method in class org.frontcache.core.RequestContext
getDomain() - Method in class org.frontcache.FrontCacheEngine: The site this node serves (front-cache.default-domain).
getDryRunMatches() - Method in class org.frontcache.guard.GuardOutcome
getDuplicates() - Method in class org.frontcache.warmer.WarmerPreflight
getDurationMillis() - Method in class org.frontcache.replication.ReplicationResult
getDynamicUrlPatterns() - Method in class org.frontcache.client.FrontCacheClient
getDynamicUrlPatterns() - Method in class org.frontcache.io.GetDynamicURLsActionResponse
getDynamicURLPatterns() - Static method in class org.frontcache.FCConfig: URL patterns that are never cached, from conf/dynamic-urls.conf.
getDynamicURLs() - Method in class org.frontcache.client.FrontCacheClient: Deprecated.
pre-2.7 shape: a single-entry map keyed by domain. Use FrontCacheClient.getDynamicUrlPatterns().
getDynamicURLs() - Static method in class org.frontcache.FCConfig
getDynamicURLs() - Method in class org.frontcache.io.GetDynamicURLsActionResponse: Deprecated.
pre-2.7 shape of GetDynamicURLsActionResponse.getDynamicUrlPatterns() - a single-entry map keyed by domain.
getDynamicURLsActionResponse() - Method in class org.frontcache.client.FrontCacheClient
GetDynamicURLsActionResponse - Class in org.frontcache.io: URL patterns that are never cached, from ./conf/dynamic-urls.conf.
GetDynamicURLsActionResponse() - Constructor for class org.frontcache.io.GetDynamicURLsActionResponse
getDynamicURLsConfig() - Method in class org.frontcache.client.FrontCacheClient
getDynamicURLsConfig() - Method in class org.frontcache.io.GetDynamicURLsConfigActionResponse
getDynamicURLsConfigActionResponse() - Method in class org.frontcache.client.FrontCacheClient: The raw conf/dynamic-urls.conf of this edge - what the console's Dynamic URLs screen renders.
GetDynamicURLsConfigActionResponse - Class in org.frontcache.io: The raw ./conf/dynamic-urls.conf of one node, for the console's Dynamic URLs screen.
GetDynamicURLsConfigActionResponse() - Constructor for class org.frontcache.io.GetDynamicURLsConfigActionResponse
getEditMaxBytes() - Method in class org.frontcache.io.WarmerListsActionResponse
getEditMaxBytes() - Method in class org.frontcache.warmer.WarmerConfig
getEditMaxBytes() - Method in class org.frontcache.warmer.WarmerStatus
getEndedAt() - Method in class org.frontcache.warmer.WarmerRunSummary
getEntries() - Method in class org.frontcache.warmer.WarmerListInfo
getEntries() - Method in class org.frontcache.warmer.WarmerListView
getEntries() - Method in class org.frontcache.warmer.WarmerPreflight
getEntry() - Method in class org.frontcache.warmer.WarmerError
getEnvelope() - Method in class org.frontcache.include.combine.CombineResponse
getError() - Method in class org.frontcache.warmer.WarmerRunSummary
getErrorDescription() - Method in class org.frontcache.io.ActionResponse
getErrorPercentage() - Method in class org.frontcache.resilience.FcCommandMetrics
getErrors() - Method in class org.frontcache.replication.ReplicationResult
getErrors() - Method in class org.frontcache.warmer.WarmerPreflight
getErrorThresholdPercentage() - Method in class org.frontcache.resilience.FcCommandConfig
getEtaSeconds() - Method in class org.frontcache.warmer.WarmerPreflight
getEtaSeconds() - Method in class org.frontcache.warmer.WarmerStatus
getExecutionDescription() - Method in class org.frontcache.resilience.FcCommand: What the watchdog names in its log line.
getExecutionEvents() - Method in class org.frontcache.resilience.FcCommand: The events of this execution, in the order they happened.
getExpireTimeMap() - Method in class org.frontcache.core.WebResponse
getExpireTimeMillis() - Method in class org.frontcache.core.WebResponse: Effective expiration timestamp (epoch millis) of this response across all client types.
getFailed() - Method in class org.frontcache.warmer.WarmerCounters
getFailedExecutionException() - Method in class org.frontcache.resilience.FcCommand: Null unless run() itself threw - see the class javadoc.
getFailedList() - Method in class org.frontcache.warmer.WarmerRunSummary
getFailedList() - Method in class org.frontcache.warmer.WarmerStatus
getFailureType() - Method in exception class org.frontcache.resilience.FcCommandException: The outcome that triggered the fallback attempt, e.g.
getFallback() - Method in class org.frontcache.resilience.FC_BypassCache
getFallback() - Method in class org.frontcache.resilience.FC_ThroughCache_HttpClient
getFallback() - Method in class org.frontcache.resilience.FC_ThroughCache_WebFilter
getFallback() - Method in class org.frontcache.resilience.FC_ThroughCache
getFallback() - Method in class org.frontcache.resilience.FC_Total
getFallback() - Method in class org.frontcache.resilience.FcCommand: Overridden by every Frontcache command.
getFallback(String, String) - Method in class org.frontcache.resilience.fr.DefaultFallbackResolver
getFallback(String, String) - Method in interface org.frontcache.resilience.fr.FallbackResolver
getFallback(String, String) - Method in class org.frontcache.resilience.fr.FileBasedFallbackResolver
GetFallbackConfigActionResponse - Class in org.frontcache.io: URL-pattern to fallback-file mappings from ./conf/fallbacks.conf.
GetFallbackConfigActionResponse() - Constructor for class org.frontcache.io.GetFallbackConfigActionResponse
getFallbackConfigs() - Method in class org.frontcache.client.FrontCacheClient: Deprecated.
pre-2.7 shape: a single-entry map keyed by domain. Use FrontCacheClient.getFallbackEntries().
getFallbackConfigs() - Method in class org.frontcache.io.GetFallbackConfigActionResponse: Deprecated.
pre-2.7 shape of GetFallbackConfigActionResponse.getFallbackEntries() - a single-entry map keyed by domain.
getFallbackConfigsActionResponse() - Method in class org.frontcache.client.FrontCacheClient
getFallbackEntries() - Method in class org.frontcache.client.FrontCacheClient
getFallbackEntries() - Method in class org.frontcache.io.GetFallbackConfigActionResponse
getFallbackEntries() - Method in class org.frontcache.resilience.fr.DefaultFallbackResolver: No configuration to show: this resolver serves one generic body for every URL.
getFallbackEntries() - Method in interface org.frontcache.resilience.fr.FallbackResolver
getFallbackEntries() - Method in class org.frontcache.resilience.fr.FileBasedFallbackResolver: A copy, not the live entries: these go out over the management API, and the returned objects are plain FallbackConfigEntry rather than the FallbackConfigEntryImpl used internally so the compiled Pattern does not have to serialize.
getFallbackReason() - Method in class org.frontcache.core.RequestContext
getFallbacksConfig() - Method in class org.frontcache.client.FrontCacheClient
getFallbacksConfig() - Method in class org.frontcache.io.GetFallbacksConfigActionResponse
getFallbacksConfigActionResponse() - Method in class org.frontcache.client.FrontCacheClient: The raw conf/fallbacks.conf of this edge - what the console's Fallback Config screen renders.
GetFallbacksConfigActionResponse - Class in org.frontcache.io: The raw ./conf/fallbacks.conf of one node, for the console's Fallback Config screen.
GetFallbacksConfigActionResponse() - Constructor for class org.frontcache.io.GetFallbacksConfigActionResponse
getFallbackSemaphoreMaxConcurrentRequests() - Method in class org.frontcache.resilience.FcCommandConfig: Parsed but NOT enforced - reported on the dashboard only, so an existing resilience.properties round-trips and the propertyValue_fallbackIsolationSemaphoreMaxConcurrentRequests field the dashboard asserts keeps carrying the operator's value.
getFallbackWebResponse() - Method in class org.frontcache.core.RequestContext
getFcHttpClient() - Method in class org.frontcache.FrontCacheEngine
getFile() - Method in enum class org.frontcache.guard.GuardPredicateFactory.Scope
getFile() - Method in class org.frontcache.io.SetConfigActionResponse
getFileName() - Method in enum class org.frontcache.io.ConfigFile: The name under FRONTCACHE_HOME/conf - never composed from caller input.
getFileName() - Method in class org.frontcache.resilience.fr.FallbackConfigEntry
getFilter() - Method in class org.frontcache.io.InvalidateActionResponse
getFilterChain() - Method in class org.frontcache.core.RequestContext
getFresh() - Method in class org.frontcache.warmer.WarmerCounters
getFromCache(String) - Method in class org.frontcache.client.FrontCacheClient
getFromCache(String, RequestContext) - Method in interface org.frontcache.cache.CacheProcessor
getFromCache(String, RequestContext) - Method in class org.frontcache.cache.CacheProcessorBase
getFromCacheActionResponse(String) - Method in class org.frontcache.client.FrontCacheClient
GetFromCacheActionResponse - Class in org.frontcache.io
GetFromCacheActionResponse() - Constructor for class org.frontcache.io.GetFromCacheActionResponse
GetFromCacheActionResponse(String) - Constructor for class org.frontcache.io.GetFromCacheActionResponse
GetFromCacheActionResponse(String, WebResponse) - Constructor for class org.frontcache.io.GetFromCacheActionResponse
getFromCacheImpl(String) - Method in class org.frontcache.cache.CacheProcessorBase
getFromCacheImpl(String) - Method in class org.frontcache.cache.impl.InMemoryCacheProcessor
getFromCacheImpl(String) - Method in class org.frontcache.cache.impl.L1L2CacheProcessor: Load web-response from file
getFromCacheImpl(String) - Method in class org.frontcache.cache.impl.NoopCacheProcessor
getFrontCache() - Static method in class org.frontcache.FrontCacheEngine
getFrontCacheHost() - Method in class org.frontcache.core.RequestContext
getFrontCacheHttpPort() - Method in class org.frontcache.core.RequestContext
getFrontCacheHttpsPort() - Method in class org.frontcache.core.RequestContext
getFrontCacheId() - Method in class org.frontcache.core.RequestContext
getFrontCacheProtocol() - Method in class org.frontcache.core.RequestContext
getFrontCacheURL() - Method in class org.frontcache.client.FrontCacheClient
getGroup() - Method in class org.frontcache.resilience.FcCommandMetrics
getGroupKey() - Method in class org.frontcache.resilience.FcCommand
getGuardConfig() - Method in class org.frontcache.client.FrontCacheClient
getGuardConfig() - Method in class org.frontcache.io.GetGuardConfigActionResponse
getGuardConfigActionResponse() - Method in class org.frontcache.client.FrontCacheClient
GetGuardConfigActionResponse - Class in org.frontcache.io
GetGuardConfigActionResponse() - Constructor for class org.frontcache.io.GetGuardConfigActionResponse
getGuardRetryAfterSeconds() - Method in class org.frontcache.core.RequestContext
getGuardRuleEngine() - Method in class org.frontcache.FrontCacheEngine
getGuardRules() - Method in class org.frontcache.client.FrontCacheClient
getGuardRules() - Method in class org.frontcache.io.GetGuardRulesActionResponse
getGuardRulesActionResponse() - Method in class org.frontcache.client.FrontCacheClient
GetGuardRulesActionResponse - Class in org.frontcache.io: Response for the get-guard-rules action: the guard rules this node is running, in evaluation order (built-ins first, then conf/guard-rules.conf), each with its hit count since start.
GetGuardRulesActionResponse() - Constructor for class org.frontcache.io.GetGuardRulesActionResponse
getHash() - Method in class org.frontcache.warmer.WarmerListView
getHead() - Method in class org.frontcache.warmer.WarmerListView
getHeader(String) - Method in class org.frontcache.core.WebResponse
getHeaders() - Method in class org.frontcache.core.WebResponse
getHeaders() - Method in class org.frontcache.include.combine.CombinePart
getHeapMaxBytes() - Method in class org.frontcache.core.FcNodeStats: The heap ceiling, or FcNodeStats.UNKNOWN.
getHeapMaxBytes() - Method in class org.frontcache.io.NodeStatsActionResponse
getHeapUsedBytes() - Method in class org.frontcache.core.FcNodeStats: Heap currently in use, or FcNodeStats.UNKNOWN.
getHeapUsedBytes() - Method in class org.frontcache.io.NodeStatsActionResponse
getHits() - Method in class org.frontcache.bots.BotRule
getHits() - Method in class org.frontcache.bots.BotRuleEntry
getHits() - Method in class org.frontcache.guard.GuardRule
getHits() - Method in class org.frontcache.guard.GuardRuleEntry
getHttpClient() - Method in class org.frontcache.FrontCacheEngine
getHttpClientResponse() - Method in class org.frontcache.core.RequestContext
getHttpHost(URL) - Static method in class org.frontcache.core.FCUtils
getHystrixConfig() - Method in class org.frontcache.client.FrontCacheClient: Deprecated.
pre-2.7 name of FrontCacheClient.getResilienceConfig()
getHystrixConfig() - Method in class org.frontcache.io.GetResilienceConfigActionResponse: Deprecated.
pre-2.7 spelling of GetResilienceConfigActionResponse.getResilienceConfig(). Still serialized so an older console keeps rendering this panel; read the current name in new code.
getHystrixConfigActionResponse() - Method in class org.frontcache.client.FrontCacheClient: Deprecated.
pre-2.7 name of FrontCacheClient.getResilienceConfigActionResponse()
getId() - Method in enum class org.frontcache.io.ConfigFile: The id a caller sends, and the one the console's screens are keyed by.
getIgnoredLines() - Method in class org.frontcache.warmer.WarmerPreflight
getIncludeClientType(String) - Method in class org.frontcache.include.IncludeProcessorBase
getIncludeCombineGroup(String) - Method in class org.frontcache.include.IncludeProcessorBase: The combine attribute's value, or null when the include is not marked combinable.
getIncludeFromCache(String, String, Map, FcHttpClient, RequestContext, String, String, long) - Method in class org.frontcache.include.IncludeProcessorBase: The cache half of IncludeProcessorBase.callInclude(String, String, Map, FcHttpClient, RequestContext, String, String): the entry to serve, or null when this include must go to the origin.
getIncludeLevel() - Method in class org.frontcache.core.RequestContext
getIncludeType(String) - Method in class org.frontcache.include.IncludeProcessorBase
getIncludeURL(String) - Method in class org.frontcache.include.IncludeProcessorBase
getIndexDiskBytes() - Method in class org.frontcache.cache.impl.LuceneIndexManager: On-disk size of the index, summed over the files Lucene currently lists.
getIndexSize() - Method in class org.frontcache.cache.impl.LuceneIndexManager: Document count as a reader sees it - the number the management API and the console report.
getIndexSizeFast() - Method in class org.frontcache.cache.impl.LuceneIndexManager: Document count, read from the live writer rather than through a searcher.
getInitUrl() - Method in class org.frontcache.resilience.fr.FallbackConfigEntry
getInstance() - Static method in class org.frontcache.bots.BotClassifier
getInstance() - Static method in class org.frontcache.cache.CacheManager
getInstance() - Static method in class org.frontcache.core.ClientIpResolver
getInstance() - Static method in class org.frontcache.include.IncludeProcessorManager
getInstance() - Static method in class org.frontcache.resilience.FcResilienceConfig
getInstance() - Static method in class org.frontcache.resilience.fr.FallbackResolverFactory: The resolver, creating it if this is the first call.
getInstance() - Static method in class org.frontcache.warmer.CacheWarmer: The node's warmer, created on first use.
getInstance(String, double, double) - Static method in class org.frontcache.cache.impl.LuceneIndexManager: Returns the one manager for indexPath, creating it on first use.
getInstance(String, String, int) - Static method in class org.frontcache.resilience.FcCommandMetrics
getInstance(String, LuceneIndexManager.Tuning) - Static method in class org.frontcache.cache.impl.LuceneIndexManager: Returns the one manager for indexPath, creating it with tuning on first use.
getInvalid() - Method in class org.frontcache.warmer.WarmerCounters
getInvalid() - Method in class org.frontcache.warmer.WarmerListView
getInvalid() - Method in class org.frontcache.warmer.WarmerPreflight
getInvalidLines() - Method in class org.frontcache.warmer.WarmerPreflight
getIsolation() - Method in class org.frontcache.resilience.FcCommandConfig
getKey() - Method in class org.frontcache.io.GetFromCacheActionResponse
getKey() - Method in class org.frontcache.io.PutToCacheActionResponse
getKey() - Method in class org.frontcache.warmer.WarmTransport.Outcome: x-frontcache-warm-key: the key the node built for this request, or null when the request never reached the cache (a dynamic URL, a node that predates the header).
getKeyBase() - Method in class org.frontcache.warmer.WarmerConfig
getKeyBase() - Method in class org.frontcache.warmer.WarmerRunParams
getKeyBaseWarning() - Method in class org.frontcache.warmer.WarmerPreflight
getKeys() - Method in class org.frontcache.cache.impl.LuceneIndexManager: Returns all URL keys stored in the index.
getKeys(int) - Method in class org.frontcache.cache.impl.LuceneIndexManager: At most limit keys - the same scan as LuceneIndexManager.getKeys(), stopped early.
getKeywords() - Method in class org.frontcache.bots.BotClassifier: Bare User-Agent keywords from the file, in file order.
getKind() - Method in enum class org.frontcache.include.combine.FcCombineMetrics.Error
getKind() - Method in class org.frontcache.warmer.WarmerEntry
getL1ContentBytes() - Method in class org.frontcache.cache.CacheStats: Bytes of response CONTENT held in the in-memory tier, or CacheStats.UNKNOWN.
getL1ContentBytes() - Method in class org.frontcache.io.NodeStatsActionResponse: Bytes of response CONTENT held in memory - not the tier's retained heap.
getL1Entries() - Method in class org.frontcache.cache.CacheStats: Entries in the in-memory tier, or CacheStats.UNKNOWN.
getL1Entries() - Method in class org.frontcache.io.NodeStatsActionResponse
getL1Evictions() - Method in class org.frontcache.cache.CacheStats: Entries evicted from the in-memory tier since JVM start, or CacheStats.UNKNOWN.
getL1Evictions() - Method in class org.frontcache.io.NodeStatsActionResponse
getL2DiskBytes() - Method in class org.frontcache.cache.CacheStats: Bytes the on-disk tier occupies, or CacheStats.UNKNOWN.
getL2DiskBytes() - Method in class org.frontcache.io.NodeStatsActionResponse
getL2Entries() - Method in class org.frontcache.cache.CacheStats: Documents in the on-disk tier, or CacheStats.UNKNOWN.
getL2Entries() - Method in class org.frontcache.io.NodeStatsActionResponse
getLastRun() - Method in class org.frontcache.warmer.WarmerStatus
getLatencyMean() - Method in class org.frontcache.resilience.FcCommandMetrics: Convenience for a caller that wants only the mean.
getLatencyPercentiles() - Method in class org.frontcache.resilience.FcCommandMetrics: The percentile map the dashboard expects, with its exact key set - it divides and plots these directly, so the shape matters as much as the numbers.
getLimit() - Method in class org.frontcache.guard.ratelimit.RateLimitSpec
getLimit() - Method in class org.frontcache.guard.ratelimit.WindowLimiter
getLimiters() - Static method in class org.frontcache.guard.ratelimit.GuardRateLimiterRegistry
getLine() - Method in class org.frontcache.warmer.WarmerError
getLine() - Method in class org.frontcache.warmer.WarmerLine
getLines() - Method in class org.frontcache.warmer.WarmerListView
getList() - Method in class org.frontcache.io.WarmerListActionResponse
getList() - Method in class org.frontcache.warmer.WarmerRunParams
getList(CacheWarmer, String, String) - Static method in class org.frontcache.io.WarmerActions
getListBetween(String, String, String, List) - Static method in class org.frontcache.core.StringUtils
getLists() - Method in class org.frontcache.io.WarmerListsActionResponse
getListSha256() - Method in class org.frontcache.warmer.WarmerCheckpoint
getLogToHTTPHeaders() - Method in class org.frontcache.core.RequestContext
getLoopbackTarget() - Method in class org.frontcache.warmer.WarmerPreflight
getLoopbackTarget() - Method in class org.frontcache.warmer.WarmerStatus
getLoopbackUrl() - Method in class org.frontcache.warmer.WarmerConfig
getMatches() - Method in class org.frontcache.warmer.WarmerListView
getMaxConcurrency() - Method in class org.frontcache.warmer.WarmerConfig
getMaxConcurrency() - Method in class org.frontcache.warmer.WarmerStatus
getMaxListBytes() - Method in class org.frontcache.io.WarmerListsActionResponse
getMaxListBytes() - Method in class org.frontcache.warmer.WarmerConfig
getMaxListBytes() - Method in class org.frontcache.warmer.WarmerStatus
getMaxListEntries() - Method in class org.frontcache.warmer.WarmerConfig
getMaxNumberConcurrentConnectionsAllowed() - Method in class org.frontcache.resilience.stream.FcDashboardStreamServlet: Same key, same file, no Archaius.
getMaxNumberConcurrentConnectionsAllowed() - Method in class org.frontcache.resilience.stream.FcSampleSseServlet
getMean() - Method in class org.frontcache.resilience.FcCommandMetrics.LatencySnapshot
getMode() - Method in class org.frontcache.warmer.WarmerRunParams
getModified() - Method in class org.frontcache.warmer.WarmerListInfo
getModified() - Method in class org.frontcache.warmer.WarmerListView
getName() - Method in class org.frontcache.bots.BotRule
getName() - Method in class org.frontcache.bots.BotRuleEntry
getName() - Method in class org.frontcache.client.FrontCacheClient: http://localhost:8080/ -> localhost:8080
getName() - Method in class org.frontcache.guard.GuardRule
getName() - Method in class org.frontcache.guard.GuardRuleEntry
getName() - Method in class org.frontcache.warmer.WarmerListInfo
getName() - Method in class org.frontcache.warmer.WarmerListView
getNextLine() - Method in class org.frontcache.warmer.WarmerCheckpoint
getNodes() - Method in class org.frontcache.client.FrontCacheCluster
getNodeStatsActionResponse() - Method in class org.frontcache.client.FrontCacheClient: The cheap, pollable view of a node - cache sizes per tier plus JVM heap, CPU and uptime.
getNotCacheable() - Method in class org.frontcache.warmer.WarmerCounters
getNumberCurrentConnections() - Method in class org.frontcache.resilience.stream.FcDashboardStreamServlet
getNumberCurrentConnections() - Method in class org.frontcache.resilience.stream.FcSampleSseServlet
getOriginContentLength() - Method in class org.frontcache.core.RequestContext: returns the content-length of the origin response
getOriginLatencyMs() - Method in class org.frontcache.warmer.WarmerPreflight
getOriginResponseHeaders() - Method in class org.frontcache.core.RequestContext: the Origin response headers
getOriginURL() - Method in class org.frontcache.core.RequestContext
getOutcome() - Method in class org.frontcache.warmer.WarmerRunSummary
getParams() - Method in class org.frontcache.warmer.WarmerCheckpoint
getParams() - Method in class org.frontcache.warmer.WarmerPreflight
getParams() - Method in class org.frontcache.warmer.WarmerRunSummary
getParams() - Method in class org.frontcache.warmer.WarmerStatus
getParts() - Method in class org.frontcache.include.combine.CombineEnvelope
getPathAndQuery() - Method in class org.frontcache.warmer.WarmerEntry: The path and query to request - always starts with /.
getPatternCount() - Method in class org.frontcache.io.ReloadDynamicUrlsActionResponse
getPauseReason() - Method in class org.frontcache.warmer.WarmerStatus
getPauseReasons() - Method in class org.frontcache.warmer.WarmerRunSummary
getPercentiles() - Method in class org.frontcache.resilience.FcCommandMetrics.LatencySnapshot: The percentile map the dashboard expects, with its exact key set and order.
getPredicates() - Method in class org.frontcache.bots.BotRule
getPredicates() - Method in class org.frontcache.guard.GuardRule
getPreflight() - Method in class org.frontcache.io.WarmerPreflightActionResponse
getProcessed() - Method in class org.frontcache.replication.ReplicationResult: Total entries processed so far (transferred + skipped + errors).
getProcessed() - Method in class org.frontcache.warmer.WarmerCounters
getProgressFraction() - Method in class org.frontcache.replication.ReplicationResult: Progress fraction in [0, 1], or -1 if total is unknown.
getProperties() - Static method in class org.frontcache.FCConfig
getProperty(String) - Static method in class org.frontcache.FCConfig
getProperty(String, String) - Static method in class org.frontcache.FCConfig
getPublicDomain() - Method in class org.frontcache.FrontCacheEngine
getPublicDomain() - Method in class org.frontcache.warmer.WarmerConfig
getPublicHost() - Method in class org.frontcache.core.RequestContext
getPublicProtocol() - Method in class org.frontcache.core.RequestContext
getQ() - Method in class org.frontcache.include.combine.CombinePart
getRateLimitKey() - Method in class org.frontcache.core.RequestContext
getRatePerSecond() - Method in class org.frontcache.warmer.WarmerStatus
getReason() - Method in class org.frontcache.warmer.WarmerEntry: Why the line is invalid.
getReason() - Method in class org.frontcache.warmer.WarmerError
getRebased() - Method in class org.frontcache.warmer.WarmerPreflight
getRecentErrors() - Method in class org.frontcache.warmer.WarmerStatus
getRefreshType() - Method in class org.frontcache.core.WebResponse
getRemaining() - Method in class org.frontcache.replication.ReplicationResult: Estimated entries remaining (-1 if totalSourceKeys is unknown).
getRequest() - Method in class org.frontcache.core.RequestContext
getRequestFromFrontcache() - Method in class org.frontcache.core.RequestContext
getRequestId() - Method in class org.frontcache.core.RequestContext
getRequestQueryParams() - Method in class org.frontcache.core.RequestContext
getRequestQueryString() - Method in class org.frontcache.core.RequestContext
getRequestTimeoutMs() - Method in class org.frontcache.warmer.WarmerConfig
getRequestType() - Method in class org.frontcache.core.RequestContext
getRequestURI() - Method in class org.frontcache.core.RequestContext
getRequestURL(HttpServletRequest) - Static method in class org.frontcache.core.FCUtils
getRequestVolumeThreshold() - Method in class org.frontcache.resilience.FcCommandConfig
getResilienceConfig() - Method in class org.frontcache.client.FrontCacheClient
getResilienceConfig() - Method in class org.frontcache.io.GetResilienceConfigActionResponse
getResilienceConfigActionResponse() - Method in class org.frontcache.client.FrontCacheClient: Asks for the raw resilience config, falling back to the pre-2.7 action name when the edge does not recognize the current one.
GetResilienceConfigActionResponse - Class in org.frontcache.io: Raw content of ./conf/resilience.properties (comments and empty lines preserved), for display in the console.
GetResilienceConfigActionResponse() - Constructor for class org.frontcache.io.GetResilienceConfigActionResponse
getResolvedClientIP() - Method in class org.frontcache.core.RequestContext: The trustworthy client address, resolved once per request.
getResolvedTarget() - Method in class org.frontcache.guard.GuardOutcome
getResponse() - Method in class org.frontcache.core.RequestContext
getResponse(String) - Method in class org.frontcache.cache.impl.LuceneIndexManager: Gets response from index
getResponseBody() - Method in class org.frontcache.core.RequestContext
getResponseDataStream() - Method in class org.frontcache.core.RequestContext
getResponseGZipped() - Method in class org.frontcache.core.RequestContext
getResponseStatus() - Method in class org.frontcache.io.ActionResponse
getResponseStatusCode() - Method in class org.frontcache.core.RequestContext: returns the response status code.
getResult() - Method in enum class org.frontcache.cache.FcCacheMetrics.Outcome: hit or miss - the label the hit ratio is computed from.
getResult() - Method in enum class org.frontcache.include.combine.FcCombineMetrics.Batch
getResult() - Method in enum class org.frontcache.include.combine.FcCombineMetrics.Member
getResult() - Method in class org.frontcache.warmer.WarmTransport.Outcome: x-frontcache-warm-result, or null when the response carried none.
getResumeFromLine() - Method in class org.frontcache.warmer.WarmerRunParams
getRollingCount(FcEventType) - Method in class org.frontcache.resilience.FcCommandMetrics
getRollingErrorCount() - Method in class org.frontcache.resilience.FcCommandMetrics
getRollingMaxConcurrentExecutionCount() - Method in class org.frontcache.resilience.FcCommandMetrics
getRollingStatsMs() - Method in class org.frontcache.resilience.FcCommandConfig
getRollingTotalRequests() - Method in class org.frontcache.resilience.FcCommandMetrics: Hystrix's HealthCounts total: successes plus the outcomes that mean the dependency call did not complete.
getRule() - Method in class org.frontcache.guard.GuardOutcome
getRules() - Method in class org.frontcache.bots.BotClassifier: The rules this node is running, in evaluation order, each carrying its hit count.
getRules() - Method in class org.frontcache.guard.GuardRuleEngine
getSampleKeys() - Method in class org.frontcache.warmer.WarmerPreflight
getSavedAt() - Method in class org.frontcache.warmer.WarmerCheckpoint
getScheme() - Method in class org.frontcache.warmer.KeyBase
getSemaphoreMaxConcurrentRequests() - Method in class org.frontcache.resilience.FcCommandConfig
getSkipped() - Method in class org.frontcache.replication.ReplicationResult
getSleepWindowMs() - Method in class org.frontcache.resilience.FcCommandConfig
getSlotCount() - Method in class org.frontcache.guard.ratelimit.WindowLimiter
getSource() - Method in class org.frontcache.guard.ratelimit.RateLimitSpec
getSourceUrl() - Method in class org.frontcache.replication.ReplicationResult
getSpec() - Method in class org.frontcache.guard.ratelimit.RateLimitPredicate
getStartedAt() - Method in class org.frontcache.warmer.WarmerCheckpoint
getStartedAt() - Method in class org.frontcache.warmer.WarmerRunSummary
getStartedAt() - Method in class org.frontcache.warmer.WarmerStatus
getState() - Method in class org.frontcache.warmer.WarmerStatus
getStatus() - Method in class org.frontcache.guard.GuardAction
getStatus() - Method in class org.frontcache.include.combine.CombinePart
getStatus() - Method in class org.frontcache.replication.ReplicationResult
getStatus() - Method in class org.frontcache.warmer.WarmTransport.Outcome
getStatusCode() - Method in class org.frontcache.core.WebResponse
getStore() - Method in class org.frontcache.warmer.CacheWarmer
getStored() - Method in class org.frontcache.warmer.WarmerCounters
getStringBetween(String, String, String) - Static method in class org.frontcache.core.StringUtils: return in inputStr substring between first and second
getTags() - Method in class org.frontcache.core.WebResponse
getTail() - Method in class org.frontcache.warmer.WarmerListView
getTakeovers() - Method in class org.frontcache.guard.ratelimit.WindowLimiter
getTarget() - Method in class org.frontcache.guard.GuardAction
getTargetUrl() - Method in class org.frontcache.replication.ReplicationResult
getText() - Method in class org.frontcache.warmer.WarmerLine
getThreadPoolKey() - Method in class org.frontcache.resilience.FcCommandConfig
getThrowable() - Method in class org.frontcache.core.RequestContext: returns a set throwable
getTier() - Method in enum class org.frontcache.cache.FcCacheMetrics.Outcome: L1, L2, or none for a miss.
getTimeoutMs() - Method in class org.frontcache.resilience.FcCommandConfig
getTotalCount(FcEventType) - Method in class org.frontcache.resilience.FcCommandMetrics: Monotonic count since JVM start - what the Prometheus exporter reads.
getTotalEntries() - Method in class org.frontcache.warmer.WarmerStatus
getTotalSourceKeys() - Method in class org.frontcache.replication.ReplicationResult
getTraceHeaders() - Method in class org.frontcache.core.RequestContext: Buffer for the X-frontcache-trace-* headers.
getTransferred() - Method in class org.frontcache.replication.ReplicationResult
getType() - Method in class org.frontcache.guard.GuardAction
getUptimeMillis() - Method in class org.frontcache.core.FcNodeStats: Milliseconds since JVM start, or FcNodeStats.UNKNOWN.
getUptimeMillis() - Method in class org.frontcache.io.NodeStatsActionResponse
getUrl() - Method in class org.frontcache.core.WebResponse
getUrlPattern() - Method in class org.frontcache.resilience.fr.FallbackConfigEntry
getUrlRegexpPattern() - Method in class org.frontcache.resilience.fr.FallbackConfigEntryImpl
getUserAgent() - Method in class org.frontcache.core.RequestContext: The User-Agent header, read once per request.
getUserAgent() - Method in class org.frontcache.warmer.WarmerConfig
getV() - Method in class org.frontcache.include.combine.CombineEnvelope
getValidationErrors() - Method in class org.frontcache.io.SetConfigActionResponse
getValue() - Method in class org.frontcache.io.GetFromCacheActionResponse
getWaitingReason() - Method in class org.frontcache.warmer.WarmerStatus
getWarmer() - Method in class org.frontcache.io.WarmerStatusActionResponse
getWarmerList(String, String) - Method in class org.frontcache.client.FrontCacheClient
getWarmerLists() - Method in class org.frontcache.client.FrontCacheClient
getWarmerStatus() - Method in class org.frontcache.client.FrontCacheClient
getWarmMode() - Method in class org.frontcache.core.RequestContext
getWarmResult() - Method in class org.frontcache.core.RequestContext
getWarnings() - Method in class org.frontcache.io.ReloadResilienceActionResponse
getWarnings() - Method in class org.frontcache.io.SetConfigActionResponse
getWarnings() - Method in class org.frontcache.warmer.WarmerPreflight
getWindowMillis() - Method in class org.frontcache.guard.ratelimit.RateLimitSpec
getWindowMillis() - Method in class org.frontcache.guard.ratelimit.WindowLimiter
getWritableConfigFile(String) - Static method in class org.frontcache.FCConfig: The file under FRONTCACHE_HOME/conf a management write should target, or null when this node has no conf directory on disk at all.
getWriter() - Method in class org.frontcache.wrapper.HttpResponseWrapperImpl
getWritten() - Method in class org.frontcache.io.WarmerListActionResponse
grep(String, String, int) - Method in class org.frontcache.warmer.WarmerListStore: Lines containing needle (case-insensitive), with their line numbers - a streamed scan, so a 50k-line list can be searched without being loaded.
groupKey(String, String) - Static method in class org.frontcache.include.combine.CombineProtocol: Batch identity: the endpoint plus the combine attribute's value.
GUARD - Enum constant in enum class org.frontcache.guard.GuardPredicateFactory.Scope
GUARD_RULES - Enum constant in enum class org.frontcache.io.ConfigFile
GUARD_RULES_CONFIG_FILE - Static variable in class org.frontcache.guard.GuardRuleEngine
GuardAction - Class in org.frontcache.guard: What a matching guard rule does with the request: reject it, redirect it, or explicitly let it through (an exemption placed above a broader rule).
GuardAction.Type - Enum Class in org.frontcache.guard
GuardConfigException - Exception Class in org.frontcache.guard: A guard rule could not be parsed or violates a safety rail (bad regex, unknown predicate, redirect target outside the allowed hosts, self-redirect loop).
GuardConfigException(String) - Constructor for exception class org.frontcache.guard.GuardConfigException
GuardConfigException(String, Throwable) - Constructor for exception class org.frontcache.guard.GuardConfigException
GuardOutcome - Class in org.frontcache.guard: Result of running the guard pipeline for one request: either "carry on to FC_Total" or a terminal action (reject / redirect) together with the rule that produced it.
GuardPredicate - Interface in org.frontcache.guard: One condition of a guard rule (e.g.
GuardPredicateFactory - Class in org.frontcache.guard: Parses a single predicate expression from guard-rules.conf into a GuardPredicate.
GuardPredicateFactory.Scope - Enum Class in org.frontcache.guard: Which config file a predicate is being parsed for.
GuardRateLimiterRegistry - Class in org.frontcache.guard.ratelimit: Holds the WindowLimiter of every rate-limit bucket, keyed by bucket name.
GuardRule - Class in org.frontcache.guard: A guard rule: name | condition | action.
GuardRule(String, List, GuardAction, boolean) - Constructor for class org.frontcache.guard.GuardRule
GuardRuleEngine - Class in org.frontcache.guard: Runs the guard rules for every request, before cache and origin.
GuardRuleEngine(int) - Constructor for class org.frontcache.guard.GuardRuleEngine
GuardRuleEntry - Class in org.frontcache.guard: Wire/DTO view of a GuardRule - what the management API (get-guard-rules) returns and the console renders.
GuardRuleEntry() - Constructor for class org.frontcache.guard.GuardRuleEntry
GuardRuleEntry(String, String, String, boolean, long) - Constructor for class org.frontcache.guard.GuardRuleEntry
GuardRuleParser - Class in org.frontcache.guard: Parses one line of guard-rules.conf into a GuardRule.
GuardRuleParser(Set) - Constructor for class org.frontcache.guard.GuardRuleParser

H

HARD_MAX_CONCURRENCY - Static variable in class org.frontcache.warmer.WarmerConfig: No configuration raises concurrency above this: 32 loopback workers is already a lot of origin.
hash(String) - Static method in class org.frontcache.io.ConfigFileStore: Lowercase hex SHA-256 of the normalized text - the baseHash the console sends.
hash(String) - Method in class org.frontcache.warmer.WarmerListStore: SHA-256 of the list's normalized content, streamed.
hash(String, String) - Static method in class org.frontcache.guard.ratelimit.WindowLimiter: 64-bit mix of bucket name and key.
hashCode() - Method in class org.frontcache.client.FrontCacheClient
hashCode() - Method in record class org.frontcache.resilience.FcResilienceReload.Result: Returns a hash code value for this object.
hashCode() - Method in class org.frontcache.warmer.KeyBase
hashOf(String) - Static method in class org.frontcache.warmer.WarmerListStore: SHA-256 (lowercase hex) of normalized text - the baseHash the console sends back.
hasIncludes(WebResponse, int) - Method in interface org.frontcache.include.IncludeProcessor
hasIncludes(WebResponse, int) - Method in class org.frontcache.include.IncludeProcessorBase: Does this response look like it contains an <fc:include .../> worth parsing?
hasMalformedQueryParams(String) - Static method in class org.frontcache.core.FCUtils: Detects a structurally-invalid request query string whose parameter names carry the HTML-entity artifact amp; (raw, or percent-encoded as amp%3B).
hasReservedParam(String) - Static method in class org.frontcache.include.combine.CombineProtocol: Does this query string carry a parameter whose name is inside the reserved fc- space? Such an include is not combinable: its parameter would arrive at the origin beside the ones this protocol puts there, and the origin has no way to tell them apart.
hasTrustedProxies() - Method in class org.frontcache.core.ClientIpResolver
HEADER_COMBINE - Static variable in class org.frontcache.include.combine.CombineProtocol: Response header.
HEADER_PROPERTY - Static variable in class org.frontcache.core.ClientIpResolver
HELP - Static variable in class org.frontcache.io.FrontcacheAction
HelpActionResponse - Class in org.frontcache.io
HelpActionResponse() - Constructor for class org.frontcache.io.HelpActionResponse
HelpActionResponse(Map) - Constructor for class org.frontcache.io.HelpActionResponse
HIT_L1 - Enum constant in enum class org.frontcache.cache.FcCacheMetrics.Outcome: Served from the in-memory tier (L1, or the whole cache for the in-memory processor).
HIT_L2 - Enum constant in enum class org.frontcache.cache.FcCacheMetrics.Outcome: Served from the on-disk tier (L2 - the Lucene index).
hostHeader() - Method in class org.frontcache.warmer.KeyBase: What the loopback request sends as Host: host[:port].
How an entry is warmed - Section in class org.frontcache.warmer.CacheWarmer
httpResponse2WebComponent(String, ClassicHttpResponse, RequestContext) - Static method in class org.frontcache.core.FCUtils
httpResponse2WebComponent(String, FrontCacheHttpResponseWrapper, RequestContext) - Static method in class org.frontcache.core.FCUtils: is used in ServletFilter mode
HttpResponseWrapperImpl - Class in org.frontcache.wrapper: Wrapper for response
HttpResponseWrapperImpl(HttpServletResponse) - Constructor for class org.frontcache.wrapper.HttpResponseWrapperImpl

I

IDLE - Enum constant in enum class org.frontcache.warmer.CacheWarmer.State
ids() - Static method in enum class org.frontcache.io.ConfigFile: The accepted ids, for an error message that tells the caller what it should have sent.
IGNORED - Enum constant in enum class org.frontcache.warmer.WarmerEntry.Kind
INCLUDE_FETCH_TARGET_DEFAULT - Static variable in class org.frontcache.include.IncludeProcessorBase: What a node with nothing configured does.
INCLUDE_FETCH_TARGET_EDGE - Static variable in class org.frontcache.include.IncludeProcessorBase: Pre-2.9 behaviour: fetch from this node's own public URL and let the loopback do the caching.
INCLUDE_FETCH_TARGET_ORIGIN - Static variable in class org.frontcache.include.IncludeProcessorBase: Fetch from front-cache.origin-host and cache the answer here.
INCLUDE_FETCH_TARGET_PROPERTY - Static variable in class org.frontcache.include.IncludeProcessorBase: front-cache.include-fetch-target - where a cache-missing include is fetched from.
INCLUDE_REQUEST - Static variable in class org.frontcache.resilience.FcCommandKeys: A Frontcache include arriving back through this node's own front door.
INCLUDE_TYPE_ASYNC - Static variable in class org.frontcache.include.IncludeProcessorBase
INCLUDE_TYPE_SYNC - Static variable in class org.frontcache.include.IncludeProcessorBase
includeCallType - Variable in class org.frontcache.tags.IncludeSupport
includeClientType - Variable in class org.frontcache.tags.IncludeSupport
includeCombine - Variable in class org.frontcache.tags.IncludeSupport
includeDynamicCallHttpClient(String, Map, FcHttpClient, RequestContext) - Static method in class org.frontcache.core.FCUtils: for includes ONLY - they allways use httpClient
includeFetchBaseURL(String, RequestContext) - Method in class org.frontcache.include.IncludeProcessorBase: The base URL includes are FETCHED from - the origin's when this node fetches includes directly, and otherwise the edge base it has always used.
IncludeProcessor - Interface in org.frontcache.include: Processing URL example invalid input: '<'fc:include url="/some/url/here" />
IncludeProcessorBase - Class in org.frontcache.include: Processing URL example invalid input: '<'fc:include url="/some/url/here" />
IncludeProcessorBase() - Constructor for class org.frontcache.include.IncludeProcessorBase
IncludeProcessorManager - Class in org.frontcache.include
IncludeSupport - Class in org.frontcache.tags
IncludeSupport() - Constructor for class org.frontcache.tags.IncludeSupport: Constructs a new handler.
IncludeTag - Class in org.frontcache.tags
IncludeTag() - Constructor for class org.frontcache.tags.IncludeTag
incrementAndGetCurrentConcurrentConnections() - Method in class org.frontcache.resilience.stream.FcDashboardStreamServlet
incrementAndGetCurrentConcurrentConnections() - Method in class org.frontcache.resilience.stream.FcSampleSseServlet
INDIVIDUAL - Enum constant in enum class org.frontcache.include.combine.FcCombineMetrics.Member: Resolved as an ordinary single include after all: the only member of its group, its group memoised as unsupported, its own query inside the reserved fc- space, or the batch came back from an origin with no combine handler.
info(String, long) - Method in class org.frontcache.warmer.WarmerListStore
init() - Method in class org.frontcache.resilience.stream.FcSampleSseServlet
init(FilterConfig) - Method in class org.frontcache.FrontCacheFilter
init(ServletConfig) - Method in class org.frontcache.FrontCacheServlet
init(ServletConfig) - Method in class org.frontcache.io.FrontCacheIOServlet
init(Properties) - Method in interface org.frontcache.cache.CacheProcessor
init(Properties) - Method in class org.frontcache.cache.CacheProcessorBase
init(Properties) - Method in class org.frontcache.cache.impl.InMemoryCacheProcessor
init(Properties) - Method in class org.frontcache.cache.impl.L1L2CacheProcessor
init(Properties) - Method in class org.frontcache.include.impl.ConcurrentIncludeProcessor
init(Properties) - Method in interface org.frontcache.include.IncludeProcessor
init(Properties) - Method in class org.frontcache.include.IncludeProcessorBase: Reads front-cache.include-fetch-target.
init(FcHttpClient) - Method in class org.frontcache.resilience.fr.DefaultFallbackResolver
init(FcHttpClient) - Method in interface org.frontcache.resilience.fr.FallbackResolver
init(FcHttpClient) - Static method in class org.frontcache.resilience.fr.FallbackResolverFactory: Creates the resolver if needed and runs its origin warm-up once.
init(FcHttpClient) - Method in class org.frontcache.resilience.fr.FileBasedFallbackResolver
initUrl - Variable in class org.frontcache.resilience.fr.FallbackConfigEntry
InMemoryCacheProcessor - Class in org.frontcache.cache.impl
InMemoryCacheProcessor() - Constructor for class org.frontcache.cache.impl.InMemoryCacheProcessor
INPUT_REQUEST - Static variable in class org.frontcache.resilience.FcCommandKeys: A request from a client - what an operator reads as "how much traffic is this node taking".
install(BotClassifier) - Static method in class org.frontcache.bots.BotClassifier: for tests - installs a classifier without going through FCConfig
install(ClientIpResolver) - Static method in class org.frontcache.core.ClientIpResolver: for tests - installs a resolver without going through FCConfig
INVALID - Enum constant in enum class org.frontcache.warmer.WarmerEntry.Kind
INVALIDATE - Static variable in class org.frontcache.io.FrontcacheAction
InvalidateActionResponse - Class in org.frontcache.io
InvalidateActionResponse(String) - Constructor for class org.frontcache.io.InvalidateActionResponse
invalidateAll() - Static method in class org.frontcache.resilience.FcResilienceRegistry: Forgets every breaker, bulkhead and time limiter, so the next command builds its own from the config that is current then.
isApplied() - Method in class org.frontcache.io.SetConfigActionResponse
isAuthorized(HttpServletRequest) - Static method in class org.frontcache.core.ApiKey
isAuthorizedApiKeyHeader(HttpServletRequest) - Static method in class org.frontcache.core.FCUtils: Reads the credential through ApiKey.presented(HttpServletRequest) - so the stream accepts Authorization: Bearer <api-key> like everything else, and the deprecated x-frontcache-site-key for as long as that is accepted anywhere.
isAuthorizedToWrite(HttpServletRequest) - Static method in class org.frontcache.core.ApiKey: The stricter rule, for management calls that WRITE.
isBaseOf(String) - Method in class org.frontcache.warmer.KeyBase: Is key a key under this base? Compared as a prefix - the path is not this class's business.
isBypassPassthroughEncoding() - Method in class org.frontcache.FrontCacheEngine
isCacheable() - Method in class org.frontcache.core.WebResponse: Check if response is cacheable
isCacheableRequest() - Method in class org.frontcache.core.RequestContext
isCacheableResponse() - Method in class org.frontcache.core.RequestContext: check if response has "Content-Type" header with "text" inside
isChunkedRequestBody() - Method in class org.frontcache.core.RequestContext
isCombined(HttpServletRequest) - Static method in class org.frontcache.include.combine.CombineRequest: Is this a combined request? Cheap enough to call at the top of a handler.
isConfigured() - Static method in class org.frontcache.core.ApiKey
isDeleted() - Method in class org.frontcache.io.WarmerListActionResponse
isDirectOriginFetch(RequestContext) - Method in class org.frontcache.include.IncludeProcessorBase: Does a cache-missing include go straight to front-cache.origin-host? When it does, this side of the call owns the three things the loopback used to do on its way back in - the cache write, the request-log line, and the dynamic-URL check before storing.
isDryRun() - Method in class org.frontcache.bots.BotRule
isDryRun() - Method in class org.frontcache.bots.BotRuleEntry
isDryRun() - Method in class org.frontcache.guard.GuardRule
isDryRun() - Method in class org.frontcache.guard.GuardRuleEntry
isDynamicURL(String) - Static method in class org.frontcache.include.IncludeProcessorBase: Would dynamic-urls.conf have stopped the loopback from caching this? Matched against the URI path, which is what FrontCacheEngine.ignoreCache matches - an include cached on this side must be cacheable exactly when the loopback would have cached it.
isEditable() - Method in class org.frontcache.warmer.WarmerListInfo
isEditable() - Method in class org.frontcache.warmer.WarmerListView
isEmpty(Object) - Static method in class org.frontcache.core.StringUtils
isEnabled() - Static method in class org.frontcache.guard.ratelimit.GuardRateLimiterRegistry
isEnabled() - Static method in class org.frontcache.metrics.FcMetricsExport
isEnabled() - Method in class org.frontcache.warmer.WarmerConfig
isEnabled() - Method in class org.frontcache.warmer.WarmerStatus
isEntry() - Method in class org.frontcache.warmer.WarmerEntry
isFailureOutcome() - Method in enum class org.frontcache.resilience.FcEventType: True for the outcomes that mean "the origin/cache call itself did not complete normally".
isFallbackUsed() - Method in class org.frontcache.core.RequestContext
isFilterMode() - Method in class org.frontcache.core.RequestContext: Check if run as ServletFilter
isForwardPublicHostToOrigin() - Method in class org.frontcache.FrontCacheEngine
isGuardProbe() - Method in class org.frontcache.core.RequestContext
isGzipped(String) - Static method in class org.frontcache.core.FCUtils: return true if the client requested gzip content
isGzipRequested() - Method in class org.frontcache.core.RequestContext
isIncludeResponseCacheable(WebResponse, RequestContext) - Method in class org.frontcache.include.IncludeProcessorBase: The four conditions an include response must meet before it is stored, shared by the single include path and the combine path so the two cannot drift on what "cacheable" means.
isInterruptOnTimeout() - Method in class org.frontcache.resilience.FcCommandConfig
isInvalid() - Method in class org.frontcache.warmer.WarmerEntry
isListWrite() - Method in class org.frontcache.io.WarmerListsActionResponse
isListWrite() - Method in class org.frontcache.warmer.WarmerConfig
isListWrite() - Method in class org.frontcache.warmer.WarmerStatus
isLoopbackOriginFetch(RequestContext) - Method in class org.frontcache.include.IncludeProcessorBase: Will this fetch come back through THIS Frontcache? Only in filter mode, and there always: the origin is the app this filter is installed in, so an HTTP call to front-cache.origin-host necessarily re-enters the filter.
isNodeApiKey(String) - Method in class org.frontcache.FrontCacheEngine
isRebased() - Method in class org.frontcache.warmer.WarmerEntry: True when this was an absolute URL whose base differs from the run's key base.
isResumable() - Method in class org.frontcache.warmer.WarmerCheckpoint
isRunning() - Method in class org.frontcache.replication.CacheReplicator: True if a replication run is currently in progress.
isRunning() - Method in class org.frontcache.warmer.CacheWarmer
isSecure() - Method in class org.frontcache.warmer.KeyBase
isTerminal() - Method in class org.frontcache.guard.GuardOutcome
isTerminal() - Method in class org.frontcache.replication.ReplicationResult: True when the replication is no longer running (completed, cancelled, or failed).
isText() - Method in class org.frontcache.core.WebResponse
isToplevelCached() - Method in class org.frontcache.core.RequestContext
isToplevelOnly() - Method in class org.frontcache.guard.ratelimit.RateLimitSpec
isTracked(double) - Method in class org.frontcache.core.FcNodeStats
isTracked(long) - Method in class org.frontcache.cache.CacheStats
isTracked(long) - Method in class org.frontcache.core.FcNodeStats
isTrustedPeer(HttpServletRequest) - Method in class org.frontcache.core.ClientIpResolver: Whether the socket peer of this request is a configured trusted proxy - i.e.
isUnsupported(String) - Method in class org.frontcache.include.combine.CombineUnsupportedMemo: Is combining known to be unsupported for this group right now?
isWarmRequest() - Method in class org.frontcache.core.RequestContext
isWebComponentCacheableForClientType(Map, String) - Static method in class org.frontcache.core.FCUtils
isWebComponentExpired(Map, String) - Static method in class org.frontcache.core.FCUtils: Check with current time if expired
isWebComponentSubjectToCache(Map) - Static method in class org.frontcache.core.FCUtils
isWritten() - Method in class org.frontcache.io.SetConfigActionResponse
Its own client, never the engine's - Section in class org.frontcache.warmer.LoopbackWarmTransport

J

JSON_FIELD - Static variable in class org.frontcache.cache.impl.LuceneIndexManager
JSON_TYPE - Static variable in class org.frontcache.cache.impl.LuceneIndexManager

K

keepAliveStrategy() - Static method in class org.frontcache.core.FCUtils: The keep-alive strategy shared by the engine's origin client and FrontCacheClient: honour the origin's own Keep-Alive: timeout=N, defaulting to 10s when it does not say.
KEY_BASE - Static variable in class org.frontcache.warmer.WarmerConfig
KeyBase - Class in org.frontcache.warmer: The scheme://host[:port] a warm run's cache keys are built on.
keyFor(String) - Method in class org.frontcache.warmer.KeyBase: The key an entry is stored under.
keywordRule(String) - Static method in class org.frontcache.bots.BotRuleParser: A bare line: the pre-2.9.0 format, one User-Agent substring per line, still supported and still how most of a bots.conf is written.

L

L1L2CacheProcessor - Class in org.frontcache.cache.impl: Cache processor based on L1 - ehCache.
L1L2CacheProcessor() - Constructor for class org.frontcache.cache.impl.L1L2CacheProcessor
latencySnapshot() - Method in class org.frontcache.resilience.FcCommandMetrics: One merge of the rolling ring.
LEGACY_COMMAND_KEYS - Static variable in class org.frontcache.resilience.FcCommandKeys: New key -> the pre-2.9.0 key whose settings it falls back on.
LEGACY_THREAD_POOL_KEYS - Static variable in class org.frontcache.resilience.FcCommandKeys: New thread-pool key -> the pre-2.9.0 key whose settings it falls back on.
level - Variable in class org.frontcache.tags.WebComponentSupport
limiter(RateLimitSpec) - Static method in class org.frontcache.guard.ratelimit.GuardRateLimiterRegistry: The limiter for one bucket, created on first use and reused across reloads when its limit and window are unchanged - which is what makes counts survive a reload.
list(long) - Method in class org.frontcache.warmer.WarmerListStore: Every list, newest first.
LIST_WRITE - Static variable in class org.frontcache.warmer.WarmerConfig
lists(CacheWarmer) - Static method in class org.frontcache.io.WarmerActions
loadedFrom() - Method in class org.frontcache.resilience.FcResilienceConfig: Which file these settings came from, so a caller can name the file the operator has to edit.
loadedFrom() - Method in record class org.frontcache.resilience.FcResilienceReload.Result: Returns the value of the loadedFrom record component.
logCombinedInclude(String, RequestContext, String, long, long) - Method in class org.frontcache.include.IncludeProcessorBase: Request-log and trace-header lines for one member of a combined batch.
logger - Variable in class org.frontcache.cache.CacheProcessorBase
logger - Variable in class org.frontcache.FrontCacheEngine
logger - Variable in class org.frontcache.FrontCacheServlet
logger - Variable in class org.frontcache.include.IncludeProcessorBase
logger - Variable in class org.frontcache.io.FrontCacheIOServlet
logger() - Static method in class org.frontcache.resilience.FallbackLogger: The logger the fallback resolvers write their TRACE lines to.
logGuardedRequest(String, String, int, String, RequestContext) - Static method in class org.frontcache.reqlog.RequestLogger: Logs a request a guard rule acted on before it touched cache or origin - rejected (e.g.
logRequest(String, boolean, boolean, long, long, RequestContext) - Static method in class org.frontcache.reqlog.RequestLogger
logRequestToHeader(String, String, boolean, boolean, long, long, RequestContext, String) - Static method in class org.frontcache.reqlog.RequestLogger
logTimeDateFormat - Static variable in class org.frontcache.resilience.FallbackLogger
LOOPBACK_URL - Static variable in class org.frontcache.warmer.WarmerConfig
loopbackTarget(WarmerConfig, int) - Static method in class org.frontcache.io.WarmerActions: Where warm requests go: front-cache.warmer.loopback-url if it is set, otherwise http://127.0.0.1:<the local port the management request arrived on> - the connector the management API was reached on, which in every shipped topology is the one traffic uses.
LoopbackWarmTransport - Class in org.frontcache.warmer: Sends a warm request to this node's own front door.
LoopbackWarmTransport(String, KeyBase, String, String, String, int, int) - Constructor for class org.frontcache.warmer.LoopbackWarmTransport
LuceneIndexManager - Class in org.frontcache.cache.impl: Provides access to lucene index.
LuceneIndexManager.Tuning - Class in org.frontcache.cache.impl: Everything about this index that an operator can tune, in one object so adding a knob does not add a positional constructor argument.

M

mark(String, long) - Method in class org.frontcache.include.combine.CombineUnsupportedMemo: Record that this group's origin did not understand a combined request.
markEnd(FcCommandMetrics.InFlight) - Method in class org.frontcache.resilience.FcCommandMetrics
markEvent(FcEventType) - Method in class org.frontcache.resilience.FcCommandMetrics
markStart(long, String) - Method in class org.frontcache.resilience.FcCommandMetrics: Registers an execution and returns its token, which must be handed back to FcCommandMetrics.markEnd(FcCommandMetrics.InFlight).
matches(RequestContext) - Method in class org.frontcache.bots.BotRule
matches(RequestContext) - Method in class org.frontcache.guard.GuardRule
MAX_CONCURRENCY - Static variable in class org.frontcache.warmer.WarmerConfig
MAX_INCLUDE_LENGHT - Static variable in interface org.frontcache.include.IncludeProcessor
MAX_LENGTH - Static variable in class org.frontcache.warmer.WarmerEntry: Longest line accepted, matching the engine's default front-cache.max-request-uri-length.
MAX_LIMIT - Static variable in class org.frontcache.guard.ratelimit.WindowLimiter: highest limit the packed count can still distinguish from saturation
MAX_LIST_BYTES - Static variable in class org.frontcache.warmer.WarmerConfig
MAX_LIST_ENTRIES - Static variable in class org.frontcache.warmer.WarmerConfig
MAX_RECURSION_LEVEL - Static variable in interface org.frontcache.include.IncludeProcessor
MAX_TOTAL_SLOTS_PROPERTY - Static variable in class org.frontcache.guard.ratelimit.GuardRateLimiterRegistry
maxage - Variable in class org.frontcache.tags.WebComponentSupport
maxAgeStr2Int(String) - Static method in class org.frontcache.core.FCUtils
mergeIncludeResponseHeaders(Map, Map) - Method in class org.frontcache.include.IncludeProcessorBase
Micrometer-free on purpose - Section in class org.frontcache.cache.CacheStats
Micrometer-free on purpose - Section in class org.frontcache.core.FcNodeStats
MISS - Enum constant in enum class org.frontcache.cache.FcCacheMetrics.Outcome: Not cached: the caller goes to the origin.
MODE_FILL - Static variable in class org.frontcache.warmer.WarmRequest
MODE_REFRESH - Static variable in class org.frontcache.warmer.WarmRequest
Monotonic, never rolling - Section in class org.frontcache.cache.FcCacheMetrics

N

NAME - Static variable in class org.frontcache.warmer.WarmerListStore: See the class comment.
nameProblem(String) - Static method in class org.frontcache.warmer.WarmerListStore
Names are caller-supplied, so they are constrained - Section in class org.frontcache.warmer.WarmerListStore
NO_CACHE - Static variable in interface org.frontcache.cache.CacheProcessor
NodeStatsActionResponse - Class in org.frontcache.io: The cheap, pollable view of a node: cache sizes and the JVM they live in.
NodeStatsActionResponse() - Constructor for class org.frontcache.io.NodeStatsActionResponse
NodeStatsActionResponse(CacheStats, FcNodeStats) - Constructor for class org.frontcache.io.NodeStatsActionResponse
NoopCacheProcessor - Class in org.frontcache.cache.impl
NoopCacheProcessor() - Constructor for class org.frontcache.cache.impl.NoopCacheProcessor
normalize(String) - Static method in class org.frontcache.io.ConfigFileStore: Makes submitted text safe to compare and to write.
normalize(String) - Static method in class org.frontcache.warmer.WarmerListStore: CRLF and a lone CR to LF, a leading BOM removed.
normalizeClientType(String) - Static method in class org.frontcache.warmer.WarmRequest
normalizeMode(String) - Static method in class org.frontcache.warmer.WarmRequest
NOT_TRACKED - Static variable in class org.frontcache.cache.CacheStats
NOT_TRACKED - Static variable in class org.frontcache.core.FcNodeStats
Nothing here throws - Section in class org.frontcache.core.FcNodeStats
Nothing here touches live state - Section in class org.frontcache.io.ConfigFileValidator
nowMillis() - Static method in class org.frontcache.guard.ratelimit.WindowLimiter

O

of(List) - Static method in class org.frontcache.bots.BotClassifier: for tests - builds a classifier over an explicit rule list
Off by default - Section in class org.frontcache.metrics.FcMetricsExport
OK - Enum constant in enum class org.frontcache.include.combine.FcCombineMetrics.Batch: A well-formed envelope came back and its parts were applied.
onComplete(ReplicationResult) - Method in interface org.frontcache.replication.ReplicationProgressListener: Called when replication completes (successfully, with errors, or cancelled).
onError(String, Exception) - Method in interface org.frontcache.replication.ReplicationProgressListener: Called when a single entry fails to transfer.
onProgress(long, long, long, long) - Method in interface org.frontcache.replication.ReplicationProgressListener: Called after each entry is processed (transferred, skipped, or failed).
openRaw(String) - Method in class org.frontcache.warmer.WarmerListStore: The raw bytes, for a download.
openReader(String) - Method in class org.frontcache.warmer.WarmerListStore: A UTF-8 reader over the list.
org.frontcache - package org.frontcache
org.frontcache.bots - package org.frontcache.bots
org.frontcache.cache - package org.frontcache.cache
org.frontcache.cache.impl - package org.frontcache.cache.impl
org.frontcache.client - package org.frontcache.client
org.frontcache.core - package org.frontcache.core
org.frontcache.guard - package org.frontcache.guard
org.frontcache.guard.ratelimit - package org.frontcache.guard.ratelimit
org.frontcache.include - package org.frontcache.include
org.frontcache.include.combine - package org.frontcache.include.combine
org.frontcache.include.impl - package org.frontcache.include.impl
org.frontcache.io - package org.frontcache.io
org.frontcache.metrics - package org.frontcache.metrics
org.frontcache.replication - package org.frontcache.replication
org.frontcache.reqlog - package org.frontcache.reqlog
org.frontcache.resilience - package org.frontcache.resilience
org.frontcache.resilience.fr - package org.frontcache.resilience.fr
org.frontcache.resilience.stream - package org.frontcache.resilience.stream
org.frontcache.tags - package org.frontcache.tags
org.frontcache.warmer - package org.frontcache.warmer
org.frontcache.wrapper - package org.frontcache.wrapper
ORIGIN_POOL - Static variable in class org.frontcache.resilience.FcCommandKeys: The thread pool every THREAD-isolated origin call runs on - FcCommandKeys.CACHE_MISS and FcCommandKeys.CACHE_BYPASS both.
out(PageContext, Object, Object, Object) - Static method in class org.frontcache.tags.IncludeSupport: Kept so anything calling the pre-combine signature still compiles and behaves identically - no combine attribute is the same as no combining.
out(PageContext, Object, Object, Object, Object) - Static method in class org.frontcache.tags.IncludeSupport
Outcome(int, String) - Constructor for class org.frontcache.warmer.WarmTransport.Outcome
Outcome(int, String, String) - Constructor for class org.frontcache.warmer.WarmTransport.Outcome

P

param(Map, String) - Static method in class org.frontcache.include.combine.CombineRequest: First value of a parameter within one parsed member, or null.
PARAM_COMBINE - Static variable in class org.frontcache.include.combine.CombineProtocol: Presence makes a request a combined request; the value is CombineProtocol.VERSION.
PARAM_PART - Static variable in class org.frontcache.include.combine.CombineProtocol: Prefix of the per-member parameter: fc-part-0, fc-part-1, ...
PARAM_PARTS - Static variable in class org.frontcache.include.combine.CombineProtocol: Number of members.
PARAM_PREFIX - Static variable in class org.frontcache.include.combine.CombineProtocol: Reserved query-parameter prefix.
parse(String) - Static method in class org.frontcache.bots.BotRuleParser
parse(String) - Static method in class org.frontcache.core.Cidr
parse(String) - Static method in class org.frontcache.guard.GuardPredicateFactory
parse(String) - Method in class org.frontcache.guard.GuardRuleParser
parse(String) - Static method in class org.frontcache.warmer.KeyBase
parse(String, String) - Static method in class org.frontcache.guard.ratelimit.RateLimitSpec
parse(String, GuardPredicateFactory.Scope) - Static method in class org.frontcache.guard.GuardPredicateFactory
parse(String, KeyBase) - Static method in class org.frontcache.warmer.WarmerEntry
PARSE - Enum constant in enum class org.frontcache.include.combine.FcCombineMetrics.Error: The body would not parse as an envelope.
parseAddress(String) - Static method in class org.frontcache.core.Cidr: Parses an address literal only - never a host name, so this can never trigger a DNS lookup on the request thread from attacker-controlled input.
parseOrNull(String) - Static method in class org.frontcache.warmer.KeyBase: Same as KeyBase.parse(String), or null instead of an exception.
parseParameters(HttpServletRequest) - Static method in class org.frontcache.include.combine.CombineRequest: The members' parameters, parsed, in order.
parseQueries(HttpServletRequest) - Static method in class org.frontcache.include.combine.CombineRequest: The members' query strings, decoded, in order.
parseQueryString(String) - Static method in class org.frontcache.include.combine.CombineRequest: Splits one member's query string into parameters.
patch() - Method in interface org.frontcache.cache.CacheProcessor
patch() - Method in class org.frontcache.cache.impl.InMemoryCacheProcessor
patch() - Method in class org.frontcache.cache.impl.L1L2CacheProcessor
patch() - Method in class org.frontcache.cache.impl.NoopCacheProcessor
PATCH - Static variable in class org.frontcache.io.FrontcacheAction
PatchActionResponse - Class in org.frontcache.io
PatchActionResponse() - Constructor for class org.frontcache.io.PatchActionResponse
pathOf(String) - Static method in class org.frontcache.include.combine.CombineProtocol: The URI path of an absolute include URL - http://host:8080/a/b.htm?x=1 to /a/b.htm.
pause() - Method in class org.frontcache.warmer.CacheWarmer
pause(CacheWarmer, boolean) - Static method in class org.frontcache.io.WarmerActions
PAUSED - Enum constant in enum class org.frontcache.warmer.CacheWarmer.State
perform(String, String, String, boolean, boolean) - Static method in class org.frontcache.io.ConfigWriteAction: Writes one config file and applies it.
PING - Static variable in class org.frontcache.io.FrontcacheAction
PingActionResponse - Class in org.frontcache.io
PingActionResponse() - Constructor for class org.frontcache.io.PingActionResponse
pool(String) - Static method in class org.frontcache.resilience.FcThreadPools
poolCoreSize(String) - Method in class org.frontcache.resilience.FcResilienceConfig
poolKeepAliveMinutes(String) - Method in class org.frontcache.resilience.FcResilienceConfig
poolMaximumSize(String) - Method in class org.frontcache.resilience.FcResilienceConfig
poolMaxQueueSize(String) - Method in class org.frontcache.resilience.FcResilienceConfig: Hystrix default is -1, meaning "no queue" - a SynchronousQueue, not an unbounded one.
PR 3 removed RxJava - Section in class org.frontcache.resilience.stream.FcSampleSseServlet
PRAGMA - Static variable in class org.frontcache.core.FCHeaders
preflight(CacheWarmer, WarmerRunParams, boolean, int, CacheProcessor) - Static method in class org.frontcache.io.WarmerActions
preflight(WarmerRunParams, String, String, CacheProcessor) - Method in class org.frontcache.warmer.CacheWarmer: What a run with these parameters would do - see WarmerPreflight.
presented(HttpServletRequest) - Static method in class org.frontcache.core.ApiKey: The credential the caller presented, or null.
processIncludes(WebResponse, String, Map, FcHttpClient, RequestContext, int) - Method in class org.frontcache.include.impl.ConcurrentIncludeProcessor
processIncludes(WebResponse, String, Map, FcHttpClient, RequestContext, int) - Method in interface org.frontcache.include.IncludeProcessor
processRequest(HttpServletRequest, HttpServletResponse, FilterChain) - Method in class org.frontcache.FrontCacheEngine
processRequest(String, Map, FcHttpClient, RequestContext) - Method in interface org.frontcache.cache.CacheProcessor
processRequest(String, Map, FcHttpClient, RequestContext) - Method in class org.frontcache.cache.CacheProcessorBase
processRequestInternal(RequestContext) - Method in class org.frontcache.FrontCacheEngine
propagatedClientType(RequestContext) - Static method in class org.frontcache.core.FCUtils: The client type decided for the PAGE this request is a fragment of, when it can be believed.
purge() - Method in interface org.frontcache.cache.CacheProcessor
purge() - Method in class org.frontcache.cache.impl.InMemoryCacheProcessor: Removes entries whose effective expiration timestamp is in the past.
purge() - Method in class org.frontcache.cache.impl.L1L2CacheProcessor: Removes expired entries from both cache tiers: L1 (ehCache) is scanned in-memory; L2 (Lucene) is purged via a range query.
purge() - Method in class org.frontcache.cache.impl.NoopCacheProcessor
purge() - Method in class org.frontcache.client.FrontCacheClient: Triggers purge of expired entries on the edge.
PURGE - Static variable in class org.frontcache.io.FrontcacheAction
PurgeActionResponse - Class in org.frontcache.io
PurgeActionResponse() - Constructor for class org.frontcache.io.PurgeActionResponse
PUT_TO_CACHE - Static variable in class org.frontcache.io.FrontcacheAction
PUT_WARMER_LIST - Static variable in class org.frontcache.io.FrontcacheAction: Creates or replaces one list.
putList(CacheWarmer, String, InputStream, String, boolean) - Static method in class org.frontcache.io.WarmerActions
putToCache(String, WebResponse) - Method in interface org.frontcache.cache.CacheProcessor
putToCache(String, WebResponse) - Method in class org.frontcache.cache.CacheProcessorBase: Single entry point for writing to the cache.
putToCache(String, WebResponse) - Method in class org.frontcache.client.FrontCacheClient: Pushes a WebResponse entry into the remote node's cache.
PutToCacheActionResponse - Class in org.frontcache.io: Response for the put-to-cache IO action.
PutToCacheActionResponse() - Constructor for class org.frontcache.io.PutToCacheActionResponse: No-arg constructor for Jackson deserialization.
PutToCacheActionResponse(String) - Constructor for class org.frontcache.io.PutToCacheActionResponse
putToCacheImpl(String, WebResponse) - Method in class org.frontcache.cache.CacheProcessorBase: Stores the entry.
putToCacheImpl(String, WebResponse) - Method in class org.frontcache.cache.impl.InMemoryCacheProcessor
putToCacheImpl(String, WebResponse) - Method in class org.frontcache.cache.impl.L1L2CacheProcessor: Saves web response to cache-file
putToCacheImpl(String, WebResponse) - Method in class org.frontcache.cache.impl.NoopCacheProcessor
putWarmerList(String, InputStream, long, String) - Method in class org.frontcache.client.FrontCacheClient: Creates or replaces a list.

Q

queryOf(String) - Static method in class org.frontcache.include.combine.CombineProtocol: Everything after the ?, or "" when there is none.
queryOf(Map) - Static method in class org.frontcache.include.combine.CombineRequest: Re-renders a parsed member back into a query string, for the optional q echo (CombinePart.getQ()).

R

2.7 removed the parked thread - Section in class org.frontcache.resilience.stream.FcSampleSseServlet
RateLimitPredicate - Class in org.frontcache.guard.ratelimit: The rate: predicate - true when this request's client IP has already used up its budget for the current window.
RateLimitPredicate(RateLimitSpec) - Constructor for class org.frontcache.guard.ratelimit.RateLimitPredicate
RateLimitSpec - Class in org.frontcache.guard.ratelimit: The parsed form of a rate: predicate, computed once at load time.
rawListProblem(CacheWarmer, String) - Static method in class org.frontcache.io.WarmerActions
read(String, long, int) - Method in class org.frontcache.warmer.WarmerListStore: What get-warmer-list shows: the whole normalized content and its hash when the list is small enough to edit, otherwise the first and last previewLines lines.
readOnDisk(File) - Static method in class org.frontcache.io.ConfigFileStore: The file's current content, or "" when it does not exist yet.
Read per request - Section in class org.frontcache.core.ApiKey
reapplyGeometry(FcResilienceConfig) - Static method in class org.frontcache.resilience.FcThreadPools: Re-applies pool geometry to the live pools from a freshly read config, in place.
rebaseURL(String, String) - Static method in class org.frontcache.core.FCUtils: The same path and query, addressed at a different scheme://host[:port].
record(FcCacheMetrics.Outcome) - Static method in class org.frontcache.cache.FcCacheMetrics: Records one cache read.
record(FcCombineMetrics.Batch) - Static method in class org.frontcache.include.combine.FcCombineMetrics: Records one combined origin call.
record(FcCombineMetrics.Error) - Static method in class org.frontcache.include.combine.FcCombineMetrics: Records one rejected envelope.
record(FcCombineMetrics.Member) - Static method in class org.frontcache.include.combine.FcCombineMetrics: Records one combine candidate's resolution.
record(FcCombineMetrics.Member, int) - Static method in class org.frontcache.include.combine.FcCombineMetrics: Records count candidates resolved the same way - the batch paths resolve in bulk.
recordHitOrMiss(Object, FcCacheMetrics.Outcome) - Static method in class org.frontcache.cache.FcCacheMetrics: Convenience for the common two-branch case: a resolved response, or null for a miss.
recordLatency(long) - Method in class org.frontcache.resilience.FcCommandMetrics
redirect(int, String) - Static method in class org.frontcache.guard.GuardAction
REDIRECT - Enum constant in enum class org.frontcache.guard.GuardAction.Type
refresh - Variable in class org.frontcache.tags.WebComponentSupport
refresh() - Static method in class org.frontcache.metrics.FcMetricsExport: Picks up commands and pools that started serving after the exporter did.
refuse(String) - Method in class org.frontcache.io.SetConfigActionResponse: Marks this response a refusal: ERROR status, nothing written.
refuse(String) - Method in class org.frontcache.io.WarmerListActionResponse: Marks this response a refusal: ERROR status, with the reason.
refuse(String) - Method in class org.frontcache.io.WarmerListsActionResponse: Marks this response a refusal: ERROR status, with the reason.
refuse(String) - Method in class org.frontcache.io.WarmerPreflightActionResponse: Marks this response a refusal: ERROR status, with the reason.
refuse(String) - Method in class org.frontcache.io.WarmerStatusActionResponse: Marks this response a refusal: ERROR status, with the reason.
reject(int, String) - Static method in class org.frontcache.guard.GuardAction
REJECT - Enum constant in enum class org.frontcache.guard.GuardAction.Type
rejectionCount(String) - Static method in class org.frontcache.resilience.FcThreadPools
release() - Method in class org.frontcache.tags.IncludeSupport
release() - Method in class org.frontcache.tags.WebComponentSupport
releaseHttpClientResponse() - Method in class org.frontcache.core.RequestContext: Releases the origin response opened by FC_BypassCache, closing it once BOTH parties are done.
reload() - Static method in class org.frontcache.bots.BotClassifier: Re-reads conf/bots.conf.
reload() - Static method in class org.frontcache.core.ClientIpResolver: Re-reads the configuration.
reload() - Static method in class org.frontcache.FrontCacheEngine
reload() - Method in class org.frontcache.guard.GuardRuleEngine: Re-reads guard-rules.conf.
reload() - Static method in class org.frontcache.resilience.FcResilienceReload
RELOAD_BOTS - Static variable in class org.frontcache.io.FrontcacheAction
RELOAD_DYNAMIC_URLS - Static variable in class org.frontcache.io.FrontcacheAction: Re-reads ./conf/dynamic-urls.conf.
RELOAD_FALLBACKS - Static variable in class org.frontcache.io.FrontcacheAction
RELOAD_GUARD_RULES - Static variable in class org.frontcache.io.FrontcacheAction
RELOAD_RESILIENCE - Static variable in class org.frontcache.io.FrontcacheAction: Re-reads ./conf/resilience.properties and applies what can be applied without a restart.
ReloadActionResponse - Class in org.frontcache.io
ReloadActionResponse() - Constructor for class org.frontcache.io.ReloadActionResponse
ReloadBotsActionResponse - Class in org.frontcache.io
ReloadBotsActionResponse() - Constructor for class org.frontcache.io.ReloadBotsActionResponse
reloadDynamicURLs() - Method in class org.frontcache.client.FrontCacheClient: Reloads the edge's conf/dynamic-urls.conf.
reloadDynamicURLs() - Static method in class org.frontcache.FCConfig: Re-reads conf/dynamic-urls.conf.
ReloadDynamicUrlsActionResponse - Class in org.frontcache.io: The outcome of reload-dynamic-urls: how many patterns are now active.
ReloadDynamicUrlsActionResponse() - Constructor for class org.frontcache.io.ReloadDynamicUrlsActionResponse
ReloadFallbacksActionResponse - Class in org.frontcache.io
ReloadFallbacksActionResponse() - Constructor for class org.frontcache.io.ReloadFallbacksActionResponse
ReloadGuardRulesActionResponse - Class in org.frontcache.io
ReloadGuardRulesActionResponse() - Constructor for class org.frontcache.io.ReloadGuardRulesActionResponse
reloadResilience() - Method in class org.frontcache.client.FrontCacheClient: Reloads the edge's conf/resilience.properties.
ReloadResilienceActionResponse - Class in org.frontcache.io: The outcome of reload-resilience.
ReloadResilienceActionResponse() - Constructor for class org.frontcache.io.ReloadResilienceActionResponse
removeFromCache(String) - Method in interface org.frontcache.cache.CacheProcessor
removeFromCache(String) - Method in class org.frontcache.cache.impl.InMemoryCacheProcessor
removeFromCache(String) - Method in class org.frontcache.cache.impl.L1L2CacheProcessor
removeFromCache(String) - Method in class org.frontcache.cache.impl.NoopCacheProcessor
removeFromCache(String) - Method in class org.frontcache.client.FrontCacheClient
removeFromCache(String) - Method in class org.frontcache.client.FrontCacheCluster
removeFromCacheAll() - Method in interface org.frontcache.cache.CacheProcessor: Removes every entry from this node.
removeFromCacheAll() - Method in class org.frontcache.cache.impl.InMemoryCacheProcessor
removeFromCacheAll() - Method in class org.frontcache.cache.impl.L1L2CacheProcessor
removeFromCacheAll() - Method in class org.frontcache.cache.impl.NoopCacheProcessor
removeFromCacheAll() - Method in class org.frontcache.client.FrontCacheClient
removeFromCacheAll() - Method in class org.frontcache.client.FrontCacheCluster
ReplicationProgressListener - Interface in org.frontcache.replication: Callback interface for receiving progress updates during cache replication.
ReplicationResult - Class in org.frontcache.replication: Immutable snapshot of a replication run.
ReplicationResult() - Constructor for class org.frontcache.replication.ReplicationResult
ReplicationResult(String, String) - Constructor for class org.frontcache.replication.ReplicationResult
Request - Section in class org.frontcache.include.combine.CombineProtocol
REQUEST_CLIENT_TYPE_BOT - Static variable in class org.frontcache.core.FCHeaders
REQUEST_CLIENT_TYPE_GUEST - Static variable in class org.frontcache.core.FCHeaders
REQUEST_TIMEOUT_MS - Static variable in class org.frontcache.warmer.WarmerConfig
RequestContext - Class in org.frontcache.core: The Request Context holds request, response, state information and data to access and share.
RequestContext() - Constructor for class org.frontcache.core.RequestContext
RequestLogger - Class in org.frontcache.reqlog: Log requests to file (slf4j) for statistics and further analysis REQUEST LOGGING FORMAT 1 - true 0 - false cacheable_flag - true/1 if request is run through FrontCache engine (e.g.
requestURL(RequestContext) - Static method in class org.frontcache.guard.GuardAction: Full request URL, as the client would have to type it to get back here.
requireLoopback(String) - Static method in class org.frontcache.warmer.LoopbackWarmTransport: The loopback target must be this machine.
reset() - Static method in class org.frontcache.cache.FcCacheMetrics: Test seam - back to zero.
reset() - Static method in class org.frontcache.guard.ratelimit.GuardRateLimiterRegistry: for tests
reset() - Static method in class org.frontcache.include.combine.FcCombineMetrics: Test seam - back to zero.
RESILIENCE - Enum constant in enum class org.frontcache.io.ConfigFile
resolve(HttpServletRequest) - Method in class org.frontcache.core.ClientIpResolver
resolve(HttpServletRequest, RequestContext) - Static method in class org.frontcache.warmer.WarmRequest: Marks context as a warm request when request carries a valid token from a loopback peer, and sets the run's client type on it.
resolve(String) - Method in class org.frontcache.warmer.WarmerListStore
resolveTarget(RequestContext) - Method in class org.frontcache.guard.GuardAction: Expands ${uri} / ${query} / ${url} / ${url:enc} / ${host} in the redirect target.
RESPONSE_FROM_CACHE - Enum constant in enum class org.frontcache.resilience.FcEventType: Never emitted - Frontcache does not use Hystrix request caching.
RESPONSE_STATUS_ERROR - Static variable in class org.frontcache.io.ActionResponse
RESPONSE_STATUS_OK - Static variable in class org.frontcache.io.ActionResponse
Result(String, List) - Constructor for record class org.frontcache.resilience.FcResilienceReload.Result: Creates an instance of a Result record class.
RESULT_FAILED - Static variable in class org.frontcache.warmer.CacheWarmer
RESULT_FALLBACK - Static variable in class org.frontcache.warmer.WarmRequest
RESULT_FRESH - Static variable in class org.frontcache.warmer.CacheWarmer
RESULT_FRESH - Static variable in class org.frontcache.warmer.WarmRequest
RESULT_INVALID - Static variable in class org.frontcache.warmer.CacheWarmer
RESULT_NOT_CACHEABLE - Static variable in class org.frontcache.warmer.CacheWarmer
RESULT_NOT_CACHEABLE - Static variable in class org.frontcache.warmer.WarmRequest
RESULT_STORED - Static variable in class org.frontcache.warmer.CacheWarmer
RESULT_STORED - Static variable in class org.frontcache.warmer.WarmRequest
RESULTS - Static variable in class org.frontcache.warmer.CacheWarmer: The label values of frontcache_warmer_entries_total, in a stable order.
resume() - Method in class org.frontcache.warmer.CacheWarmer
resume(CacheWarmer, boolean) - Static method in class org.frontcache.io.WarmerActions
retain(Set) - Static method in class org.frontcache.guard.ratelimit.GuardRateLimiterRegistry: Drops the limiters of buckets no longer named by any loaded rule.
RETRY_AFTER - Static variable in class org.frontcache.core.FCHeaders
revertHeaders(HttpServletResponse) - Static method in class org.frontcache.core.FCUtils
revertHeaders(Header[]) - Static method in class org.frontcache.core.FCUtils: revert header from HttpClient format (call to origin) to Map
RULE_BAD_REQUEST - Static variable in class org.frontcache.guard.GuardRuleEngine
RULE_DEFAULT - Static variable in class org.frontcache.bots.BotClassifier: built-in, evaluated last: always matches, so classify() always has an answer
RULE_NO_USER_AGENT - Static variable in class org.frontcache.bots.BotClassifier: built-in, evaluated first: no User-Agent header at all
RULE_URI_TOO_LONG - Static variable in class org.frontcache.guard.GuardRuleEngine
RULES_ENABLED_PROPERTY - Static variable in class org.frontcache.bots.BotClassifier
run() - Method in class org.frontcache.resilience.FC_BypassCache
run() - Method in class org.frontcache.resilience.FC_ThroughCache_HttpClient
run() - Method in class org.frontcache.resilience.FC_ThroughCache_WebFilter
run() - Method in class org.frontcache.resilience.FC_ThroughCache
run() - Method in class org.frontcache.resilience.FC_Total
run() - Method in class org.frontcache.resilience.FcCommand
run(ReplicationProgressListener) - Method in class org.frontcache.replication.CacheReplicator: Runs the replication.
RUNNING - Enum constant in enum class org.frontcache.warmer.CacheWarmer.State

S

scrape() - Static method in class org.frontcache.metrics.FcMetricsExport
SEMAPHORE - Enum constant in enum class org.frontcache.resilience.FcCommandConfig.Isolation
SEMAPHORE_REJECTED - Enum constant in enum class org.frontcache.resilience.FcEventType
service(ServletRequest, ServletResponse) - Method in class org.frontcache.FrontCacheServlet
set(String) - Method in class org.frontcache.core.RequestContext: sets a key value to Boolen.TRUE
set(String, Object) - Method in class org.frontcache.core.RequestContext: puts the key, value into the map.
SET_CONFIG - Static variable in class org.frontcache.io.FrontcacheAction: Writes one config file and (unless apply=false) applies it - the console's Configs screens save through this.
setAction(String) - Method in class org.frontcache.guard.GuardRuleEntry
setAction(String) - Method in class org.frontcache.io.ActionResponse
setAlreadyInProgress() - Method in class org.frontcache.io.BackupActionResponse: Marks this response as "rejected because a backup is already running" - no new backup was started.
setAlreadyInProgress() - Method in class org.frontcache.io.DumpKeysActionResponse: Marks this response as "rejected because a dump is already running" - no new dump was started.
setApplied(boolean) - Method in class org.frontcache.io.SetConfigActionResponse
setAt(long) - Method in class org.frontcache.warmer.WarmerError
setBackupDir(String) - Method in class org.frontcache.io.BackupActionResponse
setBackupFile(String) - Method in class org.frontcache.io.SetConfigActionResponse
setBody(String) - Method in class org.frontcache.include.combine.CombinePart
setBotKeywords(Set) - Method in class org.frontcache.io.GetBotsActionResponse
setBotRules(List) - Method in class org.frontcache.io.GetBotsActionResponse
setBots(Map) - Method in class org.frontcache.io.GetBotsActionResponse: Deprecated.
pre-2.7 shape of GetBotsActionResponse.setBotKeywords(Set)
setBotsConfig(String) - Method in class org.frontcache.io.GetBotsConfigActionResponse
setBytes(long) - Method in class org.frontcache.warmer.WarmerListInfo
setBytes(long) - Method in class org.frontcache.warmer.WarmerListView
setBytes(long) - Method in class org.frontcache.warmer.WarmerPreflight
setCachedEntries(long) - Method in class org.frontcache.io.NodeStatsActionResponse
setCachedFresh(long) - Method in class org.frontcache.warmer.WarmerPreflight
setCachedSampled(long) - Method in class org.frontcache.warmer.WarmerPreflight
setCacheLevel(String) - Method in class org.frontcache.core.WebResponse
setCacheStatus(Map) - Method in class org.frontcache.io.CacheStatusActionResponse
setCall(Object) - Method in class org.frontcache.tags.IncludeTag
setCheckpoint(WarmerCheckpoint) - Method in class org.frontcache.warmer.WarmerStatus
setChunkedRequestBody() - Method in class org.frontcache.core.RequestContext: sets chunkedRequestBody to true
setClient(Object) - Method in class org.frontcache.tags.IncludeTag
setClientIP(String) - Method in class org.frontcache.core.RequestContext
setClientType(String) - Method in class org.frontcache.bots.BotRuleEntry
setClientType(String) - Method in class org.frontcache.core.RequestContext
setClientType(String) - Method in class org.frontcache.warmer.WarmerRunParams
setClientTypeRule(String) - Method in class org.frontcache.core.RequestContext
setCombine(Object) - Method in class org.frontcache.tags.IncludeTag: combine="true", or a group name.
setConcurrency(int) - Method in class org.frontcache.warmer.WarmerRunParams
setCondition(String) - Method in class org.frontcache.bots.BotRuleEntry
setCondition(String) - Method in class org.frontcache.guard.GuardRuleEntry
setConfig(ConfigFile, String, String, boolean) - Method in class org.frontcache.client.FrontCacheClient: Writes one config file on the edge and applies it.
SetConfigActionResponse - Class in org.frontcache.io: What set-config did, or refused to do.
SetConfigActionResponse() - Constructor for class org.frontcache.io.SetConfigActionResponse
setContent(byte[]) - Method in class org.frontcache.core.WebResponse
setContent(String) - Method in class org.frontcache.warmer.WarmerListView
setCounters(WarmerCounters) - Method in class org.frontcache.warmer.WarmerCheckpoint
setCounters(WarmerCounters) - Method in class org.frontcache.warmer.WarmerRunSummary
setCounters(WarmerCounters) - Method in class org.frontcache.warmer.WarmerStatus
setCpuProcessLoad(double) - Method in class org.frontcache.io.NodeStatsActionResponse
setCurrentContent(String) - Method in class org.frontcache.io.SetConfigActionResponse
setCurrentEntry(String) - Method in class org.frontcache.warmer.WarmerStatus
setCurrentHash(String) - Method in class org.frontcache.io.WarmerListActionResponse
setCurrentLine(long) - Method in class org.frontcache.warmer.WarmerStatus
setCurrentRequestURL(String) - Method in class org.frontcache.core.RequestContext
setDefaultClientType(String) - Method in class org.frontcache.warmer.WarmerStatus
setDefaultDelayMs(long) - Method in class org.frontcache.warmer.WarmerStatus
setDefaultKeyBase(String) - Method in class org.frontcache.warmer.WarmerStatus
setDelayMs(long) - Method in class org.frontcache.warmer.WarmerRunParams
setDeleted(boolean) - Method in class org.frontcache.io.WarmerListActionResponse
setDomain(String) - Method in class org.frontcache.core.RequestContext: The site this node serves (front-cache.default-domain), stamped on the context by the engine.
setDryRun(boolean) - Method in class org.frontcache.bots.BotRuleEntry
setDryRun(boolean) - Method in class org.frontcache.guard.GuardRuleEntry
setDuplicates(long) - Method in class org.frontcache.warmer.WarmerPreflight
setDurationMillis(long) - Method in class org.frontcache.replication.ReplicationResult
setDynamicUrlPatterns(Set) - Method in class org.frontcache.io.GetDynamicURLsActionResponse
setDynamicURLs(Map) - Method in class org.frontcache.io.GetDynamicURLsActionResponse: Deprecated.
pre-2.7 shape of GetDynamicURLsActionResponse.setDynamicUrlPatterns(Set)
setDynamicURLsConfig(String) - Method in class org.frontcache.io.GetDynamicURLsConfigActionResponse
setEditable(boolean) - Method in class org.frontcache.warmer.WarmerListInfo
setEditable(boolean) - Method in class org.frontcache.warmer.WarmerListView
setEditMaxBytes(long) - Method in class org.frontcache.io.WarmerListsActionResponse
setEditMaxBytes(long) - Method in class org.frontcache.warmer.WarmerStatus
setEnabled(boolean) - Method in class org.frontcache.warmer.WarmerStatus
setEndedAt(long) - Method in class org.frontcache.warmer.WarmerRunSummary
setEntries(long) - Method in class org.frontcache.warmer.WarmerListInfo
setEntries(long) - Method in class org.frontcache.warmer.WarmerListView
setEntries(long) - Method in class org.frontcache.warmer.WarmerPreflight
setEntry(String) - Method in class org.frontcache.warmer.WarmerError
setError(String) - Method in class org.frontcache.warmer.WarmerRunSummary
setErrorDescription(String) - Method in class org.frontcache.io.ActionResponse
setErrors(long) - Method in class org.frontcache.replication.ReplicationResult
setErrors(List) - Method in class org.frontcache.warmer.WarmerPreflight
setEtaSeconds(long) - Method in class org.frontcache.warmer.WarmerPreflight
setEtaSeconds(long) - Method in class org.frontcache.warmer.WarmerStatus
setExpireTimeMap(Map) - Method in class org.frontcache.core.WebResponse
setFailed(long) - Method in class org.frontcache.warmer.WarmerCounters
setFailedList(String) - Method in class org.frontcache.warmer.WarmerRunSummary
setFailedList(String) - Method in class org.frontcache.warmer.WarmerStatus
setFallbackConfigs(Map) - Method in class org.frontcache.io.GetFallbackConfigActionResponse: Deprecated.
pre-2.7 shape of GetFallbackConfigActionResponse.setFallbackEntries(Set)
setFallbackEntries(Set) - Method in class org.frontcache.io.GetFallbackConfigActionResponse
setFallbacksConfig(String) - Method in class org.frontcache.io.GetFallbacksConfigActionResponse
setFallbackUsed() - Method in class org.frontcache.core.RequestContext
setFallbackUsed(String) - Method in class org.frontcache.core.RequestContext
setFallbackWebResponse(WebResponse) - Method in class org.frontcache.core.RequestContext: The fallback to serve instead of the origin response, parked here by FC_BypassCache.getFallback().
setFile(String) - Method in class org.frontcache.io.SetConfigActionResponse
setFileName(String) - Method in class org.frontcache.resilience.fr.FallbackConfigEntry
setFilter(String) - Method in class org.frontcache.io.InvalidateActionResponse
setFilterChain(FilterChain) - Method in class org.frontcache.core.RequestContext
setFresh(long) - Method in class org.frontcache.warmer.WarmerCounters
setFrontCacheHost(String) - Method in class org.frontcache.core.RequestContext: sets frontCacheHost
setFrontCacheHttpPort(String) - Method in class org.frontcache.core.RequestContext
setFrontCacheHttpsPort(String) - Method in class org.frontcache.core.RequestContext
setFrontCacheId(String) - Method in class org.frontcache.core.RequestContext
setFrontCacheProtocol(String) - Method in class org.frontcache.core.RequestContext
setGuardConfig(String) - Method in class org.frontcache.io.GetGuardConfigActionResponse
setGuardProbe() - Method in class org.frontcache.core.RequestContext: Marks a synthetic context built for a load-time guard self-check (redirect-loop detection, the exemption warnings) rather than for a real request.
setGuardRetryAfterSeconds(int) - Method in class org.frontcache.core.RequestContext: Seconds until a rate-limited client's window rolls over, stashed by the rate predicate and emitted as Retry-After by the guard response.
setGuardRules(List) - Method in class org.frontcache.io.GetGuardRulesActionResponse
setHash(String) - Method in class org.frontcache.warmer.WarmerListView
setHead(List) - Method in class org.frontcache.warmer.WarmerListView
setHeaders(Map) - Method in class org.frontcache.core.WebResponse
setHeaders(Map) - Method in class org.frontcache.include.combine.CombinePart
setHeapMaxBytes(long) - Method in class org.frontcache.io.NodeStatsActionResponse
setHeapUsedBytes(long) - Method in class org.frontcache.io.NodeStatsActionResponse
setHits(long) - Method in class org.frontcache.bots.BotRuleEntry
setHits(long) - Method in class org.frontcache.guard.GuardRuleEntry
setHttpClientResponse(ClassicHttpResponse) - Method in class org.frontcache.core.RequestContext
setHystrixConfig(String) - Method in class org.frontcache.io.GetResilienceConfigActionResponse: Deprecated.
pre-2.7 spelling of GetResilienceConfigActionResponse.setResilienceConfig(String)
setIgnoredLines(long) - Method in class org.frontcache.warmer.WarmerPreflight
setIncludeLevel(String) - Method in class org.frontcache.core.RequestContext
setInitUrl(String) - Method in class org.frontcache.resilience.fr.FallbackConfigEntry
setInvalid(long) - Method in class org.frontcache.warmer.WarmerCounters
setInvalid(long) - Method in class org.frontcache.warmer.WarmerListView
setInvalid(long) - Method in class org.frontcache.warmer.WarmerPreflight
setInvalidLines(List) - Method in class org.frontcache.warmer.WarmerPreflight
setKey(String) - Method in class org.frontcache.io.GetFromCacheActionResponse
setKey(String) - Method in class org.frontcache.io.PutToCacheActionResponse
setKeyBase(String) - Method in class org.frontcache.warmer.WarmerRunParams
setKeyBaseWarning(String) - Method in class org.frontcache.warmer.WarmerPreflight
setL1ContentBytes(long) - Method in class org.frontcache.io.NodeStatsActionResponse
setL1Entries(long) - Method in class org.frontcache.io.NodeStatsActionResponse
setL1Evictions(long) - Method in class org.frontcache.io.NodeStatsActionResponse
setL2DiskBytes(long) - Method in class org.frontcache.io.NodeStatsActionResponse
setL2Entries(long) - Method in class org.frontcache.io.NodeStatsActionResponse
setLastRun(WarmerRunSummary) - Method in class org.frontcache.warmer.WarmerStatus
setLevel(String) - Method in class org.frontcache.tags.WebComponentTag
setLine(long) - Method in class org.frontcache.warmer.WarmerError
setLine(long) - Method in class org.frontcache.warmer.WarmerLine
setLines(long) - Method in class org.frontcache.warmer.WarmerListView
setList(String) - Method in class org.frontcache.warmer.WarmerRunParams
setList(WarmerListView) - Method in class org.frontcache.io.WarmerListActionResponse
setLists(List) - Method in class org.frontcache.io.WarmerListsActionResponse
setListSha256(String) - Method in class org.frontcache.warmer.WarmerCheckpoint
setListWrite(boolean) - Method in class org.frontcache.io.WarmerListsActionResponse
setListWrite(boolean) - Method in class org.frontcache.warmer.WarmerStatus
setLogToHTTPHeaders() - Method in class org.frontcache.core.RequestContext
setLoopbackTarget(String) - Method in class org.frontcache.warmer.WarmerPreflight
setLoopbackTarget(String) - Method in class org.frontcache.warmer.WarmerStatus
setMatches(List) - Method in class org.frontcache.warmer.WarmerListView
setMaxage(String) - Method in class org.frontcache.tags.WebComponentTag
setMaxConcurrency(int) - Method in class org.frontcache.warmer.WarmerStatus
setMaxListBytes(long) - Method in class org.frontcache.io.WarmerListsActionResponse
setMaxListBytes(long) - Method in class org.frontcache.warmer.WarmerStatus
setMode(String) - Method in class org.frontcache.warmer.WarmerRunParams
setModified(long) - Method in class org.frontcache.warmer.WarmerListInfo
setModified(long) - Method in class org.frontcache.warmer.WarmerListView
setName(String) - Method in class org.frontcache.bots.BotRuleEntry
setName(String) - Method in class org.frontcache.guard.GuardRuleEntry
setName(String) - Method in class org.frontcache.warmer.WarmerListInfo
setName(String) - Method in class org.frontcache.warmer.WarmerListView
setNextLine(long) - Method in class org.frontcache.warmer.WarmerCheckpoint
setNotCacheable(long) - Method in class org.frontcache.warmer.WarmerCounters
setOriginContentLength(Long) - Method in class org.frontcache.core.RequestContext: sets the content-length from the origin response
setOriginContentLength(String) - Method in class org.frontcache.core.RequestContext: sets the content-length from the origin response
setOriginLatencyMs(long) - Method in class org.frontcache.warmer.WarmerPreflight
setOriginURL(URL) - Method in class org.frontcache.core.RequestContext
setOutcome(String) - Method in class org.frontcache.warmer.WarmerRunSummary
setOutputFile(String) - Method in class org.frontcache.io.DumpKeysActionResponse
setParams(WarmerRunParams) - Method in class org.frontcache.warmer.WarmerCheckpoint
setParams(WarmerRunParams) - Method in class org.frontcache.warmer.WarmerPreflight
setParams(WarmerRunParams) - Method in class org.frontcache.warmer.WarmerRunSummary
setParams(WarmerRunParams) - Method in class org.frontcache.warmer.WarmerStatus
setParts(List) - Method in class org.frontcache.include.combine.CombineEnvelope
setPatternCount(int) - Method in class org.frontcache.io.ReloadDynamicUrlsActionResponse
setPauseReason(String) - Method in class org.frontcache.warmer.WarmerStatus
setPauseReasons(List) - Method in class org.frontcache.warmer.WarmerRunSummary
setPreflight(WarmerPreflight) - Method in class org.frontcache.io.WarmerPreflightActionResponse
setProcessed(long) - Method in class org.frontcache.warmer.WarmerCounters
setProperty(String, String) - Static method in class org.frontcache.FCConfig
setPublicHost(String) - Method in class org.frontcache.core.RequestContext: The site's public hostname (front-cache.default-domain), or null when the node has none configured.
setPublicProtocol(String) - Method in class org.frontcache.core.RequestContext: The scheme the client actually used, recovered from X-Forwarded-Proto (trusted peers only) or front-cache.public-scheme.
setQ(String) - Method in class org.frontcache.include.combine.CombinePart
setRatePerSecond(double) - Method in class org.frontcache.warmer.WarmerStatus
setReason(String) - Method in class org.frontcache.warmer.WarmerError
setRebased(long) - Method in class org.frontcache.warmer.WarmerPreflight
setRecentErrors(List) - Method in class org.frontcache.warmer.WarmerStatus
setRefresh(String) - Method in class org.frontcache.tags.WebComponentTag
setRefreshType(String) - Method in class org.frontcache.core.WebResponse
setRequest(HttpServletRequest) - Method in class org.frontcache.core.RequestContext: sets the HttpServletRequest into the "request" key
setRequestFromFrontcache() - Method in class org.frontcache.core.RequestContext
setRequestId(String) - Method in class org.frontcache.core.RequestContext
setRequestQueryParams(Map) - Method in class org.frontcache.core.RequestContext: sets the request query params list
setRequestQueryString(String) - Method in class org.frontcache.core.RequestContext
setRequestType(String) - Method in class org.frontcache.core.RequestContext
setRequestURI(String) - Method in class org.frontcache.core.RequestContext
setResilienceConfig(String) - Method in class org.frontcache.io.GetResilienceConfigActionResponse
setResponse(HttpServletResponse) - Method in class org.frontcache.core.RequestContext: sets the "response" key to the HttpServletResponse passed in
setResponseBody(String) - Method in class org.frontcache.core.RequestContext: sets the "responseBody" value as a String.
setResponseDataStream(InputStream) - Method in class org.frontcache.core.RequestContext: sets the InputStream of the response into the responseDataStream
setResponseGZipped(boolean) - Method in class org.frontcache.core.RequestContext: sets the flag responseGZipped if the response is gzipped
setResponseStatus(String) - Method in class org.frontcache.io.ActionResponse
setResponseStatusCode(int) - Method in class org.frontcache.core.RequestContext: Use this instead of response.setStatusCode()
setResumable(boolean) - Method in class org.frontcache.warmer.WarmerCheckpoint
setResumeFromLine(long) - Method in class org.frontcache.warmer.WarmerRunParams
setSampleKeys(List) - Method in class org.frontcache.warmer.WarmerPreflight
setSavedAt(long) - Method in class org.frontcache.warmer.WarmerCheckpoint
setSkipped(long) - Method in class org.frontcache.replication.ReplicationResult
setSourceUrl(String) - Method in class org.frontcache.replication.ReplicationResult
setStartedAt(long) - Method in class org.frontcache.warmer.WarmerCheckpoint
setStartedAt(long) - Method in class org.frontcache.warmer.WarmerRunSummary
setStartedAt(long) - Method in class org.frontcache.warmer.WarmerStatus
setState(String) - Method in class org.frontcache.warmer.WarmerStatus
setStatus(int) - Method in class org.frontcache.include.combine.CombinePart
setStatus(String) - Method in class org.frontcache.replication.ReplicationResult
setStatusCode(int) - Method in class org.frontcache.core.WebResponse
setStored(long) - Method in class org.frontcache.warmer.WarmerCounters
setTags(String) - Method in class org.frontcache.tags.WebComponentTag
setTags(Set) - Method in class org.frontcache.core.WebResponse
setTail(List) - Method in class org.frontcache.warmer.WarmerListView
setTargetUrl(String) - Method in class org.frontcache.replication.ReplicationResult
setText(String) - Method in class org.frontcache.warmer.WarmerLine
setThrowable(Throwable) - Method in class org.frontcache.core.RequestContext: sets a throwable
setToplevelCached() - Method in class org.frontcache.core.RequestContext
setTotalEntries(long) - Method in class org.frontcache.warmer.WarmerStatus
setTotalSourceKeys(long) - Method in class org.frontcache.replication.ReplicationResult
setTransferred(long) - Method in class org.frontcache.replication.ReplicationResult
setUptimeMillis(long) - Method in class org.frontcache.io.NodeStatsActionResponse
setUrl(Object) - Method in class org.frontcache.tags.IncludeTag
setUrl(String) - Method in class org.frontcache.core.WebResponse
setUrlPattern(String) - Method in class org.frontcache.resilience.fr.FallbackConfigEntry
setUrlRegexpPattern(Pattern) - Method in class org.frontcache.resilience.fr.FallbackConfigEntryImpl
setV(int) - Method in class org.frontcache.include.combine.CombineEnvelope
setValidationErrors(List) - Method in class org.frontcache.io.SetConfigActionResponse
setValue(WebResponse) - Method in class org.frontcache.io.GetFromCacheActionResponse
setWaitingReason(String) - Method in class org.frontcache.warmer.WarmerStatus
setWarmer(WarmerStatus) - Method in class org.frontcache.io.WarmerStatusActionResponse
setWarmRequest(String) - Method in class org.frontcache.core.RequestContext: Marks this request as the cache warmer's - set by the engine only after the warm token checked out (see org.frontcache.warmer.WarmRequest).
setWarmResult(String) - Method in class org.frontcache.core.RequestContext: What the cache processor did with a warm request - reported to the warmer as x-frontcache-warm-result.
setWarnings(List) - Method in class org.frontcache.io.ReloadResilienceActionResponse
setWarnings(List) - Method in class org.frontcache.io.SetConfigActionResponse
setWarnings(List) - Method in class org.frontcache.warmer.WarmerPreflight
setWorkerCount(int) - Method in class org.frontcache.replication.CacheReplicator: Overrides how many entries are transferred concurrently.
setWritten(boolean) - Method in class org.frontcache.io.SetConfigActionResponse
setWritten(WarmerListInfo) - Method in class org.frontcache.io.WarmerListActionResponse
SHORT_CIRCUITED - Enum constant in enum class org.frontcache.resilience.FcEventType
shutdown() - Static method in class org.frontcache.resilience.stream.FcSampleSseServlet: WebSphere won't shutdown a servlet until after a 60 second timeout if there is an instance of the servlet executing a request.
size() - Method in class org.frontcache.include.combine.CombineResponse
size() - Method in class org.frontcache.include.combine.CombineUnsupportedMemo
SLOTS_PROPERTY - Static variable in class org.frontcache.guard.ratelimit.GuardRateLimiterRegistry
softInvalidationExecutor - Variable in class org.frontcache.cache.CacheProcessorBase
splitFields(String) - Static method in class org.frontcache.guard.GuardRuleParser: Splits a rule line into its name | condition | action [| flag] fields.
splitQueryParameters(String) - Static method in class org.frontcache.core.FCUtils
start() - Static method in class org.frontcache.metrics.FcMetricsExport: Starts the exporter if configured.
start(CacheWarmer, WarmerRunParams, boolean, int, boolean) - Static method in class org.frontcache.io.WarmerActions
start(WarmerRunParams, String) - Method in class org.frontcache.warmer.CacheWarmer: Starts a run.
START_MARKER - Static variable in class org.frontcache.include.IncludeProcessorBase
status() - Method in class org.frontcache.warmer.CacheWarmer
status(CacheWarmer) - Static method in class org.frontcache.io.WarmerActions
STATUS_CANCELLED - Static variable in class org.frontcache.replication.ReplicationResult: Replication was cancelled by the operator.
STATUS_COMPLETED - Static variable in class org.frontcache.replication.ReplicationResult: Replication completed without errors.
STATUS_COMPLETED_WITH_ERRORS - Static variable in class org.frontcache.replication.ReplicationResult: Replication completed but some entries failed.
STATUS_FAILED - Static variable in class org.frontcache.replication.ReplicationResult: Replication failed (source or target unreachable).
STATUS_IDLE - Static variable in class org.frontcache.replication.ReplicationResult: No replication has been started.
STATUS_RUNNING - Static variable in class org.frontcache.replication.ReplicationResult: Replication is still running.
stop() - Static method in class org.frontcache.metrics.FcMetricsExport: Test seam - closes the registries and forgets the instance.
stop() - Method in class org.frontcache.warmer.CacheWarmer: Lets in-flight requests finish, closes the failed list, and writes the checkpoint.
stop(CacheWarmer, boolean) - Static method in class org.frontcache.io.WarmerActions
STOPPING - Enum constant in enum class org.frontcache.warmer.CacheWarmer.State
Storage - Section in class org.frontcache.guard.ratelimit.WindowLimiter
streamMaxConcurrentConnections() - Method in class org.frontcache.resilience.FcResilienceConfig
StringUtils - Class in org.frontcache.core
StringUtils() - Constructor for class org.frontcache.core.StringUtils
SUCCESS - Enum constant in enum class org.frontcache.resilience.FcEventType

T

tags - Variable in class org.frontcache.tags.WebComponentSupport
TAGS_FIELD - Static variable in class org.frontcache.cache.impl.LuceneIndexManager
terminal(GuardRule, String, List) - Static method in class org.frontcache.guard.GuardOutcome
test(RequestContext) - Method in interface org.frontcache.guard.GuardPredicate
test(RequestContext) - Method in class org.frontcache.guard.ratelimit.RateLimitPredicate
The accounting is exhaustive - Section in class org.frontcache.include.combine.FcCombineMetrics
The answer - Section in org.frontcache.include.IncludeProcessorBase.isLoopbackOriginFetch(RequestContext)
The API key is what protects it - Section in class org.frontcache.metrics.FcMetricsServlet
The connection count - Section in class org.frontcache.resilience.stream.FcSampleSseServlet
The fallback is the point - Section in org.frontcache.client.FrontCacheClient.getNodeStatsActionResponse()
The gates, in order - Section in class org.frontcache.io.WarmerActions
The headers must never reach the origin - Section in class org.frontcache.warmer.WarmRequest
The Host header is set explicitly - Section in class org.frontcache.warmer.LoopbackWarmTransport
The idle handoff - Section in class org.frontcache.resilience.stream.FcSampleSseServlet
The key's scheme is not the loopback's - Section in class org.frontcache.warmer.LoopbackWarmTransport
The legacy x-frontcache-site-key header, for one release - Section in class org.frontcache.core.ApiKey
The old names still configure the new ones - Section in class org.frontcache.resilience.FcCommandKeys
The order of the steps is the contract - Section in org.frontcache.io.ConfigWriteAction.perform(String, String, String, boolean, boolean)
The property was front-cache.site-key through 2.8 - Section in class org.frontcache.core.ApiKey
The run - Section in class org.frontcache.warmer.CacheWarmer
The SSE stream's check is stricter, on purpose - Section in class org.frontcache.core.ApiKey
The token - Section in class org.frontcache.warmer.WarmRequest
The trailing newline is deliberately left alone - Section in org.frontcache.io.ConfigFileStore.normalize(String)
This enum IS the allowlist - Section in enum class org.frontcache.io.ConfigFile
THREAD - Enum constant in enum class org.frontcache.resilience.FcCommandConfig.Isolation
THREAD_POOL_REJECTED - Enum constant in enum class org.frontcache.resilience.FcEventType
threadPoolFrame(String, ThreadPoolExecutor) - Static method in class org.frontcache.resilience.stream.FcDashboardJson
Three of the four numbers are mutable; the fourth is not - Section in org.frontcache.resilience.FcThreadPools.reapplyGeometry(FcResilienceConfig)
timeLimiter(FcCommandConfig) - Static method in class org.frontcache.resilience.FcResilienceRegistry
timeLimiterConfig() - Method in class org.frontcache.resilience.FcCommandConfig
timeLimiterRegistry() - Static method in class org.frontcache.resilience.FcResilienceRegistry
TIMEOUT - Enum constant in enum class org.frontcache.resilience.FcEventType
toEntry() - Method in class org.frontcache.bots.BotRule
toEntry() - Method in class org.frontcache.guard.GuardRule
toJson() - Method in class org.frontcache.include.combine.CombineEnvelope
toJson() - Method in class org.frontcache.include.combine.CombineResponse
toString() - Method in class org.frontcache.bots.BotRule
toString() - Method in class org.frontcache.bots.BotRuleEntry
toString() - Method in class org.frontcache.cache.CacheStats
toString() - Method in class org.frontcache.cache.impl.LuceneIndexManager.Tuning
toString() - Method in class org.frontcache.client.FrontCacheClient
toString() - Method in class org.frontcache.core.Cidr
toString() - Method in class org.frontcache.core.FcNodeStats
toString() - Method in class org.frontcache.core.RequestContext: A bounded, one-line summary for diagnostics - NOT a dump of the map.
toString() - Method in class org.frontcache.guard.GuardAction
toString() - Method in class org.frontcache.guard.GuardRule
toString() - Method in class org.frontcache.guard.GuardRuleEntry
toString() - Method in class org.frontcache.guard.ratelimit.WindowLimiter
toString() - Method in class org.frontcache.replication.ReplicationResult
toString() - Method in record class org.frontcache.resilience.FcResilienceReload.Result: Returns a string representation of this record class.
toString() - Method in class org.frontcache.warmer.KeyBase
transformRedirectURL(String, RequestContext) - Static method in class org.frontcache.core.FCUtils: Rewrites a Location the origin sent so it names this site rather than the origin.
TRUSTED_PROXIES_PROPERTY - Static variable in class org.frontcache.core.ClientIpResolver
Tuning(double, double, long, boolean, long) - Constructor for class org.frontcache.cache.impl.LuceneIndexManager.Tuning
Two behavior changes, both from proposal section 14.6 - Section in class org.frontcache.resilience.stream.FcSampleSseServlet

U

ulr - Variable in class org.frontcache.tags.IncludeSupport
UNKNOWN - Static variable in class org.frontcache.cache.CacheStats: The processor does not track this number.
UNKNOWN - Static variable in class org.frontcache.core.FcNodeStats: The JVM does not report this number.
UNKNOWN_LOAD - Static variable in class org.frontcache.core.FcNodeStats: FcNodeStats.UNKNOWN for the CPU load, which is a fraction rather than a count.
Unknown is a value - Section in class org.frontcache.cache.CacheStats
Unknown is a value, and it does not add up - Section in class org.frontcache.io.NodeStatsActionResponse
UNSUPPORTED - Enum constant in enum class org.frontcache.include.combine.FcCombineMetrics.Batch: A 2xx with no x-frontcache-combine header: this origin has no combine handler.
update(Long, Integer) - Method in class org.frontcache.warmer.CacheWarmer: Changes the delay and/or the concurrency of the running run.
update(CacheWarmer, Long, Integer, boolean) - Static method in class org.frontcache.io.WarmerActions
URL_FIELD - Static variable in class org.frontcache.cache.impl.LuceneIndexManager
urlPattern - Variable in class org.frontcache.resilience.fr.FallbackConfigEntry
USER_AGENT - Static variable in class org.frontcache.warmer.WarmerConfig

V

validate(String) - Static method in class org.frontcache.bots.BotClassifier: Dry-parses a candidate bots.conf without touching anything live, for the set-config management action.
validate(String) - Method in class org.frontcache.guard.GuardRuleEngine: Dry-parses a candidate guard-rules.conf without touching anything live, for the set-config management action.
validate(ConfigFile, String) - Static method in class org.frontcache.io.ConfigFileValidator
validationErrors versus warnings - Section in class org.frontcache.io.SetConfigActionResponse
valueOf(String) - Static method in enum class org.frontcache.cache.FcCacheMetrics.Outcome: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.frontcache.guard.GuardAction.Type: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.frontcache.guard.GuardPredicateFactory.Scope: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.frontcache.include.combine.FcCombineMetrics.Batch: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.frontcache.include.combine.FcCombineMetrics.Error: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.frontcache.include.combine.FcCombineMetrics.Member: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.frontcache.io.ConfigFile: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.frontcache.resilience.FcCommandConfig.Isolation: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.frontcache.resilience.FcEventType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.frontcache.warmer.CacheWarmer.State: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.frontcache.warmer.WarmerEntry.Kind: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.frontcache.cache.FcCacheMetrics.Outcome: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.frontcache.guard.GuardAction.Type: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.frontcache.guard.GuardPredicateFactory.Scope: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.frontcache.include.combine.FcCombineMetrics.Batch: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.frontcache.include.combine.FcCombineMetrics.Error: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.frontcache.include.combine.FcCombineMetrics.Member: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.frontcache.io.ConfigFile: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.frontcache.resilience.FcCommandConfig.Isolation: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.frontcache.resilience.FcEventType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.frontcache.warmer.CacheWarmer.State: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.frontcache.warmer.WarmerEntry.Kind: Returns an array containing the constants of this enum class, in the order they are declared.
version(HttpServletRequest) - Static method in class org.frontcache.include.combine.CombineRequest: The protocol version the edge is speaking, or -1 when this is not a combined request.
VERSION - Static variable in class org.frontcache.include.combine.CombineProtocol: Protocol version.

W

warm(String) - Method in class org.frontcache.warmer.LoopbackWarmTransport
warm(String) - Method in interface org.frontcache.warmer.WarmTransport
WARM_REQUEST - Static variable in class org.frontcache.resilience.FcCommandKeys: The cache warmer's loopback request - see org.frontcache.warmer.WarmRequest.
WARMER_LISTS - Static variable in class org.frontcache.io.FrontcacheAction: The URI lists under ./warmer, with entry counts.
WARMER_PAUSE - Static variable in class org.frontcache.io.FrontcacheAction
WARMER_PREFLIGHT - Static variable in class org.frontcache.io.FrontcacheAction: What a run would do, without calling the origin - the Run panel's Check.
WARMER_RESUME - Static variable in class org.frontcache.io.FrontcacheAction
WARMER_START - Static variable in class org.frontcache.io.FrontcacheAction: Starts a run: list, mode, keyBase, clientType, delayMs, concurrency[, resumeFromLine].
WARMER_STATUS - Static variable in class org.frontcache.io.FrontcacheAction: State, run parameters, counters, rate, ETA, recent failures, last run, resumable checkpoint.
WARMER_STOP - Static variable in class org.frontcache.io.FrontcacheAction: Lets in-flight requests finish, closes the failed list, writes the checkpoint.
WARMER_UNSUPPORTED - Static variable in class org.frontcache.client.FrontCacheClient: The errorDescription of every warmer call made to a node that does not know the action.
WARMER_UPDATE - Static variable in class org.frontcache.io.FrontcacheAction: Changes delayMs and/or concurrency of the running run.
WarmerActions - Class in org.frontcache.io: The cache warmer's management actions, with no HttpServletRequest in sight - the ConfigWriteAction arrangement, for the same reason: the gates are what matter here, and they are testable without a servlet container.
WarmerCheckpoint - Class in org.frontcache.warmer: warmer/.state/run.json: where a run was, so it can be resumed after a restart.
WarmerCheckpoint() - Constructor for class org.frontcache.warmer.WarmerCheckpoint
WarmerConfig - Class in org.frontcache.warmer: The front-cache.warmer.* keys of frontcache.properties, read once per call site.
WarmerCounters - Class in org.frontcache.warmer: What a run did with its entries.
WarmerCounters() - Constructor for class org.frontcache.warmer.WarmerCounters
WarmerEntry - Class in org.frontcache.warmer: One line of a URI list, parsed.
WarmerEntry.Kind - Enum Class in org.frontcache.warmer
WarmerError - Class in org.frontcache.warmer: One failed entry in the status's recent-failures ring.
WarmerError() - Constructor for class org.frontcache.warmer.WarmerError
WarmerError(long, String, String, long) - Constructor for class org.frontcache.warmer.WarmerError
WarmerLine - Class in org.frontcache.warmer: One numbered line of a list - a preview row, a search hit, or an invalid line in a preflight.
WarmerLine() - Constructor for class org.frontcache.warmer.WarmerLine
WarmerLine(long, String) - Constructor for class org.frontcache.warmer.WarmerLine
WarmerListActionResponse - Class in org.frontcache.io: get-warmer-list, put-warmer-list and delete-warmer-list: one list.
WarmerListActionResponse() - Constructor for class org.frontcache.io.WarmerListActionResponse
WarmerListActionResponse(String) - Constructor for class org.frontcache.io.WarmerListActionResponse
WarmerListInfo - Class in org.frontcache.warmer: One row of warmer-lists.
WarmerListInfo() - Constructor for class org.frontcache.warmer.WarmerListInfo
WarmerListsActionResponse - Class in org.frontcache.io: warmer-lists: the URI lists under FRONTCACHE_HOME/warmer/, newest first.
WarmerListsActionResponse() - Constructor for class org.frontcache.io.WarmerListsActionResponse
WarmerListsActionResponse(String) - Constructor for class org.frontcache.io.WarmerListsActionResponse
WarmerListStore - Class in org.frontcache.warmer: The URI lists under FRONTCACHE_HOME/warmer/, and the only place a list name becomes a File.
WarmerListStore(File) - Constructor for class org.frontcache.warmer.WarmerListStore
WarmerListStore.RefusedException - Exception Class in org.frontcache.warmer: Thrown when a write is refused - too large, or the list changed since it was read.
WarmerListView - Class in org.frontcache.warmer: What get-warmer-list returns for one list: the whole content when it is small enough to edit, otherwise the first and last lines.
WarmerListView() - Constructor for class org.frontcache.warmer.WarmerListView
warmerPause() - Method in class org.frontcache.client.FrontCacheClient
warmerPreflight(WarmerRunParams) - Method in class org.frontcache.client.FrontCacheClient
WarmerPreflight - Class in org.frontcache.warmer: What warmer-preflight reports: one read of the list, without calling the origin.
WarmerPreflight() - Constructor for class org.frontcache.warmer.WarmerPreflight
WarmerPreflightActionResponse - Class in org.frontcache.io: warmer-preflight: what a run with these parameters would do, without calling the origin.
WarmerPreflightActionResponse() - Constructor for class org.frontcache.io.WarmerPreflightActionResponse
WarmerPreflightActionResponse(String) - Constructor for class org.frontcache.io.WarmerPreflightActionResponse
warmerResume() - Method in class org.frontcache.client.FrontCacheClient
WarmerRunParams - Class in org.frontcache.warmer: The parameters of one warm run, as the Run form (or a warmer-start call) gives them.
WarmerRunParams() - Constructor for class org.frontcache.warmer.WarmerRunParams
WarmerRunSummary - Class in org.frontcache.warmer: A finished run - kept as the screen's Last run panel until the next run starts, and logged at INFO.
WarmerRunSummary() - Constructor for class org.frontcache.warmer.WarmerRunSummary
warmerStart(WarmerRunParams) - Method in class org.frontcache.client.FrontCacheClient
WarmerStatus - Class in org.frontcache.warmer: Everything warmer-status reports: the node's warmer state, the current run if there is one, the last finished run, a resumable checkpoint, and the defaults the Run form starts from.
WarmerStatus() - Constructor for class org.frontcache.warmer.WarmerStatus
WarmerStatusActionResponse - Class in org.frontcache.io: What warmer-status returns, and what every run-control action (warmer-start, warmer-update, -pause, -resume, -stop) answers with - the state after the call.
WarmerStatusActionResponse() - Constructor for class org.frontcache.io.WarmerStatusActionResponse
WarmerStatusActionResponse(String) - Constructor for class org.frontcache.io.WarmerStatusActionResponse
warmerStop() - Method in class org.frontcache.client.FrontCacheClient
warmerUpdate(Long, Integer) - Method in class org.frontcache.client.FrontCacheClient: A null leaves that setting as it is.
WarmRequest - Class in org.frontcache.warmer: What makes a request a warm request, and the vocabulary a warm request is answered in.
WarmTransport - Interface in org.frontcache.warmer: Sends one warm request and says what came back.
WarmTransport.Outcome - Class in org.frontcache.warmer: What the front door answered.
warnings() - Method in record class org.frontcache.resilience.FcResilienceReload.Result: Returns the value of the warnings record component.
WebComponentSupport - Class in org.frontcache.tags
WebComponentSupport() - Constructor for class org.frontcache.tags.WebComponentSupport: Constructs a new handler.
WebComponentTag - Class in org.frontcache.tags
WebComponentTag() - Constructor for class org.frontcache.tags.WebComponentTag
WebResponse - Class in org.frontcache.core: Container for web response.
WebResponse() - Constructor for class org.frontcache.core.WebResponse
WebResponse(String) - Constructor for class org.frontcache.core.WebResponse: some responses has no body (e.g.
WebResponse(String, byte[]) - Constructor for class org.frontcache.core.WebResponse: maxAgeStr = null so, content is not subject to cache (maxAge = 0/no_cache)
WebResponse(String, byte[], String, String) - Constructor for class org.frontcache.core.WebResponse
What a list's content is, byte for byte - Section in class org.frontcache.warmer.WarmerListStore
What applies immediately, and what cannot - Section in class org.frontcache.resilience.FcResilienceReload
What a warm request changes - Section in class org.frontcache.warmer.WarmRequest
What each one covers - Section in class org.frontcache.resilience.FcCommandKeys
What these are for - Section in class org.frontcache.include.combine.FcCombineMetrics
Who caches what this returns - Section in org.frontcache.include.IncludeProcessorBase.fetchIncludeFromOrigin(String, String, Map, FcHttpClient, RequestContext, String, String, long)
Why a member's query is carried as one encoded value - Section in class org.frontcache.include.combine.CombineProtocol
Why an un-keyed node is refused here and allowed by #isAuthorized - Section in org.frontcache.core.ApiKey.isAuthorizedToWrite(HttpServletRequest)
Why a TTL and not a permanent flag - Section in class org.frontcache.include.combine.CombineUnsupportedMemo
Why commits are no longer per write - Section in class org.frontcache.cache.impl.LuceneIndexManager.Tuning
Why ISO-8859-1 and not the page's real charset - Section in org.frontcache.include.IncludeProcessorBase.hasIncludes(WebResponse, int)
Why it is a run parameter and not something each list entry decides - Section in class org.frontcache.warmer.KeyBase
Why it is correct - Section in org.frontcache.include.IncludeProcessorBase.hasIncludes(WebResponse, int)
Why not just write the file - Section in org.frontcache.io.ConfigFileStore.write(File, String)
Why refresh-on-write defaults to true - Section in class org.frontcache.cache.impl.LuceneIndexManager.Tuning
Why the parts are indexed rather than repeated - Section in class org.frontcache.include.combine.CombineProtocol
Why these are counted here and not derived - Section in class org.frontcache.cache.FcCacheMetrics
Why the tier is part of it - Section in class org.frontcache.cache.FcCacheMetrics
Why the writes are non-blocking rather than "publisher writes and blocks" - Section in class org.frontcache.resilience.stream.FcSampleSseServlet
Why this has to be known, and what it costs to get wrong - Section in org.frontcache.include.IncludeProcessorBase.isLoopbackOriginFetch(RequestContext)
Why this is not get-cache-state - Section in class org.frontcache.io.NodeStatsActionResponse
Why this needs a class of its own - Section in class org.frontcache.resilience.FcResilienceReload
Why validate at all, rather than write and let the reload cope - Section in class org.frontcache.io.ConfigFileValidator
WindowLimiter - Class in org.frontcache.guard.ratelimit: Fixed-window request counter: how many requests one key sent inside the current measurement slot.
WindowLimiter(String, int, long, int) - Constructor for class org.frontcache.guard.ratelimit.WindowLimiter
wire() - Method in enum class org.frontcache.warmer.CacheWarmer.State
withDefaultBucket(String) - Method in class org.frontcache.guard.ratelimit.RateLimitSpec
withGroupKey(String) - Static method in class org.frontcache.resilience.FcCommand.Setter
withRequestDefaults(ActionResponse, WarmerConfig, boolean) - Static method in class org.frontcache.io.WarmerActions: Sets the default key base a status response offers the Run form to the one this request implies.
write(File, String) - Static method in class org.frontcache.io.ConfigFileStore: Replaces the file's content atomically.
write(String, InputStream, long, String, long) - Method in class org.frontcache.warmer.WarmerListStore: Creates or replaces one list from a stream, never holding it whole.
writeResponse(InputStream, OutputStream) - Static method in class org.frontcache.core.FCUtils: Streams in to out.
writeTo(HttpServletResponse) - Method in class org.frontcache.include.combine.CombineResponse: Writes the envelope: content type, the x-frontcache-combine support signal, an explicit content length, and the JSON body.
written and applied are separate on purpose - Section in class org.frontcache.io.SetConfigActionResponse

X

X_FORWARDED_HOST - Static variable in class org.frontcache.core.FCHeaders
X_FORWARDED_PROTO - Static variable in class org.frontcache.core.FCHeaders
X_FRONTCACHE_ASYNC_INCLUDE - Static variable in class org.frontcache.core.FCHeaders
X_FRONTCACHE_CLIENT_IP - Static variable in class org.frontcache.core.FCHeaders
X_FRONTCACHE_CLIENT_TYPE - Static variable in class org.frontcache.core.FCHeaders: The client type (FCHeaders.REQUEST_CLIENT_TYPE_BOT / FCHeaders.REQUEST_CLIENT_TYPE_GUEST) the node serving the PAGE decided, carried to an <fc:include> fetch so the fragment is classified the same way as the page holding it.
X_FRONTCACHE_COMPONENT - Static variable in class org.frontcache.core.FCHeaders
X_FRONTCACHE_COMPONENT_CACHE_LEVEL - Static variable in class org.frontcache.core.FCHeaders
X_FRONTCACHE_COMPONENT_MAX_AGE - Static variable in class org.frontcache.core.FCHeaders
X_FRONTCACHE_COMPONENT_REFRESH_TYPE - Static variable in class org.frontcache.core.FCHeaders
X_FRONTCACHE_COMPONENT_TAGS - Static variable in class org.frontcache.core.FCHeaders
X_FRONTCACHE_DYNAMIC_REQUEST - Static variable in class org.frontcache.core.FCHeaders
X_FRONTCACHE_FALLBACK_IS_USED - Static variable in class org.frontcache.core.FCHeaders
X_FRONTCACHE_ID - Static variable in class org.frontcache.core.FCHeaders
X_FRONTCACHE_INCLUDE_LEVEL - Static variable in class org.frontcache.core.FCHeaders
X_FRONTCACHE_REQUEST_ID - Static variable in class org.frontcache.core.FCHeaders
X_FRONTCACHE_SITE_KEY - Static variable in class org.frontcache.core.FCHeaders: Deprecated.
send Authorization: Bearer <api-key> instead
X_FRONTCACHE_SOFT_REFRESH - Static variable in class org.frontcache.core.FCHeaders
X_FRONTCACHE_TRACE - Static variable in class org.frontcache.core.FCHeaders
X_FRONTCACHE_TRACE_REQUEST - Static variable in class org.frontcache.core.FCHeaders
X_FRONTCACHE_WARM - Static variable in class org.frontcache.core.FCHeaders: The cache warmer's credential on a warm request - see org.frontcache.warmer.WarmRequest.
X_FRONTCACHE_WARM_CLIENT_TYPE - Static variable in class org.frontcache.core.FCHeaders: bot | guest - honoured only beside a valid FCHeaders.X_FRONTCACHE_WARM.
X_FRONTCACHE_WARM_KEY - Static variable in class org.frontcache.core.FCHeaders: Response header on a warm request only: the cache key the node built for it.
X_FRONTCACHE_WARM_MODE - Static variable in class org.frontcache.core.FCHeaders: fill | refresh - honoured only beside a valid FCHeaders.X_FRONTCACHE_WARM.
X_FRONTCACHE_WARM_RESULT - Static variable in class org.frontcache.core.FCHeaders: Response header on a warm request only: stored | fresh | not-cacheable | fallback.

A B C D E F G H I J K L M N O P Q R S T U V W X
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form