Class WebParameters

java.lang.Object
io.fluxcapacitor.javaclient.web.WebParameters

public class WebParameters extends Object
Internal configuration holder used to expand the URI and method mappings of a web request handler method.

This class supports handlers that match multiple URI patterns and/or HTTP methods. It is typically used in conjunction with the @HandleWeb annotation, where a single method can be annotated with multiple WebParameters to define various acceptable request routes.

Each WebParameters instance includes:

  • A list of URI patterns (e.g. /users, /users/{id})
  • A list of HTTP methods (e.g. GET, POST)
  • An optional disabled flag that disables this set of patterns

The getWebPatterns() method expands this configuration into a Stream of WebPattern instances—one for each combination of method and URI pattern.

See Also:
  • WebPattern
  • invalid reference
    WebUtils#getWebPatterns(Executable)
  • Constructor Details

    • WebParameters

      public WebParameters()
  • Method Details

    • getWebPatterns

      public Stream<WebPattern> getWebPatterns()
      Expands this configuration into a stream of WebPattern instances.

      If no URI patterns are provided, a wildcard pattern ("") is assumed.

      Returns:
      a stream of WebPattern combinations for method/URI
    • getWebPatterns

      public Stream<WebPattern> getWebPatterns(String rootPath)
      Expands this configuration into a stream of WebPattern instances.

      If no URI patterns are provided, a wildcard pattern ("") is assumed.

      Returns:
      a stream of WebPattern combinations for method/URI