Class WarmerActions

java.lang.Object

org.frontcache.io.WarmerActions

public class WarmerActions
extends Object

The cache warmer's management actions, with no HttpServletRequest in sight - the ConfigWriteAction arrangement, for the same reason: the gates are what matter here, and they are testable without a servlet container. FrontCacheIOServlet does the parameter extraction and the ApiKey verdict.

The gates, in order

1. front-cache.warmer.enabled=false refuses everything except warmer-status and warmer-lists;
2. everything that starts, changes or writes needs ApiKey.isAuthorizedToWrite - a configured API key, where isAuthorized lets an un-keyed node through;
3. front-cache.warmer.list-write=false refuses the list-writing actions only. That is the setting for a fleet whose warmer/ is deployed from git or an image, and it is separate from front-cache.management.config-write on purpose: such a fleet commonly locks its config and still wants to upload a list.

Method Summary

Modifier and Type	Method	Description
static WarmerListActionResponse	deleteList(CacheWarmer warmer, String name, boolean authorizedToWrite)
static WarmerListActionResponse	getList(CacheWarmer warmer, String name, String grep)
static WarmerListsActionResponse	lists(CacheWarmer warmer)
static String	loopbackTarget(WarmerConfig config, int localPort)	Where warm requests go: front-cache.warmer.loopback-url if it is set, otherwise http://127.0.0.1:<the local port the management request arrived on> - the connector the management API was reached on, which in every shipped topology is the one traffic uses.
static WarmerStatusActionResponse	pause(CacheWarmer warmer, boolean authorizedToWrite)
static WarmerPreflightActionResponse	preflight(CacheWarmer warmer, WarmerRunParams params, boolean requestSecure, int localPort, CacheProcessor processor)
static WarmerListActionResponse	putList(CacheWarmer warmer, String name, InputStream body, String baseHash, boolean authorizedToWrite)
static String	rawListProblem(CacheWarmer warmer, String name)
static WarmerStatusActionResponse	resume(CacheWarmer warmer, boolean authorizedToWrite)
static WarmerStatusActionResponse	start(CacheWarmer warmer, WarmerRunParams params, boolean requestSecure, int localPort, boolean authorizedToWrite)
static WarmerStatusActionResponse	status(CacheWarmer warmer)
static WarmerStatusActionResponse	stop(CacheWarmer warmer, boolean authorizedToWrite)
static WarmerStatusActionResponse	update(CacheWarmer warmer, Long delayMs, Integer concurrency, boolean authorizedToWrite)
static ActionResponse	withRequestDefaults(ActionResponse response, WarmerConfig config, boolean requestSecure)	Sets the default key base a status response offers the Run form to the one this request implies.

Methods inherited from class Object

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

Method Details

loopbackTarget

public static String loopbackTarget(WarmerConfig config,
 int localPort)

Where warm requests go: front-cache.warmer.loopback-url if it is set, otherwise http://127.0.0.1:<the local port the management request arrived on> - the connector the management API was reached on, which in every shipped topology is the one traffic uses. front-cache.http-port is not a candidate: it is the PUBLIC port used to build redirects, and the bundled config sets it to 80 while Jetty listens on 9080. Always http unless configured. The management request's isSecure() is NOT the connector's scheme: the bundled Jetty honours X-Forwarded-Proto, so behind a TLS-terminating nginx it reads true on a plain-HTTP socket, and deriving the scheme from it sent a TLS handshake to 127.0.0.1:9080 - "Unsupported or unrecognized SSL message" on every entry. The key's scheme does not depend on the loopback's any more; see LoopbackWarmTransport.

withRequestDefaults

public static ActionResponse withRequestDefaults(ActionResponse response,
 WarmerConfig config,
 boolean requestSecure)

Sets the default key base a status response offers the Run form to the one this request implies. The warmer's own status cannot know it: the default's scheme is a property of the management request, not of the warmer.

status

public static WarmerStatusActionResponse status(CacheWarmer warmer)

lists

public static WarmerListsActionResponse lists(CacheWarmer warmer)

getList

public static WarmerListActionResponse getList(CacheWarmer warmer,
 String name,
 String grep)

rawListProblem

public static String rawListProblem(CacheWarmer warmer,
 String name)

Returns:

null when name may be streamed as a download, otherwise why not

putList

public static WarmerListActionResponse putList(CacheWarmer warmer,
 String name,
 InputStream body,
 String baseHash,
 boolean authorizedToWrite)

Parameters:

body - the list, streamed - never buffered whole

deleteList

public static WarmerListActionResponse deleteList(CacheWarmer warmer,
 String name,
 boolean authorizedToWrite)

preflight

public static WarmerPreflightActionResponse preflight(CacheWarmer warmer,
 WarmerRunParams params,
 boolean requestSecure,
 int localPort,
 CacheProcessor processor)

start

public static WarmerStatusActionResponse start(CacheWarmer warmer,
 WarmerRunParams params,
 boolean requestSecure,
 int localPort,
 boolean authorizedToWrite)

update

public static WarmerStatusActionResponse update(CacheWarmer warmer,
 Long delayMs,
 Integer concurrency,
 boolean authorizedToWrite)

pause

public static WarmerStatusActionResponse pause(CacheWarmer warmer,
 boolean authorizedToWrite)

resume

public static WarmerStatusActionResponse resume(CacheWarmer warmer,
 boolean authorizedToWrite)

stop

public static WarmerStatusActionResponse stop(CacheWarmer warmer,
 boolean authorizedToWrite)