Annotation Interface HandleOptions


@Documented @Retention(RUNTIME) @Target(METHOD) @HandleWeb(value="", method="OPTIONS") public @interface HandleOptions
Handles incoming HTTP OPTIONS requests for the specified path(s).

This is a specialization of HandleWeb for OPTIONS method requests.

See Also:
  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    If true, disables this handler during discovery.
    boolean
    If true, the handler will not publish a response to the WebResponse log.
    boolean
    If true, indexed web request messages whose effective timeout has already expired may be skipped before this handler is invoked.
    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
    • passive

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

      boolean skipExpiredRequests
      If true, indexed web request messages whose effective timeout has already expired may be skipped before this handler is invoked.
      See Also:
      Default:
      true