Class FrontcacheAction
java.lang.Object
org.frontcache.io.FrontcacheAction
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final Stringstatic final Stringstatic final StringThe raw conf/bots.conf, asGET_GUARD_CONFIGis toGET_GUARD_RULES: this one returns the file,GET_BOTSreturns what the node parsed out of it.static final Stringstatic final Stringstatic final Stringstatic final StringThe raw conf/dynamic-urls.conf, asGET_GUARD_CONFIGis toGET_GUARD_RULES: this one returns the file,GET_DYNAMIC_URLSreturns the patterns parsed from it.static final Stringstatic final StringThe raw conf/fallbacks.conf, asGET_GUARD_CONFIGis toGET_GUARD_RULES: this one returns the file,GET_FALLBACK_CONFIGSreturns the entries parsed from it.static final Stringstatic final Stringstatic final Stringstatic final StringDeprecated.static final StringThe cheap, pollable companion ofGET_CACHE_STATE: typed cache sizes plus the JVM's heap, CPU and uptime, all read from state the process already holds.static final StringA plugin'sconf/<config>, raw -plugin=<id>.static final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final StringRe-reads ./conf/dynamic-urls.conf.static final Stringstatic final Stringstatic final StringRe-reads a plugin'sconf/<config>and hands it to the plugin -plugin=<id>.static final StringRe-reads ./conf/resilience.properties and applies what can be applied without a restart.static final StringWrites one config file and (unlessapply=false) applies it - the console's Configs screens save through this. -
Constructor Summary
Constructors -
Method Summary
-
Field Details
-
INVALIDATE
- See Also:
-
DUMP_KEYS
- See Also:
-
GET_FALLBACK_CONFIGS
- See Also:
-
GET_FALLBACKS_CONFIG
The raw conf/fallbacks.conf, asGET_GUARD_CONFIGis toGET_GUARD_RULES: this one returns the file,GET_FALLBACK_CONFIGSreturns the entries parsed from it. The two spellings are one letter apart and mean different things. The older one is plural because it counts ENTRIES; the plural here belongs to the file name.- See Also:
-
RELOAD_FALLBACKS
- See Also:
-
GET_CACHE_STATE
- See Also:
-
GET_NODE_STATS
The cheap, pollable companion ofGET_CACHE_STATE: typed cache sizes plus the JVM's heap, CPU and uptime, all read from state the process already holds.get-cache-stateopens a Lucene reader per call, which is fine for a console page and wrong for a poll loop.- See Also:
-
GET_CACHED_KEYS
- See Also:
-
GET_FROM_CACHE
- See Also:
-
PUT_TO_CACHE
- See Also:
-
GET_BOTS
- See Also:
-
GET_BOTS_CONFIG
The raw conf/bots.conf, asGET_GUARD_CONFIGis toGET_GUARD_RULES: this one returns the file,GET_BOTSreturns what the node parsed out of it.- See Also:
-
RELOAD_BOTS
- See Also:
-
GET_DYNAMIC_URLS
- See Also:
-
GET_DYNAMIC_URLS_CONFIG
The raw conf/dynamic-urls.conf, asGET_GUARD_CONFIGis toGET_GUARD_RULES: this one returns the file,GET_DYNAMIC_URLSreturns the patterns parsed from it.- See Also:
-
GET_RESILIENCE_CONFIGS
- See Also:
-
GET_HYSTRIX_CONFIGS
Deprecated.sendGET_RESILIENCE_CONFIGSinsteadPre-2.7 spelling ofGET_RESILIENCE_CONFIGS, still accepted. The console is deployed separately from the nodes it reads, so a 2.6 console asking a 2.7 node has to keep working - an unrecognized action answers with a ping response, which would render the panel empty with no error. Kept until no supported console predates 2.7.- See Also:
-
GET_GUARD_RULES
- See Also:
-
GET_GUARD_CONFIG
- See Also:
-
RELOAD_GUARD_RULES
- See Also:
-
SET_CONFIG
Writes one config file and (unlessapply=false) applies it - the console's Configs screens save through this. One action for all five files, and thefileparameter is a logical id, never a path or a file name -resilience,guard-rules,bots,dynamic-urls,fallbacks. The read side has five actions because each returns a differently-named field for wire-format reasons that predate the current shape; the write side has one uniform outcome, so five actions would be one operation spelled five times. And a caller-supplied file name - even one checked for..- is how this becomes an arbitrary file write on a node, so it is not accepted at all. Unlike every other action here this one refuses a node with no API key configured, whereApiKey.isAuthorizedallows it. SeeApiKey.isAuthorizedToWrite.- See Also:
-
RELOAD_RESILIENCE
Re-reads ./conf/resilience.properties and applies what can be applied without a restart. New because there was no way to apply that file at all: it is read once into a cached singleton and two further caches are built from it. SeeFcResilienceReload.- See Also:
-
RELOAD_DYNAMIC_URLS
Re-reads ./conf/dynamic-urls.conf. New for the same reason: the file is read by FCConfig's static initializer, and thereloadaction does NOT re-read it (the FCConfig.init() call in FrontCacheEngine is commented out), so adding a pattern meant restarting the node.- See Also:
-
GET_PLUGIN_CONFIG
A plugin'sconf/<config>, raw -plugin=<id>. Its file name comes from the plugin's manifest, never from the caller.- See Also:
-
RELOAD_PLUGIN_CONFIG
Re-reads a plugin'sconf/<config>and hands it to the plugin -plugin=<id>. A running plugin keeps the config it had when it refuses the new one; one whose start failed on its config is started.- See Also:
-
PATCH
- See Also:
-
PURGE
- See Also:
-
BACKUP_INDEX
- See Also:
-
PING
- See Also:
-
HELP
- See Also:
-
actionsDescriptionMap
-
-
Constructor Details
-
FrontcacheAction
public FrontcacheAction()
-
GET_RESILIENCE_CONFIGSinstead