Interface BundledPluginContext

All Superinterfaces:
org.frontcache.plugin.PluginContext

public interface BundledPluginContext extends org.frontcache.plugin.PluginContext
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. It adds what only code built for this exact core may have: a raw property, the cache, the warm-request token.

Not part of frontcache-plugin-api, on purpose: a plugin written against the API cannot rely on any of this, and a plugin loaded from a plugin directory (a later phase) will never receive it.

  • Method Summary

    Modifier and Type
    Method
    Description
    The node's cache processor if it exists, without creating one; may be null.
    A property of frontcache.properties, read-only; null when unset.
    The in-memory token a warm request presents in x-frontcache-warm - see org.frontcache.warmer.WarmRequest.

    Methods inherited from interface org.frontcache.plugin.PluginContext

    coreVersion, dataDirectory, evidenceSigner, frontcacheHome, hashClientKey, manifest, nodeId, publicDomain, scheduler, writeList
  • Method Details

    • property

      String property(String key)
      A property of frontcache.properties, read-only; null when unset.
    • existingCacheProcessor

      CacheProcessor existingCacheProcessor()
      The node's cache processor if it exists, without creating one; may be null.
    • warmRequestToken

      String warmRequestToken()
      The in-memory token a warm request presents in x-frontcache-warm - see org.frontcache.warmer.WarmRequest. In-process only: it must never be logged or sent anywhere but to this node's own loopback.