All Classes and Interfaces
Class
Description
The Apache-backed
FcHttpClient.The
front-cache.api-key check, in one place.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.One classification rule from conf/bots.conf: name | condition | verdict [| dry-run].
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.Parses one line of conf/bots.conf.
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).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.Replicates cache entries from a source edge to a target edge.
A cheap size-and-churn snapshot of a cache processor, for the metrics exporter.
An address block, compared on raw address bytes so v4 and v6 never match each other.
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.Resolves the client IP address that rate limiting counts against.
The
client="..." attribute of an <fc:include>: which visitors the fragment is resolved for.The combined response: one part per requested member, in the order the members were sent.
One member's answer inside a
CombineEnvelope.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.
The origin's half of the combine contract: read a combined request.
The origin's half of the combine contract: build and write the response envelope.
Remembers, per batch group, that the origin does not implement combining.
Processing URL example invalid input: '<'fc:include url="/some/url/here" />
The config files the management API will write, and the only names
set-config accepts.Reads, hashes, backs up and atomically replaces a config file under FRONTCACHE_HOME/conf.
Dry-parses a candidate config file before
set-config writes it.What
set-config actually does, with no HttpServletRequest in sight.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.The
front-cache.edge-token - how a second-layer node tells a request from its own edge
apart from one that reached it directly.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.ext:<name>[:<argument>] - a condition a started plugin offers (decide, E3).Marker for Logger
Resolves the canned response served when an origin call fails or its circuit is open.
All GET requests which flows through cache (cached invalid input: '&' not)
All requests through Frontcache engine
Must use SEMAPHORE to access the same thread
Replaces
com.netflix.hystrix.exception.HystrixBadRequestException: the caller asked for
something invalid, so the failure says nothing about the health of the dependency.Cache read outcomes, counted per tier.
Where a cache read was answered from, or that it was not.
Combine-and-reduce outcomes, counted per batch and per member.
How a combined origin call ended.
Why an envelope was rejected.
How one combine candidate was ultimately resolved.
The seam.
Mirrors
HystrixCommand.Setter so the constructor bodies of the five commands change by
one type name and nothing else.The resolved settings for one command key, read from conf/resilience.properties by
FcResilienceConfig and translated to Resilience4j configs here.Replaces
com.netflix.hystrix.exception.HystrixRuntimeException: thrown out of
FcCommand.execute() when the command failed AND the fallback could not supply a value.The command keys, in one place.
Rolling metrics for one command, shaped to the Hystrix dashboard JSON rather than to Resilience4j's
data model.
The mean and the nine percentiles, read from ONE merge of the bucket ring.
Serializes
FcCommandMetrics and FcThreadPools into the Hystrix dashboard's JSON,
replacing SerialHystrixDashboardData.The E1 event bus: where the node hands events to the plugins that observe it.
Execution outcomes of an
FcCommand, replacing com.netflix.hystrix.HystrixEventType.Frontcache's own origin-fetch abstraction - the extension points' view of "go get this URL".
Prometheus / OTLP export, additive alongside the SSE stream.
The Prometheus scrape endpoint,
/fc-metrics.A cheap snapshot of the JVM this node runs in: heap, process CPU, uptime.
Reads conf/resilience.properties into plain
Properties and resolves per-command settings from
it, replacing the Archaius ConfigurationManager.install() path.Holds the Resilience4j registries, keyed by command key.
Applies an edited conf/resilience.properties to a running node, for the
reload-resilience management action.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.The named thread pools Frontcache owns, replacing
HystrixThreadPool.Deprecated.
The node's plugins - found once per process, started and stopped with the engine.
What
FrontcachePlugins.reloadConfig(String) did.Bot classification config from ./conf/bots.conf: the ordered rules, and the bare User-Agent
keywords.
The raw ./conf/bots.conf of one node, for the console's Bot Configs screen.
URL patterns that are never cached, from ./conf/dynamic-urls.conf.
The raw ./conf/dynamic-urls.conf of one node, for the console's Dynamic URLs screen.
URL-pattern to fallback-file mappings from ./conf/fallbacks.conf.
The raw ./conf/fallbacks.conf of one node, for the console's Fallback Config screen.
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.
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.Raw content of ./conf/resilience.properties (comments and empty lines preserved), for display in
the console.
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)).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).
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.
One condition of a guard rule (e.g.
Parses a single predicate expression from guard-rules.conf into a
GuardPredicate.Which config file a predicate is being parsed for.
Holds the
WindowLimiter of every rate-limit bucket, keyed by bucket name.A guard rule: name | condition | action.
Runs the guard rules for every request, before cache and origin.
Wire/DTO view of a
GuardRule - what the management API (get-guard-rules) returns and the
console renders.Parses one line of guard-rules.conf into a
GuardRule.Wrapper for response
Processing URL example invalid input: '<'fc:include url="/some/url/here" />
Processing URL example invalid input: '<'fc:include url="/some/url/here" />
The address lists under
conf/lists/ - the ones that change while the node runs.One list as the rules read it.
Cache processor based on
L1 - ehCache.
Provides access to lucene index.
Everything about this index that an operator can tune, in one object so adding a knob does not
add a positional constructor argument.
Deprecated.
since 2.13.0:
ManagementAction.Deprecated.
since 2.13.0:
ManagementRequest.Deprecated.
since 2.13.0:
PluginContext.Deprecated.
since 2.13.0:
NodeMode.The cheap, pollable view of a node: cache sizes and the JVM they live in.
E2 Serve: the paths plugins own,
/fc-x/<id>/, and the challenge providers they offer.A provider's plugin, and the cookies a pass from it may be under - what the guard's challenge needs.
The
ext: predicates the started plugins offer (decide, E3), and how a rule's ExtPredicate is
answered by one.One plugin as
get-node-stats reports it: what it is (from its manifest), its state, and its counters.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.Response for the
put-to-cache IO action.The
rate: predicate - true when this request's client IP has already used up its budget
for the current window.The parsed form of a
rate: predicate, computed once at load time.The outcome of
reload-dynamic-urls: how many patterns are now active.reload-plugin-config: what re-reading a plugin's conf/<config> did.The outcome of
reload-resilience.Callback interface for receiving progress updates during cache replication.
Immutable snapshot of a replication run.
The Request Context holds request, response, state information and data to access and share.
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.
What
set-config did, or refused to do.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.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).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.Builds a vocabulary from
@type lines, refusing each bad one alone - the file's rule: one bad line costs
that line.What makes a request a warm request, and the vocabulary a warm request is answered in.
Container for web response.
Fixed-window request counter: how many requests one key sent inside the current measurement slot.
FrontcachePluginand ship aMETA-INF/frontcache-plugin.propertiesmanifest.