Interface ResponseMarshaler.Builder.OptionsSplatHandler

Enclosing class:
ResponseMarshaler.Builder
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface public static interface ResponseMarshaler.Builder.OptionsSplatHandler
Function used to support pluggable implementations of ResponseMarshaler.forOptionsSplat(Request).
Author:
Mark Allen

  • Method Summary

    Modifier and Type
    Method
    Description
    MarshaledResponse
    handle(Request request)
    Prepares a response for an HTTP OPTIONS * (colloquially, "OPTIONS Splat") request.

  • Method Details

    • handle

      @Nonnull MarshaledResponse handle(@Nonnull Request request)
      Prepares a response for an HTTP OPTIONS * (colloquially, "OPTIONS Splat") request.

      This is a special HTTP/1.1 request defined in RFC 7231 ยง4.3.7 which permits querying of server-wide capabilities, not the capabilities of a particular resource - e.g. a load balancer asking "is the system up?" without an explicit health-check URL.

      Detailed documentation is available at https://www.soklet.com/docs/response-writing#http-options.

      Parameters:
      request - the HTTP request
      Returns:
      the response to be sent over the wire