Annotation Interface HandleWeb

@Documented @Retention(RUNTIME) @Target({METHOD,ANNOTATION_TYPE}) @HandleMessage(WEBREQUEST) public @interface HandleWeb
Marks a method or meta-annotation as a handler for incoming web requests (MessageType.WEBREQUEST).

Web requests received by the Fluxzero Runtime are logged. Connected client applications can route these requests using this annotation or one of its specific variants, like HandleGet, HandlePost, etc.

This annotation can be used directly to handle any method (GET, POST, etc.), or indirectly via more specific annotations like HandleGet, HandlePost, HandleSocketOpen, etc.

By default, a handler will return a result which is published to the WebResponse log. To suppress this behavior, set passive = true.

See Also:

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    autoHead
    If true, HEAD requests may be routed to matching GET handlers when no explicit HEAD handler is present.
    boolean
    autoOptions
    If true, matching routes may contribute to automatically generated OPTIONS responses when no explicit OPTIONS handler is present.
    boolean
    disabled
    If true, disables this handler during discovery.
    String[]
    method
    HTTP or WebSocket methods that this handler supports (e.g.
    boolean
    passive
    If true, the handler will not publish a response to the WebResponse log.
    String[]
    value
    One or more path patterns this handler applies to (e.g.

  • Element Details

    • value

      String[] value
      One or more path patterns this handler applies to (e.g. /users, /accounts/{id}, /accounts/*/users). If empty, the path is based on the Path annotation.

      Patterns support literal path parts, {name} parameters, {name:regex} constrained parameters, and * wildcards. A non-final * matches within a single path segment, while a final * matches the rest of the path. Optional path fragments can be declared with square brackets, for example /users[/{id}]. Trailing slashes on non-root paths are ignored.

      Default:
      {}

    • disabled

      boolean disabled
      If true, disables this handler during discovery.
      Default:
      false

    • method

      String[] method
      HTTP or WebSocket methods that this handler supports (e.g. GET, POST, WS_OPEN). Default is HttpRequestMethod.ANY.
      Default:
      {"*"}

    • passive

      boolean passive
      If true, the handler will not publish a response to the WebResponse log.
      Default:
      false

    • autoHead

      boolean autoHead
      If true, HEAD requests may be routed to matching GET handlers when no explicit HEAD handler is present. Only applies to GET mappings.
      Default:
      true

    • autoOptions

      boolean autoOptions
      If true, matching routes may contribute to automatically generated OPTIONS responses when no explicit OPTIONS handler is present.
      Default:
      true