Module io.helidon.webserver

Package io.helidon.webserver

Reactive web server API.

Interface Summary

Interface	Description
BareRequest	Bare (minimal) representation of HTTP Request.
BareResponse	Bare (minimal) representation of HTTP Response.
DirectHandler	A handler that is invoked when a response is sent outside of routing.
DirectHandler.TransportRequest	Request information.
ErrorHandler<T extends Throwable>	The routing error handler.
ExperimentalConfiguration	Interface ExperimentalConfiguration.
Handler	The ServerRequest and ServerResponse handler.
Handler.EntityHandler<T>	Handles request, response and HTTP request content entity.
Http2Configuration	Interface Http2Configuration.
KeyPerformanceIndicatorSupport	Definitions and factory methods for key performance indicator KeyPerformanceIndicatorSupport.Context and KeyPerformanceIndicatorSupport.Metrics.
KeyPerformanceIndicatorSupport.Context	Per-request key performance indicator context, with behavior common to immediately-processed requests and deferrable ones.
KeyPerformanceIndicatorSupport.DeferrableRequestContext	Added per-request key performance indicator context behavior for requests for which processing might be deferred until some time after receipt of the request (i.e., some time after request handling begins).
KeyPerformanceIndicatorSupport.Metrics	Key performance indicator metrics behavior.
PathMatcher	URI Path Matcher.
PathMatcher.PrefixResult	The result of prefix matching a PathMatcher to a given URI path.
PathMatcher.Result	The result of matching a PathMatcher to a given URI path.
PathTracingConfig	Traced system configuration for web server for a specific path.
RequestHeaders	Extends Parameters interface by adding HTTP request headers oriented convenient methods.
ResponseHeaders	Extends Parameters interface by adding HTTP response headers oriented constants and convenient methods.
Routing	Routing represents composition of HTTP request-response handlers with routing rules.
Routing.Rules	An API to define HTTP request routing rules.
ServerConfiguration	WebServer configuration.
ServerRequest	Represents HTTP Request and provides WebServer related API.
ServerResponse	Represents HTTP Response.
Service	Encapsulates a set of routing rules and related logic.
SocketConfiguration	The SocketConfiguration configures a port to listen on and its associated server socket parameters.
SocketConfiguration.SocketConfigurationBuilder<B extends SocketConfiguration.SocketConfigurationBuilder<B>>	Socket configuration builder API, used by SocketConfiguration.Builder to configure additional sockets, and by WebServer.Builder to configure the default socket.
Transport	A very abstract notion of a transport for a particular implementation of the WebServer interface.
WebServer	Represents a immutably configured WEB server.

Class Summary

Class	Description
ByteBufDataChunk	A special DataChunk implementation based on Netty's buffers.
DirectHandler.TransportResponse	Response to correctly reply to the original client.
DirectHandler.TransportResponse.Builder	Fluent API builder for DirectHandler.TransportResponse.
ExperimentalConfiguration.Builder	Builder for ExperimentalConfiguration.
FormParamsSupport	Deprecated. use DefaultMediaSupport.formParamReader() instead
ForwardingHandler	ForwardingHandler bridges Netty response and request related APIs to BareRequest and BareResponse.
HtmlEncoder	HTML encoding of special characters to prevent cross site scripting (XSS) attacks.
Http2Configuration.Builder	Builder for Http2Configuration.
JsonService	A Service and abstract Handler that provides support for JSON content.
PathTracingConfig.Builder	Fluent API builder for PathTracingConfig.
RequestPredicate	Fluent API that allows to create chains of request conditions for composing logical expressions to match requests.
RequestPredicate.ConditionalHandler	A Handler that conditionally delegates to other Handler instances based on a RequestPredicate.
Routing.Builder	A Routing builder.
ServerConfiguration.Builder	Deprecated. since 2.0.0 - use WebServer.Builder instead
SocketConfiguration.Builder	The SocketConfiguration builder class.
SSLContextBuilder	Deprecated. since 2.0.0, please use WebServerTls.builder() instead, then configure it with WebServer.Builder.tls(WebServerTls) or SocketConfiguration.SocketConfigurationBuilder.tls(WebServerTls)
StaticContentSupport	Deprecated, for removal: This API element is subject to removal in a future version. please use module helidon-webserver-static-content
StaticContentSupport.Builder	Fluent builder of the StaticContent detailed parameters.
WebServer.Builder	WebServer builder class provides a convenient way to set up WebServer with multiple server sockets and optional multiple routings.
WebServerTls	A class wrapping transport layer security (TLS) configuration for WebServer sockets.
WebServerTls.Builder	Fluent API builder for WebServerTls.
WebTracingConfig	Tracing configuration for webserver.
WebTracingConfig.Builder	A fluent API builder for WebTracingConfig.

Enum Summary

Enum	Description
BackpressureStrategy	Strategy for applying backpressure to the reactive stream of response data.
ClientAuthentication	Indicates whether the server requires authentication of tbe client by the certificate.
DirectHandler.EventType	Types of events that can be triggered outside of routing that immediately return a response.
ServerResponse.CachingStrategy	Declares common groups of Cache-Control settings.
SocketConfiguration.RequestedUriDiscoveryType	Types of discovery of frontend uri.

Exception Summary

Exception	Description
BadRequestException	A runtime exception indicating a bad request.
ConnectionClosedException	The ConnectionClosedException indicates that a connection was closed and it's not possible to send more data.
HttpException	Runtime exception for applications.
IllegalPathPatternException	Cannot parse path pattern.
NotFoundException	A runtime exception indicating a not found.
SocketClosedException	Signals that socket was closed before server request it.
UnsafeRequestedUriSettingsException	Indicates unsafe settings for a socket's request URI discovery.
UnsupportedBodyTypeException	Cannot marshal requested type.