Module io.helidon.webserver

Package io.helidon.webserver.http

Class RestServer

java.lang.Object

io.helidon.webserver.http.RestServer

public final class RestServer
extends Object

APIs to define a declarative server endpoint.

Declarative response metadata, such as RestServer.Status, RestServer.Header, RestServer.ComputedHeader, and Http.Produces, is configured on ServerResponse by generated routing code. For endpoint methods that accept ServerResponse, generated code configures this metadata before invoking the method, so it is available to ServerResponse.outputStream() and other response-handling APIs. For endpoint methods that do not accept ServerResponse, generated code configures this metadata after the method returns and before the generated response is sent.

Declarative response metadata has the same lifecycle as metadata configured imperatively on ServerResponse: it remains on the current response unless later route or error handling changes it.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static @interface	RestServer.ComputedHeader	Definition of computed outbound response header metadata.
static @interface	RestServer.ComputedHeaders	Container for RestServer.ComputedHeader repeated annotation.
static @interface	RestServer.Endpoint	Definition of a server endpoint.
static @interface	RestServer.Header	Definition of outbound response header metadata.
static @interface	RestServer.Headers	Container for RestServer.Header repeated annotation.
static @interface	RestServer.Listener	Listener socket assigned to this endpoint.
static @interface	RestServer.Status	HTTP status to configure for a declarative server response.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait