Index

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
 
action() - Method in interface org.frontcache.module.ManagementRequest
Deprecated.
 
actionsDescriptionMap - Static variable in class org.frontcache.io.FrontcacheAction
 
active() - Static method in class org.frontcache.bots.VisitorTypes
 
add(String) - Method in class org.frontcache.bots.VisitorTypes.Builder
 
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
 
A module cannot stop a node - Section in interface org.frontcache.module.FrontcacheModule
 
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)
 
A plugin's config - Section in class org.frontcache.plugin.host.FrontcachePlugins
 
A plugin that fails is a plugin that is absent - Section in class org.frontcache.plugin.host.FrontcachePlugins
 
A plugin that fails is a plugin that is absent - for its own path only - Section in class org.frontcache.plugin.host.PluginEndpoints
 
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
 

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
 
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.
BIND_IP - Static variable in class org.frontcache.core.EvidenceCookies
 
BIND_IP_UA - Static variable in class org.frontcache.core.EvidenceCookies
 
BIND_UA - Static variable in class org.frontcache.core.EvidenceCookies
 
binding() - Method in class org.frontcache.guard.ExtPredicate
binding(Object) - Method in class org.frontcache.guard.ExtPredicate
Binding - Section in class org.frontcache.plugin.host.PluginPredicates
 
bindMeters(Object) - Method in interface org.frontcache.module.FrontcacheModule
Deprecated.
Registers this module's series on the metrics exporter's registry - an io.micrometer.core.instrument.MeterRegistry, typed Object so this interface carries no Micrometer type.
bindMeters(Object) - Static method in class org.frontcache.plugin.host.FrontcachePlugins
Lets every loaded plugin register its meters - see FrontcachePlugin.bindMeters(Object).
body() - Method in interface org.frontcache.module.ManagementRequest
Deprecated.
The request body, unread.
BOT - Static variable in class org.frontcache.bots.ClientSelector
 
BotClassifier - Class in org.frontcache.bots
Decides a request's visitor type - bot, guest or a type the file declares with @type <name> like <bot|guest> (VisitorTypes) - and so its client type, the root - 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
A rule whose verdict is a root, bot or guest.
BotRule(String, List, String, 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.
build() - Method in class org.frontcache.bots.VisitorTypes.Builder
 
buildCombinedQuery(List) - Static method in class org.frontcache.include.combine.CombineProtocol
The combined query string, including the leading ?.
builder() - Static method in class org.frontcache.bots.VisitorTypes
 
Builder() - Constructor for class org.frontcache.bots.VisitorTypes.Builder
 
BuildInfo - Class in org.frontcache.license
The version and release date this jar was built as - read from org/frontcache/build-info.properties, which the build generates from version.properties (see generateBuildInfo in build.gradle).
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
 
BundledPluginContext - Interface in org.frontcache.plugin.host
The context the core hands every plugin it loads from its own class path - the war's WEB-INF/lib, or a filter-mode application's class path, where a plugin shares the core's class loader.
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_INVALIDATED - Static variable in class org.frontcache.plugin.host.FcEventBus
 
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
 
cacheInvalidated(String, String) - Static method in class org.frontcache.plugin.host.CoreEvents
 
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
 
call(Map, Class) - Method in class org.frontcache.client.FrontCacheClient
One management call, answered as JSON.
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.
callStreaming(Map, String, OutputStream, Class) - Method in class org.frontcache.client.FrontCacheClient
A management call whose answer may be a raw body: streamed into os - never through memory - when its Content-Type starts with rawContentTypePrefix, otherwise read as JSON (a refusal, or a ping from a node that does not know the action).
callWithBody(Map, InputStream, long, String, Class) - Method in class org.frontcache.client.FrontCacheClient
A management call whose payload is the request BODY, with the parameters in the query string.
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
 
challenge(String) - Static method in class org.frontcache.plugin.host.PluginEndpoints
The plugin offering provider - when one is started with an endpoint and the node can sign a pass.
challenge(String, GuardAction) - Static method in class org.frontcache.guard.GuardAction
challenge <provider> [else <reject|redirect>]: a 302 to the page of the plugin offering the provider - when one is started and the node can sign a pass.
challenge(GuardRule, String, String, List) - Static method in class org.frontcache.guard.GuardOutcome
A challenge: a redirect to challengePlugin's page, at target.
Challenge(String, Set) - Constructor for record class org.frontcache.plugin.host.PluginEndpoints.Challenge
Creates an instance of a Challenge record class.
CHALLENGE - Enum constant in enum class org.frontcache.guard.GuardAction.Type
 
CHALLENGE_ISSUED - Static variable in class org.frontcache.plugin.host.FcEventBus
 
CHALLENGE_RESULT - Static variable in class org.frontcache.plugin.host.FcEventBus
 
challengeIssued(RequestContext, String, String, String) - Static method in class org.frontcache.plugin.host.CoreEvents
A challenge rule sent a visitor to a provider's page - after the redirect is written.
check(ExtPredicate, String) - Static method in class org.frontcache.plugin.host.PluginPredicates
Binds a rule's predicate now - what the engine does for every rule right after the plugins start and after each reload of guard-rules.conf or bots.conf, so a mistake is in the log at once rather than at the first request.
checkAndCount(long, long) - Method in class org.frontcache.guard.ratelimit.WindowLimiter
Counts one request for keyHash and says whether it is over the limit.
checkAndCountFlagged(long, long) - Method in class org.frontcache.guard.ratelimit.WindowLimiter
WindowLimiter.checkAndCount(long, long), with WindowLimiter.FIRST_OVER_LIMIT set on the one request per key and window that crossed the limit - what makes "a client went over" an event that happens once, not once per refused request.
checkChallengeProviders() - Method in class org.frontcache.guard.GuardRuleEngine
Says, for every challenge rule, whether its provider can be used - at load, once the plugins have started (the engine's first load runs before them, so the engine calls this again after starting them).
checkPluginPredicates() - Method in class org.frontcache.bots.BotClassifier
Binds every rule's ext: predicates to the started plugins now, so a mistake is in the log at once - see GuardRuleEngine.checkPluginPredicates.
checkPluginPredicates() - Method in class org.frontcache.guard.GuardRuleEngine
Binds every rule's ext: predicates to the started plugins now - at load once they run, and by the engine right after it starts them (the engine's first load runs before) - so a name no plugin offers, or an argument a plugin refuses, is an ERROR in the log at once, not at the first request that reaches the rule.
Cidr - Class in org.frontcache.core
An address block, compared on raw address bytes so v4 and v6 never match each other.
CidrSet - Class in org.frontcache.core
A set of Cidr blocks that answers "is this address in one of them" in a handful of hash lookups, however many blocks it holds - what a client-ip: rule asks on every request it reaches.
CIRCUIT_STATE_CHANGED - Static variable in class org.frontcache.plugin.host.FcEventBus
 
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.
circuitStateChanged(String, String, String, float) - Static method in class org.frontcache.plugin.host.CoreEvents
 
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
 
ClientSelector - Class in org.frontcache.bots
The client="..." attribute of an <fc:include>: which visitors the fragment is resolved for.
close() - Method in class org.frontcache.cache.impl.LuceneIndexManager
 
close() - Method in class org.frontcache.client.FrontCacheCluster
 
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 (include combining).
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_RELOADED - Static variable in class org.frontcache.plugin.host.FcEventBus
 
CONFIG_WRITE_PROPERTY - Static variable in class org.frontcache.io.ConfigWriteAction
Property that turns runtime config writes off for this node.
configFile(String) - Static method in class org.frontcache.plugin.host.FrontcachePlugins
The conf/ file a loaded plugin's manifest names - never composed from a caller's input - or null when there is no such plugin, it was refused, or it has no config.
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.
ConfigReload(boolean, String, String, List) - Constructor for record class org.frontcache.plugin.host.FrontcachePlugins.ConfigReload
Creates an instance of a ConfigReload record class.
configReloaded(String, boolean, int, List) - Static method in class org.frontcache.plugin.host.CoreEvents
 
configured() - Static method in class org.frontcache.core.ApiKey
 
configured() - Static method in class org.frontcache.core.EdgeToken
 
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(String) - Method in class org.frontcache.core.CidrSet
 
contains(String) - Method in class org.frontcache.guard.IpLists.LiveList
Whether an address is in one of the list's blocks; false for null.
contains(InetAddress) - Method in class org.frontcache.core.Cidr
 
contains(InetAddress) - Method in class org.frontcache.core.CidrSet
 
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
 
cookies() - Method in record class org.frontcache.plugin.host.PluginEndpoints.Challenge
Returns the value of the cookies record component.
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.
CoreEvents - Class in org.frontcache.plugin.host
The core's emit points, one method per event: each checks FcEventBus.wants(long) before building anything, so a node nobody observes pays one volatile read per point and allocates nothing.
count(String) - Static method in class org.frontcache.bots.VisitorTypeRequests
One top-level request of this type.
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
 
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.license.BuildInfo
 
currentContent is only filled on a conflict - Section in class org.frontcache.io.SetConfigActionResponse
 

D

debugComments - Static variable in class org.frontcache.FrontCacheEngine
 
DECIDE_OK - Static variable in class org.frontcache.io.PluginStats
PluginStats.getDecideState(): its predicates answer.
DECIDE_OVER_BUDGET - Static variable in class org.frontcache.io.PluginStats
PluginStats.getDecideState(): switched off for going over its budget or throwing - its rules do not match.
declared() - Method in class org.frontcache.bots.VisitorTypes
 
decodePart(String) - Static method in class org.frontcache.include.combine.CombineProtocol
decrementCurrentConcurrentConnections() - Method in class org.frontcache.resilience.stream.FcDashboardStreamServlet
 
decrementCurrentConcurrentConnections() - Method in class org.frontcache.resilience.stream.FcSampleSseServlet
 
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_QUEUE_CAPACITY - Static variable in class org.frontcache.plugin.host.FcEventBus
 
DEFAULT_ROLLING_STATS_MS - Static variable in class org.frontcache.resilience.FcResilienceConfig
 
DefaultFallbackResolver - Class in org.frontcache.resilience.fr
 
DefaultFallbackResolver() - Constructor for class org.frontcache.resilience.fr.DefaultFallbackResolver
 
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.
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.
Delivery - Section in class org.frontcache.plugin.host.FcEventBus
 
describe() - Method in class org.frontcache.guard.ExtPredicate
 
describe() - Method in interface org.frontcache.guard.GuardPredicate
 
describe() - Method in class org.frontcache.guard.ratelimit.RateLimitPredicate
 
describeKnown() - Method in class org.frontcache.bots.VisitorTypes
 
description() - Method in interface org.frontcache.module.ManagementAction
Deprecated.
One line for the help action.
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.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
 
DIRECTIVE - Static variable in class org.frontcache.bots.VisitorTypes
The directive's keyword.
DIRECTORY - Static variable in class org.frontcache.guard.IpLists
The directory under conf/, with its slash: @lists/banned.txt.
DISPOSITION_CHALLENGED - Static variable in class org.frontcache.guard.GuardAction
 
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
 
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.
EDGE_TOKEN_PROPERTY - Static variable in class org.frontcache.core.EdgeToken
Sent on every origin call, accepted on every inbound request.
EdgeToken - Class in org.frontcache.core
The front-cache.edge-token - how a second-layer node tells a request from its own edge apart from one that reached it directly.
EMPTY - Static variable in class org.frontcache.core.CidrSet
The set with no block: contains nothing.
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_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.
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.plugin.host.FrontcachePlugins.ConfigReload
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.frontcache.plugin.host.PluginEndpoints.Challenge
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.frontcache.resilience.FcResilienceReload.Result
Indicates whether some other object is "equal to" this one.
ERROR - Enum constant in enum class org.frontcache.include.combine.FcCombineMetrics.Batch
The origin claims support and sent something unusable - see FcCombineMetrics.Error.
errors() - Method in record class org.frontcache.plugin.host.FrontcachePlugins.ConfigReload
Returns the value of the errors record component.
evaluate(RequestContext) - Method in class org.frontcache.guard.GuardRuleEngine
Runs the rules for one request.
eventContext() - Method in class org.frontcache.resilience.FC_BypassCache
 
eventContext() - Method in class org.frontcache.resilience.FC_ThroughCache_HttpClient
 
eventContext() - Method in class org.frontcache.resilience.FC_ThroughCache_WebFilter
 
eventContext() - Method in class org.frontcache.resilience.FC_ThroughCache
 
eventContext() - Method in class org.frontcache.resilience.FC_Total
 
eventContext() - Method in class org.frontcache.resilience.FcCommand
The request this command serves, for the events it emits; null when it serves none (a management lookup).
eventUri() - Method in class org.frontcache.resilience.FC_ThroughCache_HttpClient
The public URL of the page or include being fetched, never the origin-facing one.
eventUri() - Method in class org.frontcache.resilience.FC_ThroughCache
The cache key's URL - a management lookup has no request to take one from.
eventUri() - Method in class org.frontcache.resilience.FcCommand
The URL this command calls, for the events it emits: the request's own unless a command knows better.
EvidenceCookies - Class in org.frontcache.core
Evidence cookies: a cookie whose value a client cannot produce without the node's secret - what the cookie-hmac:<name> predicate verifies, and what a serving plugin's evidence signer mints.
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
 
existingCacheProcessor() - Method in interface org.frontcache.module.ModuleContext
Deprecated.
The node's cache processor if it exists, without creating one; may be null.
existingCacheProcessor() - Method in interface org.frontcache.plugin.host.BundledPluginContext
The node's cache processor if it exists, without creating one; may be null.
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.
EXPIRE_DATE_FIELD - Static variable in class org.frontcache.cache.impl.LuceneIndexManager
 
ExtPredicate - Class in org.frontcache.guard
ext:<name>[:<argument>] - a condition a started plugin offers (decide, E3).

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.
FAILURE - Enum constant in enum class org.frontcache.resilience.FcEventType
 
failureName(Enum) - Static method in class org.frontcache.plugin.host.CoreEvents
A resilience event type as an event spells it: TIMEOUT -> timeout.
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_SERVED - Static variable in class org.frontcache.plugin.host.FcEventBus
 
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
 
fallbackServed(RequestContext, String, String, String, Throwable) - Static method in class org.frontcache.plugin.host.CoreEvents
A fallback was served instead of the origin.
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
 
FcEventBus - Class in org.frontcache.plugin.host
The E1 event bus: where the node hands events to the plugins that observe it.
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
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.
file() - Method in record class org.frontcache.plugin.host.FrontcachePlugins.ConfigReload
Returns the value of the file record component.
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
 
FILTER - Enum constant in enum class org.frontcache.module.NodeMode
Deprecated.
 
Finding them - Section in class org.frontcache.plugin.host.FrontcachePlugins
 
FIRST_OVER_LIMIT - Static variable in class org.frontcache.guard.ratelimit.WindowLimiter
Set in WindowLimiter.checkAndCountFlagged(long, long)'s answer on the request that took a key over the limit - the first refused one of its window.
forCommand(String, String) - Method in class org.frontcache.resilience.FcResilienceConfig
 
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
 
frontcacheHome() - Method in interface org.frontcache.module.ModuleContext
Deprecated.
FRONTCACHE_HOME, or null for a node started without one.
FrontCacheHttpResponseWrapper - Interface in org.frontcache.wrapper
 
FrontCacheIOServlet - Class in org.frontcache.io
 
FrontCacheIOServlet() - Constructor for class org.frontcache.io.FrontCacheIOServlet
 
FrontcacheModule - Interface in org.frontcache.module
Deprecated.
since 2.13.0: implement FrontcachePlugin and ship a META-INF/frontcache-plugin.properties manifest. A module without one still runs, through an adapter, as a manage plugin - for one release.
FrontcachePlugins - Class in org.frontcache.plugin.host
The node's plugins - found once per process, started and stopped with the engine.
FrontcachePlugins.ConfigReload - Record Class in org.frontcache.plugin.host
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.
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_PLUGIN_CONFIG - Static variable in class org.frontcache.io.FrontcacheAction
A plugin's conf/<config>, raw - plugin=<id>.
GET_RESILIENCE_CONFIGS - Static variable in class org.frontcache.io.FrontcacheAction
 
getAction() - Method in class org.frontcache.guard.GuardOutcome
 
getAction() - Method in class org.frontcache.guard.GuardRule
 
getAction() - Method in class org.frontcache.guard.GuardRuleEntry
 
getActionsDescription() - Method in class org.frontcache.io.HelpActionResponse
 
getApacheClient() - Method in class org.frontcache.core.ApacheFcHttpClient
The underlying Apache client.
getArgument() - Method in class org.frontcache.guard.ExtPredicate
 
getBackupFile() - Method in class org.frontcache.io.SetConfigActionResponse
 
getBase() - Method in class org.frontcache.bots.VisitorTypeEntry
the root this type behaves like where nothing names it - for a root, the root itself
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
 
getCachedEntries() - Method in class org.frontcache.io.NodeStatsActionResponse
Entries across both tiers, or -1 when either tier does not report.
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.
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
 
getChallengePlugin() - Method in class org.frontcache.guard.GuardOutcome
 
getChallenges() - Method in class org.frontcache.io.PluginStats
serve: the challenge providers its manifest offers to a challenge <provider> guard rule.
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 - the root of BotRule.getVisitorType()
getClientType() - Method in class org.frontcache.bots.BotRuleEntry
 
getClientType() - Method in class org.frontcache.core.RequestContext
bot | guest - the ROOT of the request's visitor type, always.
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
 
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
 
getConfig() - Method in class org.frontcache.io.PluginStats
The plugin's config file under conf/, as its manifest names it; null when it has none.
getConfigErrors() - Method in class org.frontcache.io.PluginStats
Why the last read was refused; empty otherwise.
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.
getConfigLoaded() - Method in class org.frontcache.io.PluginStats
When the config the plugin runs on was accepted, epoch milliseconds; 0 when never.
getConfigStatus() - Method in class org.frontcache.io.PluginStats
The last read of PluginStats.getConfig(): ok, absent (no file - the plugin got an empty config), refused (see PluginStats.getConfigErrors(); at a start the plugin is then not started, on a reload it keeps the config it had), or null when it has not been read yet or the plugin has no config.
getContent() - Method in class org.frontcache.core.WebResponse
 
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.
getCookies() - Method in class org.frontcache.io.PluginStats
serve: the cookies its manifest names - the only ones it reads, sets and has signed.
getCookieValues(String) - Method in class org.frontcache.core.RequestContext
The values of the cookies the client sent under one name - for the two readers allowed to see a value: the cookie-hmac: predicate, which verifies it and logs nothing of it (EvidenceCookies), and a serving plugin's view of its own request, for a cookie its manifest names.
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
 
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).
getDecideBudgetMicros() - Method in class org.frontcache.io.PluginStats
decide: its budget, front-cache.plugins.<id>.decide-budget, in microseconds.
getDecideCalls() - Method in class org.frontcache.io.PluginStats
decide: calls into its predicates since the process started.
getDecideErrors() - Method in class org.frontcache.io.PluginStats
decide: calls that threw.
getDecideP99Micros() - Method in class org.frontcache.io.PluginStats
decide: its predicates' p99 over the last minute judged, in microseconds; -1 before the first.
getDecideReason() - Method in class org.frontcache.io.PluginStats
decide: why it was last switched off - the p99 or the error rate; null when it never was.
getDecideRetryAt() - Method in class org.frontcache.io.PluginStats
decide: while "over-budget", when it is tried again (epoch millis); 0 otherwise.
getDecideState() - Method in class org.frontcache.io.PluginStats
decide: "ok" or "over-budget"; null for a plugin that does not decide.
getDecideSwitchedOff() - Method in class org.frontcache.io.PluginStats
decide: how many times it was switched off.
getDirectory() - Method in class org.frontcache.io.PluginStats
A dropped-in plugin's directory, relative to the plugin directory's parent (plugins/geoip); else null.
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
 
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
 
getEnvelope() - Method in class org.frontcache.include.combine.CombineResponse
 
getErrorPercentage() - Method in class org.frontcache.resilience.FcCommandMetrics
 
getErrors() - Method in class org.frontcache.io.PluginStats
 
getErrors() - Method in class org.frontcache.io.ReloadPluginConfigActionResponse
 
getErrors() - Method in class org.frontcache.replication.ReplicationResult
 
getErrorThresholdPercentage() - Method in class org.frontcache.resilience.FcCommandConfig
 
getEventsDelivered() - Method in class org.frontcache.io.PluginStats
 
getEventsDropped() - Method in class org.frontcache.io.PluginStats
 
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.
getFailedExecutionException() - Method in class org.frontcache.resilience.FcCommand
Null unless run() itself threw - see the class javadoc.
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.GetPluginConfigActionResponse
The file under conf/, as the plugin's manifest names it.
getFile() - Method in class org.frontcache.io.ReloadPluginConfigActionResponse
 
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
 
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
 
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.bots.VisitorTypeEntry
 
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.
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
getId() - Method in enum class org.frontcache.io.ConfigFile
The id a caller sends, and the one the console's screens are keyed by.
getId() - Method in class org.frontcache.io.PluginStats
 
getIncludeClientSelector(String) - Method in class org.frontcache.include.IncludeProcessorBase
The include's client="..." as a selector - names select by is-a, a comma list any of them, !name excludes (ClientSelector).
getIncludeClientType(String) - Method in class org.frontcache.include.IncludeProcessorBase
Deprecated.
a client= may name declared visitor types, a list and exclusions - IncludeProcessorBase.getIncludeClientSelector(String) reads all of it; this reads the two roots only
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(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.
getIsolation() - Method in class org.frontcache.resilience.FcCommandConfig
 
getJars() - Method in class org.frontcache.io.PluginStats
A dropped-in plugin's jars, each <file name> <sha256>; empty for a bundled one.
getKey() - Method in class org.frontcache.io.GetFromCacheActionResponse
 
getKey() - Method in class org.frontcache.io.PutToCacheActionResponse
 
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
 
getKinds() - Method in class org.frontcache.io.PluginStats
The declared kinds, as a manifest spells them: observe, manage, ...
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
 
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.
getLicense() - Method in class org.frontcache.io.PluginStats
SPDX, as the plugin states it.
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
 
getListBetween(String, String, String, List) - Static method in class org.frontcache.core.StringUtils
 
getLogToHTTPHeaders() - Method in class org.frontcache.core.RequestContext
 
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
 
getModules() - Method in class org.frontcache.io.NodeStatsActionResponse
The ids of the plugins this node runs (["pro"] with the Pro jar) - the started ones of NodeStatsActionResponse.getPlugins().
getName() - Method in class org.frontcache.bots.BotRule
 
getName() - Method in class org.frontcache.bots.BotRuleEntry
 
getName() - Method in class org.frontcache.bots.VisitorTypeEntry
 
getName() - Method in class org.frontcache.client.FrontCacheClient
http://localhost:8080/ -> localhost:8080
getName() - Method in class org.frontcache.guard.ExtPredicate
 
getName() - Method in class org.frontcache.guard.GuardRule
 
getName() - Method in class org.frontcache.guard.GuardRuleEntry
 
getName() - Method in class org.frontcache.io.PluginStats
 
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.
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
getOriginResponseHeaders() - Method in class org.frontcache.core.RequestContext
the Origin response headers
getOriginStatus() - Method in exception class org.frontcache.core.FrontCacheException
The origin's status when that is why this was thrown (FrontCacheException.originStatus(int, String)); 0 otherwise.
getOriginURL() - Method in class org.frontcache.core.RequestContext
 
getOtherwise() - Method in class org.frontcache.guard.GuardAction
 
getOverLimitCount() - Method in class org.frontcache.guard.ratelimit.WindowLimiter
Clients that went over the limit since this limiter was created, each counted once per window.
getParts() - Method in class org.frontcache.include.combine.CombineEnvelope
 
getPatternCount() - Method in class org.frontcache.io.ReloadDynamicUrlsActionResponse
 
getPercentiles() - Method in class org.frontcache.resilience.FcCommandMetrics.LatencySnapshot
The percentile map the dashboard expects, with its exact key set and order.
getPlugin() - Method in class org.frontcache.io.GetPluginConfigActionResponse
 
getPlugin() - Method in class org.frontcache.io.ReloadPluginConfigActionResponse
 
getPluginApi() - Method in class org.frontcache.io.PluginStats
 
getPluginConfig() - Method in class org.frontcache.io.GetPluginConfigActionResponse
The raw content; null when the file is absent.
getPluginConfig(String) - Method in class org.frontcache.client.FrontCacheClient
A plugin's raw config on the edge.
GetPluginConfigActionResponse - Class in org.frontcache.io
get-plugin-config: a plugin's conf/<config> as it is on disk (or on the class path), comments and blank lines kept - what the console's Plugin Configs screen shows and edits.
GetPluginConfigActionResponse() - Constructor for class org.frontcache.io.GetPluginConfigActionResponse
 
getPlugins() - Method in class org.frontcache.io.NodeStatsActionResponse
Every plugin the node found, started or not - its manifest's facts, its state and its counters (as of 2.13.0).
getPredicates() - Method in class org.frontcache.bots.BotRule
 
getPredicates() - Method in class org.frontcache.guard.GuardRule
 
getPredicates() - Method in class org.frontcache.io.PluginStats
decide: the names of the ext:<name>: predicates it offers; empty until it starts.
getProcessed() - Method in class org.frontcache.replication.ReplicationResult
Total entries processed so far (transferred + skipped + errors).
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
 
getProvider() - Method in class org.frontcache.guard.GuardAction
 
getPublicDomain() - Method in class org.frontcache.FrontCacheEngine
 
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
 
getReason() - Method in class org.frontcache.io.PluginStats
Why it failed or was refused; null otherwise.
getRefreshType() - Method in class org.frontcache.core.WebResponse
 
getReleaseDate() - Method in class org.frontcache.license.BuildInfo
The day this build was released, or null when the jar carries no build-info.
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
 
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
 
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
 
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
 
getSemaphoreMaxConcurrentRequests() - Method in class org.frontcache.resilience.FcCommandConfig
 
getServed() - Method in class org.frontcache.io.PluginStats
serve: requests its endpoint answered.
getServeFailed() - Method in class org.frontcache.io.PluginStats
serve: requests its endpoint failed - it threw, or wrote more than the node buffers (503).
getServeRefused() - Method in class org.frontcache.io.PluginStats
serve: requests refused before its endpoint - over its concurrency cap (503) or body limit (413).
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
 
getSource() - Method in class org.frontcache.io.PluginStats
getSourceUrl() - Method in class org.frontcache.replication.ReplicationResult
 
getSpec() - Method in class org.frontcache.guard.ratelimit.RateLimitPredicate
 
getState() - Method in class org.frontcache.io.PluginStats
loaded, started, failed, refused, stopped or "not-enabled".
getState() - Method in class org.frontcache.io.ReloadPluginConfigActionResponse
The plugin's state afterwards: started, failed, ...
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
 
getStatusCode() - Method in class org.frontcache.core.WebResponse
 
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
 
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
 
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.
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.
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
 
getVendor() - Method in class org.frontcache.io.PluginStats
 
getVersion() - Method in class org.frontcache.io.PluginStats
 
getVersion() - Method in class org.frontcache.license.BuildInfo
The Frontcache version, or BuildInfo.UNKNOWN_VERSION.
getVisitorType() - Method in class org.frontcache.bots.BotRule
the verdict as written: a root, or a declared type
getVisitorType() - Method in class org.frontcache.core.RequestContext
The request's visitor type: the leaf - a type bots.conf declares (customer) or, when none decided, the root itself.
getVisitorTypeEntries() - Method in class org.frontcache.bots.BotClassifier
Every type this node knows - the two roots, then the declared types in declaration order - each with the hits of the rules whose verdict it is (dry-run rules decide nothing and are left out).
getVisitorTypes() - Method in class org.frontcache.bots.BotClassifier
 
getVisitorTypes() - Method in class org.frontcache.io.GetBotsActionResponse
The roots, then the declared types.
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
 
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
 
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_MATCHED - Static variable in class org.frontcache.plugin.host.FcEventBus
 
GUARD_RULES - Enum constant in enum class org.frontcache.io.ConfigFile
 
GUARD_RULES_CONFIG_FILE - Static variable in class org.frontcache.guard.GuardRuleEngine
 
GUARD_SUMMARY - Static variable in class org.frontcache.plugin.host.FcEventBus
 
GuardAction - Class in org.frontcache.guard
What a matching guard rule does with the request: reject it, redirect it, explicitly let it through (an exemption placed above a broader rule), or challenge it - send the visitor to a challenge provider's page under /fc-x/<plugin>/, which is a redirect that knows which provider it needs (see GuardAction.challenge(String, GuardAction)).
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
 
guardMatched(RequestContext, String, String, int) - Static method in class org.frontcache.plugin.host.CoreEvents
A guard rule acted on a request (rejected / redirected) or matched it as a dry run (status 0).
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
 
GuardRule(String, List, GuardAction, boolean, boolean) - Constructor for class org.frontcache.guard.GuardRule
 
GuardRule(String, List, GuardAction, boolean, boolean, 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
 
GuardRuleParser(Set, VisitorTypes) - Constructor for class org.frontcache.guard.GuardRuleParser
 
GUEST - Static variable in class org.frontcache.bots.ClientSelector
 

H

handle(ManagementRequest) - Method in interface org.frontcache.module.ManagementAction
Deprecated.
 
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, 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.plugin.host.FrontcachePlugins.ConfigReload
Returns a hash code value for this object.
hashCode() - Method in record class org.frontcache.plugin.host.PluginEndpoints.Challenge
Returns a hash code value for this object.
hashCode() - Method in record class org.frontcache.resilience.FcResilienceReload.Result
Returns a hash code value for this object.
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).
holds(RequestContext, String) - Static method in class org.frontcache.core.EvidenceCookies
Whether the request carries a valid, unexpired evidence cookie under name.
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

id() - Method in interface org.frontcache.module.FrontcacheModule
Deprecated.
A short, stable id - for logs and the modules list of get-node-stats.
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.
ids() - Static method in class org.frontcache.plugin.host.FrontcachePlugins
The ids of the started plugins, in load order - get-node-stats' modules.
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.
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
INSTANCE - Static variable in exception class org.frontcache.guard.PredicateUndecided
 
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.
IpLists - Class in org.frontcache.guard
The address lists under conf/lists/ - the ones that change while the node runs.
IpLists.LiveList - Class in org.frontcache.guard
One list as the rules read it.
isA(String, String, String) - Static method in class org.frontcache.bots.VisitorTypes
is-a: a request whose visitor type is visitorType (root clientType) is name when name is the leaf or the root.
isAllowedRedirectTarget(String) - Method in class org.frontcache.guard.GuardRuleEngine
Whether a plugin may send a visitor to target - the rule a guard rule's own redirect target is held to: a path on this site, or an absolute http(s) URL to an allowed redirect host (the site's public name, or front-cache.guard-rules.allowed-redirect-hosts).
isApplied() - Method in class org.frontcache.io.ReloadPluginConfigActionResponse
 
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() - Method in interface org.frontcache.module.ManagementRequest
Deprecated.
ApiKey.isAuthorizedToWrite: stricter than the read gate - it refuses on a node with no API key configured.
isAuthorizedToWrite(HttpServletRequest) - Static method in class org.frontcache.core.ApiKey
The stricter rule, for management calls that WRITE.
isBuiltIn() - Method in class org.frontcache.bots.VisitorTypeEntry
true for a root - bot or guest.
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
 
isConfigured() - Static method in class org.frontcache.core.EdgeToken
 
isConfigured() - Static method in class org.frontcache.core.EvidenceCookies
 
isDeclaration(String) - Static method in class org.frontcache.bots.VisitorTypes
 
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.
isEdgeTokenValid() - Method in class org.frontcache.core.RequestContext
 
isEmpty() - Method in class org.frontcache.core.CidrSet
 
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
 
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
 
isIncludedHeaderToResponse(String) - Static method in class org.frontcache.core.FCUtils
Whether an origin response header is kept - in the response this node sends and in the cache entry it stores.
isIncludeResponseCacheable(WebResponse, RequestContext) - Method in class org.frontcache.include.IncludeProcessorBase
The 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
 
isKnown(String) - Method in class org.frontcache.bots.VisitorTypes
 
isLegacy() - Method in class org.frontcache.io.PluginStats
A pre-2.13 FrontcacheModule without a manifest, run through the deprecated adapter.
isLive(String) - Static method in class org.frontcache.guard.IpLists
Whether a @file name is a live list.
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
 
isNoStore() - Method in class org.frontcache.bots.VisitorTypeEntry
@type <name> like <root> no-store: its requests never write an entry
isNoStore(String) - Method in class org.frontcache.bots.VisitorTypes
 
isNoStoreVisitorType(RequestContext) - Static method in class org.frontcache.core.FCUtils
Is the request's visitor type declared no-store (@type customer like guest no-store)? Such a request never writes an entry - whatever the page's maxage - and it may still read one per its resolved TTL.
isOnErrorAllow() - Method in class org.frontcache.guard.GuardRule
| on-error=allow - see the constructor.
isPing(ActionResponse) - Static method in class org.frontcache.client.FrontCacheClient
Whether response is the ping a node answers an action it does not know with.
isPinned() - Method in class org.frontcache.io.PluginStats
Whether front-cache.plugins.<id>.sha256 pinned its jars (and they matched - else it is refused).
isPluginPredicate() - Method in interface org.frontcache.guard.GuardPredicate
Whether a plugin answers this predicate (ext:, negated or not) - code the node does not own, which may have no answer (PredicateUndecided).
isRequestPath() - Method in class org.frontcache.io.PluginStats
Whether a declared kind runs on the request path (decide / transform / replace) - shown as a badge.
isReserved(String) - Static method in class org.frontcache.plugin.host.PluginEndpoints
 
isRoot(String) - Static method in class org.frontcache.bots.VisitorTypes
 
isRunning() - Static method in class org.frontcache.plugin.host.PluginEndpoints
Whether the plugins have been started (and not stopped) - before that no provider is known yet.
isRunning() - Static method in class org.frontcache.plugin.host.PluginPredicates
Whether the plugins have started - before, an unbound predicate is not an error yet.
isRunning() - Method in class org.frontcache.replication.CacheReplicator
True if a replication run is currently in progress.
isSecure() - Method in interface org.frontcache.module.ManagementRequest
Deprecated.
Whether the management call arrived over TLS, as the container reports it.
isServes() - Method in class org.frontcache.io.PluginStats
serve: whether its endpoint answers /fc-x/<id>/ - false while it is not started.
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
 
isTrap() - Method in class org.frontcache.guard.GuardRule
| trap - see the constructor.
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?
isValid(HttpServletRequest) - Static method in class org.frontcache.core.EdgeToken
 
isWarmRequest() - Method in class org.frontcache.core.RequestContext
 
isWebComponentCacheableForClientType(Map, String) - Static method in class org.frontcache.core.FCUtils
 
isWebComponentCacheableForClientType(Map, String, 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
isWebComponentExpired(Map, String, String) - Static method in class org.frontcache.core.FCUtils
 
isWebComponentSubjectToCache(Map) - Static method in class org.frontcache.core.FCUtils
 
isWritten() - Method in class org.frontcache.io.SetConfigActionResponse
 

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.
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.
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.
loadedIds() - Static method in class org.frontcache.plugin.host.FrontcachePlugins
The ids of every plugin found, for the metrics exporter's per-plugin series.
localPort() - Method in interface org.frontcache.module.ManagementRequest
Deprecated.
The local port the management call arrived on.
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.
logConfiguration(Logger) - Static method in class org.frontcache.core.EdgeToken
Says once, at startup, what this node does with the token - and never what the token is.
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.
logReason(RequestContext, boolean) - Method in class org.frontcache.guard.GuardRule
The reason column of this rule's guard log line: the rule name (<rule>:dry-run for a dry-run match), and the client address this node resolved as <rule>#<address> - for a rate-limit rule that refused the request, and for a trap, acted on or dry-run.
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
 
logServedRequest(String, String, int, long, long, RequestContext) - Static method in class org.frontcache.reqlog.RequestLogger
Logs a request the node answered without cache or origin, under /fc-x/ - a plugin's own path (E2).
logTimeDateFormat - Static variable in class org.frontcache.resilience.FallbackLogger
 
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

managementAction(String) - Static method in class org.frontcache.plugin.host.FrontcachePlugins
The management action a started plugin answers under name, or null.
ManagementAction - Interface in org.frontcache.module
Deprecated.
since 2.13.0: ManagementAction.
managementActionDescriptions() - Static method in class org.frontcache.plugin.host.FrontcachePlugins
Every plugin action's description, by name - for the help action.
managementActionNames() - Static method in class org.frontcache.plugin.host.FrontcachePlugins
The management action names the started plugins answer.
managementActions() - Method in interface org.frontcache.module.FrontcacheModule
Deprecated.
Management actions this module answers, by action name.
ManagementRequest - Interface in org.frontcache.module
Deprecated.
since 2.13.0: ManagementRequest.
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_DECLARED - Static variable in class org.frontcache.bots.VisitorTypes
The most types a bots.conf may declare.
MAX_INCLUDE_LENGHT - Static variable in interface org.frontcache.include.IncludeProcessor
 
MAX_LIMIT - Static variable in class org.frontcache.guard.ratelimit.WindowLimiter
highest limit the packed count can still distinguish from saturation
MAX_NAMES - Static variable in class org.frontcache.bots.VisitorTypeRequests
The most names ever counted in one process.
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
 
MIN_SECRET_LENGTH - Static variable in class org.frontcache.core.EvidenceCookies
 
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
 
modeKnown(NodeMode) - Static method in class org.frontcache.plugin.host.FrontcachePlugins
Called by FrontCacheServlet / FrontCacheFilter as they start - possibly before the engine, so it reaches every loaded plugin rather than only the started ones.
ModuleContext - Interface in org.frontcache.module
Deprecated.
since 2.13.0: PluginContext.
Monotonic, never rolling - Section in class org.frontcache.cache.FcCacheMetrics
 

N

name() - Method in class org.frontcache.guard.IpLists.LiveList
 
NAME - Static variable in class org.frontcache.core.EvidenceCookies
A cookie name the predicate may name: an RFC 6265 token, short.
NAME - Static variable in class org.frontcache.guard.ExtPredicate
A predicate's name, as a plugin's provider names it.
names() - Static method in class org.frontcache.bots.VisitorTypeRequests
 
Never on the request path - Section in interface org.frontcache.module.FrontcacheModule
 
Never relayed - Section in class org.frontcache.core.EdgeToken
 
NO_CACHE - Static variable in interface org.frontcache.cache.CacheProcessor
 
NO_STORE - Static variable in class org.frontcache.bots.VisitorTypes
The one flag a declaration may carry - see VisitorTypes.isNoStore(String).
No answer is not false - Section in class org.frontcache.plugin.host.PluginPredicates
 
NodeMode - Enum Class in org.frontcache.module
Deprecated.
since 2.13.0: NodeMode.
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.
normalizeClientType(String) - Static method in class org.frontcache.warmer.WarmRequest
 
normalizeMode(String) - Static method in class org.frontcache.warmer.WarmRequest
 
noStore() - Method in class org.frontcache.bots.VisitorTypes
 
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
 
Not the api-key - Section in class org.frontcache.core.EdgeToken
 
nowMillis() - Static method in class org.frontcache.guard.ratelimit.WindowLimiter
 

O

of(String...) - Static method in class org.frontcache.bots.VisitorTypes
for tests - a vocabulary from declaration lines, every one of which must be accepted
of(Collection) - Static method in class org.frontcache.core.CidrSet
 
of(List) - Static method in class org.frontcache.bots.BotClassifier
for tests - builds a classifier over an explicit rule list
of(List, VisitorTypes) - Static method in class org.frontcache.bots.BotClassifier
for tests - builds a classifier over an explicit rule list and vocabulary
Off by default - Section in class org.frontcache.metrics.FcMetricsExport
 
ok() - Method in record class org.frontcache.plugin.host.FrontcachePlugins.ConfigReload
Returns the value of the ok record component.
OK - Enum constant in enum class org.frontcache.include.combine.FcCombineMetrics.Batch
A well-formed envelope came back and its parts were applied.
ON_ERROR_ALLOW - Static variable in class org.frontcache.guard.GuardRuleParser
The flag an allow rule naming a plugin's predicate (ext:) must carry: its author has accepted that when the predicate has no answer - the plugin threw, is over its budget, or is absent - the rule does not match, so the exemption does not apply to that request.
onComplete(ReplicationResult) - Method in interface org.frontcache.replication.ReplicationProgressListener
Called when replication completes (successfully, with errors, or cancelled).
One instance per process - Section in interface org.frontcache.module.FrontcacheModule
 
onError(String, Exception) - Method in interface org.frontcache.replication.ReplicationProgressListener
Called when a single entry fails to transfer.
One token per chain, sent and accepted by every node - Section in class org.frontcache.core.EdgeToken
 
onModeKnown(NodeMode) - Method in interface org.frontcache.module.FrontcacheModule
Deprecated.
The servlet or filter has told the node how it is deployed.
onProgress(long, long, long, long) - Method in interface org.frontcache.replication.ReplicationProgressListener
Called after each entry is processed (transferred, skipped, or failed).
On the request path - Section in class org.frontcache.plugin.host.FcEventBus
 
openRawOutput(String, String) - Method in interface org.frontcache.module.ManagementRequest
Deprecated.
Answers with a raw body instead of JSON; the action must then return null.
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.license - package org.frontcache.license
 
org.frontcache.metrics - package org.frontcache.metrics
 
org.frontcache.module - package org.frontcache.module
 
org.frontcache.plugin.host - package org.frontcache.plugin.host
 
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_ERROR - Static variable in class org.frontcache.plugin.host.FcEventBus
 
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.
originError(RequestContext, String, String, int, String, Throwable, long) - Static method in class org.frontcache.plugin.host.CoreEvents
A resilience command's origin call failed.
originStatus(int, String) - Static method in exception class org.frontcache.core.FrontCacheException
The origin answered with a status the node does not serve (outside 2xx-4xx).
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
 

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.
parameter(String) - Method in interface org.frontcache.module.ManagementRequest
Deprecated.
A query-string or form parameter; null when absent.
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, String) - Static method in class org.frontcache.guard.ratelimit.RateLimitSpec
 
parse(String, VisitorTypes) - Static method in class org.frontcache.bots.BotRuleParser
 
parse(String, VisitorTypes) - Static method in class org.frontcache.bots.ClientSelector
 
parse(String, GuardPredicateFactory.Scope) - Static method in class org.frontcache.guard.GuardPredicateFactory
 
parse(String, GuardPredicateFactory.Scope, VisitorTypes) - Static method in class org.frontcache.guard.GuardPredicateFactory
 
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.
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.
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
 
plugin() - Method in record class org.frontcache.plugin.host.PluginEndpoints.Challenge
Returns the value of the plugin record component.
PLUGIN_PREFIX - Static variable in class org.frontcache.io.ConfigWriteAction
The file id of a plugin's config: plugin:<id>.
PLUGIN_STATE_CHANGED - Static variable in class org.frontcache.plugin.host.FcEventBus
 
PluginEndpoints - Class in org.frontcache.plugin.host
E2 Serve: the paths plugins own, /fc-x/<id>/, and the challenge providers they offer.
PluginEndpoints.Challenge - Record Class in org.frontcache.plugin.host
A provider's plugin, and the cookies a pass from it may be under - what the guard's challenge needs.
pluginPredicate() - Method in class org.frontcache.guard.ExtPredicate
 
pluginPredicate() - Method in interface org.frontcache.guard.GuardPredicate
The plugin's predicate this one is, or negates; null for a core predicate.
pluginPredicateRefusals(List) - Static method in class org.frontcache.guard.GuardRuleEngine
What the started plugins say of a rule's ext: predicates - nothing when no plugin has started (the console and the portal parse with none, and a node checks its rules again once its plugins start).
PluginPredicates - Class in org.frontcache.plugin.host
The ext: predicates the started plugins offer (decide, E3), and how a rule's ExtPredicate is answered by one.
PluginStats - Class in org.frontcache.io
One plugin as get-node-stats reports it: what it is (from its manifest), its state, and its counters.
PluginStats() - Constructor for class org.frontcache.io.PluginStats
 
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
 
PredicateUndecided - Exception Class in org.frontcache.guard
Thrown by a predicate that has no answer for this request - a plugin's ext: predicate that threw, is switched off for going over its budget, or that no started plugin offers.
PREFIX - Static variable in class org.frontcache.guard.ExtPredicate
 
PREFIX - Static variable in class org.frontcache.plugin.host.PluginEndpoints
 
presented(HttpServletRequest) - Static method in class org.frontcache.core.ApiKey
The credential the caller presented, or null.
previous() - Static method in class org.frontcache.core.EdgeToken
 
PREVIOUS_EDGE_TOKEN_PROPERTY - Static variable in class org.frontcache.core.EdgeToken
Accepted, never sent - the overlap that lets a fleet rotate without a flag day.
PREVIOUS_SECRET_PROPERTY - Static variable in class org.frontcache.core.EvidenceCookies
 
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.
propagatedVisitorType(RequestContext, String) - Static method in class org.frontcache.core.FCUtils
The visitor type (the leaf) decided for the PAGE, on a request whose client type (the root) was adopted by FCUtils.propagatedClientType(RequestContext) - so the peer is trusted and the request is an include; this adds only that the leaf must be a type this node declares on the same root.
property(String) - Method in interface org.frontcache.module.ModuleContext
Deprecated.
A property of frontcache.properties, read-only; null when unset.
property(String) - Method in interface org.frontcache.plugin.host.BundledPluginContext
A property of frontcache.properties, read-only; null when unset.
publicDomain() - Method in interface org.frontcache.module.ModuleContext
Deprecated.
The site's public hostname (front-cache.default-domain), or null when the node has none configured - never the placeholder.
publish(String, List, File) - Static method in class org.frontcache.guard.IpLists
writeList's last step: the file was replaced, and this is what it now holds.
publish(FcEvent) - Static method in class org.frontcache.plugin.host.FcEventBus
Offers the event to every subscriber of its type; never blocks.
publish(FcEvent, double) - Static method in class org.frontcache.plugin.host.FcEventBus
Offers a sampled event to every subscriber of its type whose share is above draw; never blocks.
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
 
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
 

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
 
RATE_LIMIT_EXCEEDED - Static variable in class org.frontcache.plugin.host.FcEventBus
 
rateLimitExceeded(RequestContext, String, String, int, long, String) - Static method in class org.frontcache.plugin.host.CoreEvents
A client crossed a bucket's limit - called once per client per window, by the rate-limit predicate.
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.
readOnDisk(File) - Static method in class org.frontcache.io.ConfigFileStore
The file's current content, or "" when it does not exist yet.
Read per call - Section in class org.frontcache.core.EdgeToken
 
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.
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
Rebuilds the engine - the reload management action.
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_PLUGIN_CONFIG - Static variable in class org.frontcache.io.FrontcacheAction
Re-reads a plugin's conf/<config> and hands it to the plugin - plugin=<id>.
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
 
reloadConfig(String) - Static method in class org.frontcache.plugin.host.FrontcachePlugins
reload-plugin-config: re-reads a plugin's conf/<config>.
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
 
reloadPluginConfig(String) - Method in class org.frontcache.client.FrontCacheClient
Re-reads a plugin's config on the edge - reload-plugin-config?plugin=<id>: the file already on the node's disk, applied (a running plugin keeps the config it had when it refuses the new one; one whose last start failed on its config is started).
ReloadPluginConfigActionResponse - Class in org.frontcache.io
reload-plugin-config: what re-reading a plugin's conf/<config> did.
ReloadPluginConfigActionResponse() - Constructor for class org.frontcache.io.ReloadPluginConfigActionResponse
 
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_COMPLETED - Static variable in class org.frontcache.plugin.host.FcEventBus
 
requestCompleted(RequestContext, boolean, String, long, long) - Static method in class org.frontcache.plugin.host.CoreEvents
A request was logged.
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.
requests(String) - Static method in class org.frontcache.bots.VisitorTypeRequests
 
requestSample() - Static method in class org.frontcache.plugin.host.FcEventBus
The largest share of requests a subscriber wants as RequestCompleted; 0 when none does.
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.
reset() - Static method in class org.frontcache.bots.VisitorTypeRequests
for tests
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.
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.
Result(String, List) - Constructor for record class org.frontcache.resilience.FcResilienceReload.Result
Creates an instance of a Result record class.
RESULT_FALLBACK - Static variable in class org.frontcache.warmer.WarmRequest
 
RESULT_FRESH - Static variable in class org.frontcache.warmer.WarmRequest
 
RESULT_NOT_CACHEABLE - Static variable in class org.frontcache.warmer.WarmRequest
 
RESULT_STORED - Static variable in class org.frontcache.warmer.WarmRequest
 
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
rootOf(String) - Method in class org.frontcache.bots.VisitorTypes
 
ROOTS - Static variable in class org.frontcache.bots.VisitorTypes
No declarations - the two roots only.
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.

S

Sampled events - Section in class org.frontcache.plugin.host.FcEventBus
 
scrape() - Static method in class org.frontcache.metrics.FcMetricsExport
 
SECRET_PROPERTY - Static variable in class org.frontcache.core.EvidenceCookies
 
selects(String, String) - Method in class org.frontcache.bots.ClientSelector
 
SEMAPHORE - Enum constant in enum class org.frontcache.resilience.FcCommandConfig.Isolation
 
SEMAPHORE_REJECTED - Enum constant in enum class org.frontcache.resilience.FcEventType
 
serve(RequestContext, Predicate) - Static method in class org.frontcache.plugin.host.PluginEndpoints
Answers a request under "/fc-x/".
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
 
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.ReloadPluginConfigActionResponse
 
setApplied(boolean) - Method in class org.frontcache.io.SetConfigActionResponse
 
setBackupDir(String) - Method in class org.frontcache.io.BackupActionResponse
 
setBackupFile(String) - Method in class org.frontcache.io.SetConfigActionResponse
 
setBase(String) - Method in class org.frontcache.bots.VisitorTypeEntry
 
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.
setBotsConfig(String) - Method in class org.frontcache.io.GetBotsConfigActionResponse
 
setCachedEntries(long) - Method in class org.frontcache.io.NodeStatsActionResponse
 
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
 
setChallenges(List) - Method in class org.frontcache.io.PluginStats
 
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
Sets the client type to a root, and the visitor type with it - see RequestContext.setVisitorType(String, String).
setClientTypeRule(String) - Method in class org.frontcache.core.RequestContext
 
setCombine(Object) - Method in class org.frontcache.tags.IncludeTag
combine="true", or a group name.
setCondition(String) - Method in class org.frontcache.bots.BotRuleEntry
 
setCondition(String) - Method in class org.frontcache.guard.GuardRuleEntry
 
setConfig(String) - Method in class org.frontcache.io.PluginStats
 
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
 
setConfigErrors(List) - Method in class org.frontcache.io.PluginStats
 
setConfigLoaded(long) - Method in class org.frontcache.io.PluginStats
 
setConfigStatus(String) - Method in class org.frontcache.io.PluginStats
 
setContent(byte[]) - Method in class org.frontcache.core.WebResponse
 
setCookies(List) - Method in class org.frontcache.io.PluginStats
 
setCpuProcessLoad(double) - Method in class org.frontcache.io.NodeStatsActionResponse
 
setCurrentContent(String) - Method in class org.frontcache.io.SetConfigActionResponse
 
setCurrentRequestURL(String) - Method in class org.frontcache.core.RequestContext
 
setDecideBudgetMicros(long) - Method in class org.frontcache.io.PluginStats
 
setDecideCalls(long) - Method in class org.frontcache.io.PluginStats
 
setDecideErrors(long) - Method in class org.frontcache.io.PluginStats
 
setDecideP99Micros(double) - Method in class org.frontcache.io.PluginStats
 
setDecideReason(String) - Method in class org.frontcache.io.PluginStats
 
setDecideRetryAt(long) - Method in class org.frontcache.io.PluginStats
 
setDecideState(String) - Method in class org.frontcache.io.PluginStats
 
setDecideSwitchedOff(long) - Method in class org.frontcache.io.PluginStats
 
setDirectory(String) - Method in class org.frontcache.io.PluginStats
 
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
 
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
setDynamicURLsConfig(String) - Method in class org.frontcache.io.GetDynamicURLsConfigActionResponse
 
setEdgeTokenValid(boolean) - Method in class org.frontcache.core.RequestContext
The request carried this node's front-cache.edge-token - it came from a Frontcache of the same chain, not straight from a client.
setErrors(long) - Method in class org.frontcache.io.PluginStats
 
setErrors(long) - Method in class org.frontcache.replication.ReplicationResult
 
setErrors(List) - Method in class org.frontcache.io.ReloadPluginConfigActionResponse
 
setEventsDelivered(long) - Method in class org.frontcache.io.PluginStats
 
setEventsDropped(long) - Method in class org.frontcache.io.PluginStats
 
setExpireTimeMap(Map) - Method in class org.frontcache.core.WebResponse
 
setFallbackConfigs(Map) - Method in class org.frontcache.io.GetFallbackConfigActionResponse
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.GetPluginConfigActionResponse
 
setFile(String) - Method in class org.frontcache.io.ReloadPluginConfigActionResponse
 
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
 
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
 
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.bots.VisitorTypeEntry
 
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
setId(String) - Method in class org.frontcache.io.PluginStats
 
setIncludeLevel(String) - Method in class org.frontcache.core.RequestContext
 
setInitUrl(String) - Method in class org.frontcache.resilience.fr.FallbackConfigEntry
 
setJars(List) - Method in class org.frontcache.io.PluginStats
 
setKey(String) - Method in class org.frontcache.io.GetFromCacheActionResponse
 
setKey(String) - Method in class org.frontcache.io.PutToCacheActionResponse
 
setKinds(List) - Method in class org.frontcache.io.PluginStats
 
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
 
setLegacy(boolean) - Method in class org.frontcache.io.PluginStats
 
setLevel(String) - Method in class org.frontcache.tags.WebComponentTag
 
setLicense(String) - Method in class org.frontcache.io.PluginStats
 
setLogToHTTPHeaders() - Method in class org.frontcache.core.RequestContext
 
setMaxage(String) - Method in class org.frontcache.tags.WebComponentTag
 
setModules(List) - Method in class org.frontcache.io.NodeStatsActionResponse
 
setName(String) - Method in class org.frontcache.bots.BotRuleEntry
 
setName(String) - Method in class org.frontcache.bots.VisitorTypeEntry
 
setName(String) - Method in class org.frontcache.guard.GuardRuleEntry
 
setName(String) - Method in class org.frontcache.io.PluginStats
 
setNoStore(boolean) - Method in class org.frontcache.bots.VisitorTypeEntry
 
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
setOriginURL(URL) - Method in class org.frontcache.core.RequestContext
 
setOutputFile(String) - Method in class org.frontcache.io.DumpKeysActionResponse
 
setParts(List) - Method in class org.frontcache.include.combine.CombineEnvelope
 
setPatternCount(int) - Method in class org.frontcache.io.ReloadDynamicUrlsActionResponse
 
setPinned(boolean) - Method in class org.frontcache.io.PluginStats
 
setPlugin(String) - Method in class org.frontcache.io.GetPluginConfigActionResponse
 
setPlugin(String) - Method in class org.frontcache.io.ReloadPluginConfigActionResponse
 
setPluginApi(int) - Method in class org.frontcache.io.PluginStats
 
setPluginConfig(String) - Method in class org.frontcache.io.GetPluginConfigActionResponse
 
setPluginConfig(String, String, String, String, boolean) - Method in class org.frontcache.client.FrontCacheClient
Writes a plugin's config on the edge and applies it - set-config with file=plugin:<id>, so every gate of FrontCacheClient.setConfig(ConfigFile, String, String, boolean) applies.
setPlugins(List) - Method in class org.frontcache.io.NodeStatsActionResponse
 
setPredicates(List) - Method in class org.frontcache.io.PluginStats
 
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
 
setReason(String) - Method in class org.frontcache.io.PluginStats
 
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
 
setRequestPath(boolean) - Method in class org.frontcache.io.PluginStats
 
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
setResponseStatusCode(int) - Method in class org.frontcache.core.RequestContext
Use this instead of response.setStatusCode()
setServed(long) - Method in class org.frontcache.io.PluginStats
 
setServeFailed(long) - Method in class org.frontcache.io.PluginStats
 
setServeRefused(long) - Method in class org.frontcache.io.PluginStats
 
setServes(boolean) - Method in class org.frontcache.io.PluginStats
 
setSkipped(long) - Method in class org.frontcache.replication.ReplicationResult
 
setSource(String) - Method in class org.frontcache.io.PluginStats
 
setSourceUrl(String) - Method in class org.frontcache.replication.ReplicationResult
 
setState(String) - Method in class org.frontcache.io.PluginStats
 
setState(String) - Method in class org.frontcache.io.ReloadPluginConfigActionResponse
 
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
 
setTags(String) - Method in class org.frontcache.tags.WebComponentTag
 
setTags(Set) - Method in class org.frontcache.core.WebResponse
 
setTargetUrl(String) - Method in class org.frontcache.replication.ReplicationResult
 
setThrowable(Throwable) - Method in class org.frontcache.core.RequestContext
sets a throwable
setToplevelCached() - Method in class org.frontcache.core.RequestContext
 
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
 
setVendor(String) - Method in class org.frontcache.io.PluginStats
 
setVersion(String) - Method in class org.frontcache.io.PluginStats
 
setVisitorType(String, String) - Method in class org.frontcache.core.RequestContext
 
setVisitorTypes(List) - Method in class org.frontcache.io.GetBotsActionResponse
 
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
 
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
 
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.
sign(String, long, String, String, String) - Static method in class org.frontcache.core.EvidenceCookies
 
size() - Method in class org.frontcache.core.CidrSet
How many blocks it was built from.
size() - Method in class org.frontcache.guard.IpLists.LiveList
 
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
 
SOURCE_BUNDLED - Static variable in class org.frontcache.io.PluginStats
PluginStats.getSource(): on the core's class path - the war's WEB-INF/lib, a filter-mode application's.
SOURCE_DROPPED_IN - Static variable in class org.frontcache.io.PluginStats
PluginStats.getSource(): from the node's plugin directory, FRONTCACHE_HOME/plugins/<id>/.
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
 
stamp(HttpRequest, String) - Static method in class org.frontcache.core.EdgeToken
Puts this node's token on an outgoing request - but only one addressed to front-cache.origin-host.
STANDALONE - Enum constant in enum class org.frontcache.module.NodeMode
Deprecated.
 
start() - Static method in class org.frontcache.metrics.FcMetricsExport
Starts the exporter if configured.
start(String, Supplier) - Static method in class org.frontcache.plugin.host.FrontcachePlugins
Starts every plugin; called by the engine on each start, reload included.
start(ModuleContext) - Method in interface org.frontcache.module.FrontcacheModule
Deprecated.
The engine has started: the cache processor exists, metrics export has not been started yet.
START_MARKER - Static variable in class org.frontcache.include.IncludeProcessorBase
 
state() - Method in record class org.frontcache.plugin.host.FrontcachePlugins.ConfigReload
Returns the value of the state record component.
STATE_NOT_ENABLED - Static variable in class org.frontcache.io.PluginStats
PluginStats.getState(): a plugin directory that front-cache.plugins does not list - found, not loaded.
stats() - Static method in class org.frontcache.plugin.host.FrontcachePlugins
Every plugin found, started or not - get-node-stats' plugins.
stats(String) - Static method in class org.frontcache.plugin.host.FrontcachePlugins
One plugin's stats by id, read at scrape time; null when there is none.
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(boolean) - Method in interface org.frontcache.module.FrontcacheModule
Deprecated.
 
stop(boolean) - Static method in class org.frontcache.plugin.host.FrontcachePlugins
 
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
 
terminal(GuardRule, GuardAction, String, List) - Static method in class org.frontcache.guard.GuardOutcome
 
test(RequestContext) - Method in class org.frontcache.guard.ExtPredicate
 
test(RequestContext) - Method in interface org.frontcache.guard.GuardPredicate
 
test(RequestContext) - Method in class org.frontcache.guard.ratelimit.RateLimitPredicate
 
test(ExtPredicate, RequestContext) - Static method in class org.frontcache.plugin.host.PluginPredicates
ExtPredicate.test(RequestContext): asks the plugin, timed against its budget.
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 headers must never reach the origin - Section in class org.frontcache.warmer.WarmRequest
 
The idle handoff - Section in class org.frontcache.resilience.stream.FcSampleSseServlet
 
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 prefix is reserved - Section in class org.frontcache.plugin.host.PluginEndpoints
 
The property was front-cache.site-key through 2.8 - Section in class org.frontcache.core.ApiKey
 
The secret - Section in class org.frontcache.core.EvidenceCookies
 
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)
 
The value - Section in class org.frontcache.core.EvidenceCookies
 
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
 
token() - Static method in class org.frontcache.warmer.WarmRequest
The token the warmer presents.
toString() - Method in class org.frontcache.bots.BotRule
 
toString() - Method in class org.frontcache.bots.BotRuleEntry
 
toString() - Method in class org.frontcache.bots.ClientSelector
 
toString() - Method in class org.frontcache.bots.VisitorTypeEntry
 
toString() - Method in class org.frontcache.bots.VisitorTypes
 
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.license.BuildInfo
 
toString() - Method in record class org.frontcache.plugin.host.FrontcachePlugins.ConfigReload
Returns a string representation of this record class.
toString() - Method in record class org.frontcache.plugin.host.PluginEndpoints.Challenge
Returns a string representation of this record class.
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.
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.
TRAP - Static variable in class org.frontcache.guard.GuardRuleParser
The flag of a honeypot rule - a path no visitor is ever sent to, whose fetch identifies the client: the rule matches a client's request only, never an include, and its log line names the address this node resolved (GuardRule.logReason(RequestContext, boolean)).
TRUSTED_PROXIES_PROPERTY - Static variable in class org.frontcache.core.ClientIpResolver
 
ttl(Map, String, String) - Static method in class org.frontcache.bots.VisitorTypes
The expireTimeMap value that applies to a request: the leaf's if the entry names it, else the root's.
Tuning(double, double, long, boolean, long) - Constructor for class org.frontcache.cache.impl.LuceneIndexManager.Tuning
 
Two behavior changes - 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_VERSION - Static variable in class org.frontcache.license.BuildInfo
 
Unknown is a value - Section in class org.frontcache.cache.CacheStats
 
Unknown is a value - Section in class org.frontcache.license.BuildInfo
 
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.
uri(RequestContext) - Static method in class org.frontcache.plugin.host.CoreEvents
host + path + query, as the guard log line writes it, truncated.
URL_FIELD - Static variable in class org.frontcache.cache.impl.LuceneIndexManager
 
urlPattern - Variable in class org.frontcache.resilience.fr.FallbackConfigEntry
 

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(ExtPredicate) - Static method in class org.frontcache.plugin.host.PluginPredicates
What set-config asks of a guard-rules.conf it is about to write: whether a started plugin offers the name and accepts the argument.
validate(ConfigFile, String) - Static method in class org.frontcache.io.ConfigFileValidator
 
validateConfig(String, String) - Static method in class org.frontcache.plugin.host.FrontcachePlugins
Whether a config the caller wants to write would be accepted: it parses, resolves, and the plugin's FrontcachePlugin.validateConfig(Config) accepts it.
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.module.NodeMode
Deprecated.
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.
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.module.NodeMode
Deprecated.
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.
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.
VisitorTypeEntry - Class in org.frontcache.bots
Wire/DTO view of one visitor type a node knows - a root (bot, guest) or a type bots.conf declares - for get-bots' visitorTypes (2.13.0) and the console's types table.
VisitorTypeEntry() - Constructor for class org.frontcache.bots.VisitorTypeEntry
 
VisitorTypeEntry(String, String, boolean, long) - Constructor for class org.frontcache.bots.VisitorTypeEntry
 
VisitorTypeRequests - Class in org.frontcache.bots
Top-level requests by visitor type (the leaf), counted where the type is decided - what the exporter reports as frontcache_visitor_requests_total{type} (2.13.0).
VisitorTypes - Class in org.frontcache.bots
The visitor types a node knows: the two roots, bot and guest, and the types bots.conf declares with @type <name> like <bot|guest> - at most 16, each based on a root.
VisitorTypes.Builder - Class in org.frontcache.bots
Builds a vocabulary from @type lines, refusing each bad one alone - the file's rule: one bad line costs that line.

W

wants(long) - Static method in class org.frontcache.plugin.host.FcEventBus
Whether any listener subscribed to the event type with this bit - check it before building the event.
WARM_REQUEST - Static variable in class org.frontcache.resilience.FcCommandKeys
The cache warmer's loopback request - see org.frontcache.warmer.WarmRequest.
WarmRequest - Class in org.frontcache.warmer
What makes a request a warm request, and the vocabulary a warm request is answered in.
warmRequestToken() - Method in interface org.frontcache.module.ModuleContext
Deprecated.
The in-memory token a warm request presents in x-frontcache-warm - see org.frontcache.warmer.WarmRequest.
warmRequestToken() - Method in interface org.frontcache.plugin.host.BundledPluginContext
The in-memory token a warm request presents in x-frontcache-warm - see org.frontcache.warmer.WarmRequest.
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 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
 
Where it is enforced - Section in class org.frontcache.core.EdgeToken
 
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 release date at all - Section in class org.frontcache.license.BuildInfo
 
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 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 host check - Section in org.frontcache.core.EdgeToken.stamp(HttpRequest, String)
 
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
 
withDefaultBucket(String) - Method in class org.frontcache.guard.ratelimit.RateLimitSpec
 
withGroupKey(String) - Static method in class org.frontcache.resilience.FcCommand.Setter
 
write(File, String) - Static method in class org.frontcache.io.ConfigFileStore
Replaces the file's content atomically.
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_EDGE_TOKEN - Static variable in class org.frontcache.core.FCHeaders
The chain's shared secret, on every origin call a node with front-cache.edge-token makes - see org.frontcache.core.EdgeToken.
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_VISITOR_TYPE - Static variable in class org.frontcache.core.FCHeaders
The visitor type the node serving the PAGE decided - the leaf, a type bots.conf declares, beside its root in FCHeaders.X_FRONTCACHE_CLIENT_TYPE - on an <fc:include> fetch, and so also what the origin sees.
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