Annotation Interface HandleGet

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

This is a specialization of HandleWeb for GET method requests.

See Also:

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    autoHead
    If true, HEAD requests may be routed to this GET handler when no explicit HEAD handler is present.
    boolean
    autoOptions
    If true, this route may contribute to automatically generated OPTIONS responses.
    boolean
    disabled
    If true, disables this handler during discovery.
    boolean
    passive
    If true, the handler will not publish a response to the WebResponse log.
    boolean
    skipExpiredRequests
    If true, indexed web request messages whose effective timeout has already expired may be skipped before this handler is invoked.
    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

    • 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

    • autoHead

      boolean autoHead
      If true, HEAD requests may be routed to this GET handler when no explicit HEAD handler is present.
      Default:
      true

    • autoOptions

      boolean autoOptions
      If true, this route may contribute to automatically generated OPTIONS responses.
      Default:
      true