Interface ResponseMarshaler.Builder.OptionsHandler

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.OptionsHandler

Function used to support pluggable implementations of ResponseMarshaler.forOptions(Request, Set).

Author:

Mark Allen

Method Summary

Modifier and Type	Method	Description
MarshaledResponse	handle(Request request, Set<HttpMethod> allowedHttpMethods)	Prepares a response for an HTTP OPTIONS request.

Method Details

handle

@Nonnull
MarshaledResponse handle(@Nonnull
 Request request,
 @Nonnull
 Set<HttpMethod> allowedHttpMethods)

Prepares a response for an HTTP OPTIONS request.

Note that CORS preflight responses are handled specially by ResponseMarshaler.forCorsPreflightAllowed(Request, CorsPreflight, CorsPreflightResponse) and ResponseMarshaler.forCorsPreflightRejected(Request, CorsPreflight) - not this method.

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

Parameters:

request - the HTTP request

allowedHttpMethods - appropriate HTTP methods to write to the Allow response header

Returns:

the response to be sent over the wire