Package dev.relism.flash.ext.limiter

Class LimiterExtension

java.lang.Object
dev.relism.flash.ext.limiter.LimiterExtension
All Implemented Interfaces:
dev.relism.flash.extension.FlashExtension
public final class LimiterExtension extends Object implements dev.relism.flash.extension.FlashExtension
Rate-limiting extension for Flash.

At

invalid reference 
#provide
:
  1. Creates a single BucketStore shared by all rules in this extension instance.
  2. Provides a Guard in the FlashContext for manual use on lambda routes.
  3. Registers an AnnotationProcessor for Limit: reads the annotation once per handler class at boot, resolves the key lambda fail-fast, then returns a pre-compiled middleware — zero map lookups at request time.

Annotation-based (class handlers)


 @Limit(requests = 100, window = 1)                          // 100 req/s per IP
 public class SearchHandler extends RequestHandler { ... }

 @Limit(key = "auth_user", requests = 20, window = 1,
        windowUnit = TimeUnit.MINUTES,
        strategy   = LimitStrategy.TOKEN_BUCKET)
 public class ReportHandler extends RequestHandler { ... }

Lambda routes (via Guard)


 app.install(new LimiterExtension(
     new LimiterConfig().registerResolver("auth_user", req -> SecurityIdentity.current().principal().name())));

 // inside a FlashContext.onReady(...) callback:
 Guard guard = ctx.require(Guard.class);
 app.get("/api/search", handler, guard.limit("ip", 50, 1, TimeUnit.SECONDS));

  • Constructor Details

    • LimiterExtension

      public LimiterExtension()
      Installs with default config (only the built-in "ip" resolver).

    • LimiterExtension

      public LimiterExtension(LimiterConfig config)
      Installs with a custom LimiterConfig (custom resolvers, etc.).

  • Method Details

    • configure

      public void configure(dev.relism.flash.extension.FlashRegistrar<?> app, dev.relism.flash.extension.FlashContext ctx)
      Specified by:
      configure in interface dev.relism.flash.extension.FlashExtension