#1679 - ENH: Support enabling/disabling L2 cache by "region" at runtime

src/main/java/io/ebean/cache/ServerCacheManager.java

@@ -1,5 +1,7 @@
 package io.ebean.cache;
 
+import java.util.List;
+
 /**
  * The cache service for server side caching of beans and query results.
  */
@@ -14,6 +16,31 @@ public interface ServerCacheManager {
    */
   boolean isLocalL2Caching();
 
+  /**
+   * Return all the cache regions.
+   */
+  List<ServerCacheRegion> allRegions();
+
+  /**
+   * Set the regions that are enabled.
+   * <p>
+   * Typically this is set on startup and at runtime (via dynamic configuration).
+   * </p>
+   *
+   * @param regions A region name or comma delimited list of region names.
+   */
+  void setEnabledRegions(String regions);
+
+  /**
+   * Enable or disable all the cache regions.
+   */
+  void setAllRegionsEnabled(boolean enabled);
+
+  /**
+   * Return the cache region by name. Typically to enable or disable the region.
+   */
+  ServerCacheRegion getRegion(String name);
+
   /**
    * Return the cache for mapping natural keys to id values.
    */
@@ -46,7 +73,7 @@ public interface ServerCacheManager {
 
   /**
    * Clear all the local caches.
-   *
+   * <p>
    * This is used when the L2 Cache is based on clustered near-caches (Like Ebean-K8s-L2Cache).
    * It is not used when the L2 cache is a distributed cache such as HazelCast or Ignite etc.
    */
@@ -54,7 +81,7 @@ public interface ServerCacheManager {
 
   /**
    * Clear the local caches for this bean type.
-   *
+   * <p>
    * This is used when the L2 Cache is based on clustered near-caches (Like Ebean-K8s-L2Cache).
    * It is not used when the L2 cache is a distributed cache such as HazelCast or Ignite etc.
    */