A B C D E F G H I J K L M N O P R S T U V W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- absoluteUri() - Method in interface io.helidon.webserver.ServerRequest
-
Absolute URI of the incoming request, including query parameters and fragment.
- accept(ServerRequest, ServerResponse) - Method in class io.helidon.webserver.FormParamsSupport
-
Deprecated.
- accept(ServerRequest, ServerResponse) - Method in interface io.helidon.webserver.Handler
- accept(ServerRequest, ServerResponse) - Method in class io.helidon.webserver.RequestPredicate.ConditionalHandler
- accept(ServerRequest, ServerResponse, T) - Method in interface io.helidon.webserver.ErrorHandler
-
Error handling consumer.
- accept(ServerRequest, ServerResponse, T) - Method in interface io.helidon.webserver.Handler.EntityHandler
- acceptDatetime() - Method in interface io.helidon.webserver.RequestHeaders
-
Optionally returns acceptedTypes version in time ("Accept-Datetime" header).
- acceptedTypes() - Method in interface io.helidon.webserver.RequestHeaders
-
Returns a list of acceptedTypes ("Accept" header) content types in quality factor order.
- acceptPatches() - Method in interface io.helidon.webserver.ResponseHeaders
-
Gets immutable list of supported patch document formats (header "Accept-Patch").
- accepts(MediaType...) - Method in class io.helidon.webserver.RequestPredicate
-
Only accept request that accepts any of the given content types.
- accepts(String...) - Method in class io.helidon.webserver.RequestPredicate
-
Accept requests only when it accepts any of the given content types.
- acceptsJson(ServerRequest, ServerResponse) - Method in class io.helidon.webserver.JsonService
-
Determines if JSON is an accepted response type, using
Accept
and responseContent-Type
headers. - add(String, Iterable<String>) - Method in interface io.helidon.webserver.ResponseHeaders
- add(String, String...) - Method in interface io.helidon.webserver.ResponseHeaders
- addAcceptPatches(MediaType...) - Method in interface io.helidon.webserver.ResponseHeaders
-
Adds one or more acceptedTypes path document formats (header "Accept-Patch").
- addAll(Parameters) - Method in interface io.helidon.webserver.ResponseHeaders
- addCookie(SetCookie) - Method in interface io.helidon.webserver.ResponseHeaders
-
Adds
Set-Cookie
header specified in RFC6265. - addCookie(String, String) - Method in interface io.helidon.webserver.ResponseHeaders
-
Adds
Set-Cookie
header based on RFC2616. - addCookie(String, String, Duration) - Method in interface io.helidon.webserver.ResponseHeaders
- addHeader(String, Iterable<String>) - Method in interface io.helidon.webserver.ServerResponse
-
Adds header values for a specified name.
- addHeader(String, String...) - Method in interface io.helidon.webserver.ServerResponse
-
Adds header values for a specified name.
- addHeaders(Parameters) - Method in interface io.helidon.webserver.ServerResponse
-
Copies all of the mappings from the specified
parameters
to this response headers instance. - addMediaSupport(MediaSupport) - Method in class io.helidon.webserver.WebServer.Builder
- addMethod(String) - Method in class io.helidon.webserver.PathTracingConfig.Builder
-
Add a new HTTP method to restrict this configuration for.
- addNamedRouting(String, Routing) - Method in class io.helidon.webserver.WebServer.Builder
-
Associates a dedicated routing with an additional server socket configuration.
- addNamedRouting(String, Supplier<Routing>) - Method in class io.helidon.webserver.WebServer.Builder
-
Associates a dedicated routing with an additional server socket configuration.
- addPathConfig(PathTracingConfig) - Method in class io.helidon.webserver.WebTracingConfig.Builder
-
Add a path specific configuration of tracing.
- addReader(MessageBodyReader<?>) - Method in class io.helidon.webserver.WebServer.Builder
- addSocket(SocketConfiguration) - Method in class io.helidon.webserver.WebServer.Builder
-
Adds an additional named server socket configuration.
- addSocket(SocketConfiguration, Routing) - Method in class io.helidon.webserver.WebServer.Builder
-
Add a named socket and routing.
- addSocket(String, int, InetAddress) - Method in class io.helidon.webserver.ServerConfiguration.Builder
-
Deprecated.since 2.0.0, please use
ServerConfiguration.Builder.addSocket(String, SocketConfiguration)
instead - addSocket(String, SocketConfiguration) - Method in class io.helidon.webserver.ServerConfiguration.Builder
-
Deprecated.Adds an additional named server socket configuration.
- addSocket(String, SocketConfiguration) - Method in class io.helidon.webserver.WebServer.Builder
-
Deprecated.since 2.0.0, please use
WebServer.Builder.addSocket(SocketConfiguration)
instead, name is now part of socket configuration - addSocket(String, Supplier<SocketConfiguration>) - Method in class io.helidon.webserver.ServerConfiguration.Builder
-
Deprecated.Adds an additional named server socket configuration builder.
- addSocket(String, Supplier<SocketConfiguration>) - Method in class io.helidon.webserver.WebServer.Builder
-
Deprecated.since 2.0.0, please use
WebServer.Builder.addSocket(Supplier)
instead, name is now part of socket configuration - addSocket(Supplier<SocketConfiguration>) - Method in class io.helidon.webserver.WebServer.Builder
-
Adds an additional named server socket configuration builder.
- addStreamReader(MessageBodyStreamReader<?>) - Method in class io.helidon.webserver.WebServer.Builder
- addStreamWriter(MessageBodyStreamWriter<?>) - Method in class io.helidon.webserver.WebServer.Builder
- addWriter(MessageBodyWriter<?>) - Method in class io.helidon.webserver.WebServer.Builder
- allowedCipherSuite() - Method in interface io.helidon.webserver.SocketConfiguration
-
Deprecated, for removal: This API element is subject to removal in a future version.use
tls().cipherSuite()
instead. This method will be removed at 3.0.0 version. - allowedCipherSuite(List<String>) - Method in class io.helidon.webserver.WebServerTls.Builder
-
Set allowed cipher suite.
- and(Predicate<ServerRequest>) - Method in class io.helidon.webserver.RequestPredicate
-
Returns a composed predicate that represents a logical AND expression between this predicate and another predicate.
- any(Handler...) - Method in class io.helidon.webserver.Routing.Builder
- any(Handler...) - Method in interface io.helidon.webserver.Routing.Rules
-
Routes all requests to provided handler(s).
- any(PathMatcher, Handler...) - Method in class io.helidon.webserver.Routing.Builder
- any(PathMatcher, Handler...) - Method in interface io.helidon.webserver.Routing.Rules
-
Routes all requests with corresponding path to provided handler(s).
- any(String, Handler...) - Method in class io.helidon.webserver.Routing.Builder
- any(String, Handler...) - Method in interface io.helidon.webserver.Routing.Rules
-
Routes all requests with corresponding path to provided handler(s).
- anyOf(Iterable<Http.RequestMethod>, Handler...) - Method in class io.helidon.webserver.Routing.Builder
- anyOf(Iterable<Http.RequestMethod>, Handler...) - Method in interface io.helidon.webserver.Routing.Rules
-
Routes requests any specified method to provided handler(s).
- anyOf(Iterable<Http.RequestMethod>, PathMatcher, Handler...) - Method in class io.helidon.webserver.Routing.Builder
- anyOf(Iterable<Http.RequestMethod>, PathMatcher, Handler...) - Method in interface io.helidon.webserver.Routing.Rules
-
Routes requests with any specified method and corresponding path to provided handler(s).
- anyOf(Iterable<Http.RequestMethod>, String, Handler...) - Method in class io.helidon.webserver.Routing.Builder
- anyOf(Iterable<Http.RequestMethod>, String, Handler...) - Method in interface io.helidon.webserver.Routing.Rules
-
Routes requests with any specified method and corresponding path to provided handler(s).
B
- backlog() - Method in interface io.helidon.webserver.ServerConfiguration
-
Returns a maximum length of the queue of incoming connections on the default server socket.
- backlog() - Method in interface io.helidon.webserver.SocketConfiguration
-
Returns a maximum length of the queue of incoming connections on the server socket.
- backlog(int) - Method in class io.helidon.webserver.ServerConfiguration.Builder
-
Deprecated.Sets a maximum length of the queue of incoming connections.
- backlog(int) - Method in class io.helidon.webserver.SocketConfiguration.Builder
-
Configures a maximum length of the queue of incoming connections on the server socket.
- backlog(int) - Method in interface io.helidon.webserver.SocketConfiguration.SocketConfigurationBuilder
-
Configures a maximum length of the queue of incoming connections on the server socket.
- backlog(int) - Method in class io.helidon.webserver.WebServer.Builder
- BAD_REQUEST - io.helidon.webserver.DirectHandler.EventType
-
Bad request, such as invalid path, header.
- BadRequestException - Exception in io.helidon.webserver
-
A runtime exception indicating a
bad request
. - BadRequestException(String) - Constructor for exception io.helidon.webserver.BadRequestException
-
Creates
BadRequestException
. - BadRequestException(String, Throwable) - Constructor for exception io.helidon.webserver.BadRequestException
-
Creates
BadRequestException
. - BareRequest - Interface in io.helidon.webserver
-
Bare (minimal) representation of HTTP Request.
- BareResponse - Interface in io.helidon.webserver
-
Bare (minimal) representation of HTTP Response.
- beforeSend(Consumer<ResponseHeaders>) - Method in interface io.helidon.webserver.ResponseHeaders
-
Register a
Consumer
which is executed just before headers are send. - bestAccepted(MediaType...) - Method in interface io.helidon.webserver.RequestHeaders
-
Optionally returns a single media type from the given media types that is the best one accepted by the client.
- bindAddress() - Method in interface io.helidon.webserver.ServerConfiguration
-
Returns local address where the server listens on with the default server socket.
- bindAddress() - Method in interface io.helidon.webserver.SocketConfiguration
-
Returns local address where the server listens on with the server socket.
- bindAddress(String) - Method in interface io.helidon.webserver.SocketConfiguration.SocketConfigurationBuilder
-
Configures local address where the server listens on with the server socket.
- bindAddress(InetAddress) - Method in class io.helidon.webserver.ServerConfiguration.Builder
-
Deprecated.Sets a local address for server to bind.
- bindAddress(InetAddress) - Method in class io.helidon.webserver.SocketConfiguration.Builder
- bindAddress(InetAddress) - Method in interface io.helidon.webserver.SocketConfiguration.SocketConfigurationBuilder
-
Configures local address where the server listens on with the server socket.
- bindAddress(InetAddress) - Method in class io.helidon.webserver.WebServer.Builder
- bodyPublisher() - Method in interface io.helidon.webserver.BareRequest
-
Gets the Flow Publisher that allows a subscription for request body chunks.
- build() - Method in class io.helidon.webserver.DirectHandler.TransportResponse.Builder
- build() - Method in class io.helidon.webserver.ExperimentalConfiguration.Builder
- build() - Method in class io.helidon.webserver.Http2Configuration.Builder
- build() - Method in class io.helidon.webserver.PathTracingConfig.Builder
- build() - Method in class io.helidon.webserver.Routing.Builder
-
Builds a new routing instance.
- build() - Method in class io.helidon.webserver.ServerConfiguration.Builder
-
Deprecated.Builds a new configuration instance.
- build() - Method in class io.helidon.webserver.SocketConfiguration.Builder
- build() - Method in class io.helidon.webserver.SSLContextBuilder
-
Deprecated.since 2.0.0, please use
WebServerTls.builder()
instead, then configure it withWebServer.Builder.tls(WebServerTls)
orSocketConfiguration.SocketConfigurationBuilder.tls(WebServerTls)
- build() - Method in class io.helidon.webserver.StaticContentSupport.Builder
-
Deprecated.Builds new
StaticContentSupport
instance. - build() - Method in class io.helidon.webserver.WebServer.Builder
-
Builds the
WebServer
instance as configured by this builder and its parameters. - build() - Method in class io.helidon.webserver.WebServerTls.Builder
- build() - Method in class io.helidon.webserver.WebTracingConfig.Builder
- builder() - Static method in class io.helidon.webserver.DirectHandler.TransportResponse
-
A builder to set up a custom response.
- builder() - Static method in interface io.helidon.webserver.ExperimentalConfiguration
-
Create a new fluent API builder.
- builder() - Static method in interface io.helidon.webserver.Http2Configuration
-
Create a new fluent API builder.
- builder() - Static method in interface io.helidon.webserver.PathTracingConfig
-
Create a new builder to configure traced path configuration.
- builder() - Static method in interface io.helidon.webserver.Routing
-
Creates new instance of
routing builder
. - builder() - Static method in interface io.helidon.webserver.ServerConfiguration
-
Deprecated.since 2.0.0 - please use
WebServer.builder()
instead - builder() - Static method in interface io.helidon.webserver.SocketConfiguration
-
Creates a builder of
SocketConfiguration
class. - builder() - Static method in interface io.helidon.webserver.WebServer
-
Creates a fluent API builder of the
WebServer
. - builder() - Static method in class io.helidon.webserver.WebServerTls
-
A fluent API builder for
WebServerTls
. - builder() - Static method in class io.helidon.webserver.WebTracingConfig
-
A fluent API builder to create tracing support.
- builder(Config) - Static method in interface io.helidon.webserver.ServerConfiguration
-
Deprecated.since 2.0.0 - please use
WebServer.builder()
, thenWebServer.Builder.config(io.helidon.config.Config)
, orWebServer.create(Routing, io.helidon.config.Config)
- builder(Routing) - Static method in interface io.helidon.webserver.WebServer
-
Creates a builder of the
WebServer
. - builder(String) - Static method in class io.helidon.webserver.StaticContentSupport
-
Deprecated.Creates new builder with defined static content root as a class-loader resource.
- builder(String, ClassLoader) - Static method in class io.helidon.webserver.StaticContentSupport
-
Deprecated.Creates new builder with defined static content root as a class-loader resource.
- builder(Path) - Static method in class io.helidon.webserver.StaticContentSupport
-
Deprecated.Creates new builder with defined static content root as a path to the file system.
- builder(Supplier<? extends Routing>) - Static method in interface io.helidon.webserver.WebServer
-
Creates a builder of the
WebServer
. - Builder() - Constructor for class io.helidon.webserver.Http2Configuration.Builder
- ByteBufDataChunk - Class in io.helidon.webserver
-
A special DataChunk implementation based on Netty's buffers.
- bytes() - Method in class io.helidon.webserver.ByteBufDataChunk
C
- cachingStrategy(ServerResponse.CachingStrategy) - Method in interface io.helidon.webserver.ServerResponse
-
Sets the
Cache-Control
header values according to the specified strategy. - channelInactive(ChannelHandlerContext) - Method in class io.helidon.webserver.ForwardingHandler
- channelRead0(ChannelHandlerContext, Object) - Method in class io.helidon.webserver.ForwardingHandler
- channelReadComplete(ChannelHandlerContext) - Method in class io.helidon.webserver.ForwardingHandler
- clearCookie(String) - Method in interface io.helidon.webserver.ResponseHeaders
-
Clears a cookie by adding a
Set-Cookie
header with an expiration date in the past. - clientAuth() - Method in interface io.helidon.webserver.SocketConfiguration
-
Deprecated, for removal: This API element is subject to removal in a future version.use
tls().clientAuth()
instead. This method will be removed at 3.0.0 version. - clientAuth(ClientAuthentication) - Method in class io.helidon.webserver.WebServerTls.Builder
-
Configures whether client authentication will be required or not.
- ClientAuthentication - Enum in io.helidon.webserver
-
Indicates whether the server requires authentication of tbe client by the certificate.
- closeConnection() - Method in interface io.helidon.webserver.BareRequest
-
Request to close the connection and report success or failure asynchronously with returned single.
- closeConnection() - Method in interface io.helidon.webserver.ServerRequest
-
Request to close the connection and report success or failure asynchronously with returned single.
- config(Config) - Method in class io.helidon.webserver.PathTracingConfig.Builder
-
Update this builder from provided
Config
. - config(Config) - Method in class io.helidon.webserver.ServerConfiguration.Builder
-
Deprecated.Sets configuration values included in provided
Config
parameter. - config(Config) - Method in class io.helidon.webserver.SocketConfiguration.Builder
- config(Config) - Method in interface io.helidon.webserver.SocketConfiguration.SocketConfigurationBuilder
-
Update this socket configuration from a
Config
. - config(Config) - Method in class io.helidon.webserver.WebServer.Builder
-
Update this server configuration from the config provided.
- config(Config) - Method in class io.helidon.webserver.WebServerTls.Builder
-
Update this builder from configuration.
- config(Config) - Method in class io.helidon.webserver.WebTracingConfig.Builder
-
Update builder from
Config
. - config(ServerConfiguration) - Method in class io.helidon.webserver.WebServer.Builder
-
Deprecated.since 2.0.0 - please use methods on this builder, or
WebServer.Builder.config(io.helidon.config.Config)
instead - config(Supplier<ServerConfiguration>) - Method in class io.helidon.webserver.WebServer.Builder
-
Deprecated.since 2.0.0 - see
WebServer.Builder.config(ServerConfiguration)
- configuration() - Method in interface io.helidon.webserver.WebServer
-
Gets effective server configuration.
- ConnectionClosedException - Exception in io.helidon.webserver
-
The ConnectionClosedException indicates that a connection was closed and it's not possible to send more data.
- ConnectionClosedException(String) - Constructor for exception io.helidon.webserver.ConnectionClosedException
-
Creates this exception with the provided message.
- containsCookie(String) - Method in class io.helidon.webserver.RequestPredicate
-
Accept request only when the specified cookie exists.
- containsCookie(String, String) - Method in class io.helidon.webserver.RequestPredicate
-
Accept requests only when the specified cookie contains a given value.
- containsCookie(String, Predicate<String>) - Method in class io.helidon.webserver.RequestPredicate
-
Accept requests only when the specified cookie is valid.
- containsHeader(String) - Method in class io.helidon.webserver.RequestPredicate
-
Accept requests only when the specified header name exists.
- containsHeader(String, String) - Method in class io.helidon.webserver.RequestPredicate
-
Accept requests only when the specified header contains a given value.
- containsHeader(String, Predicate<String>) - Method in class io.helidon.webserver.RequestPredicate
-
Accept requests only when the specified header is valid.
- containsQueryParameter(String) - Method in class io.helidon.webserver.RequestPredicate
-
Accept requests only when the specified query parameter exists.
- containsQueryParameter(String, String) - Method in class io.helidon.webserver.RequestPredicate
-
Accept requests only when the specified query parameter contains a given value.
- containsQueryParameter(String, Predicate<String>) - Method in class io.helidon.webserver.RequestPredicate
-
Accept requests only when the specified query parameter is valid.
- content() - Method in interface io.helidon.webserver.ServerRequest
-
Returns
MessageBodyReadableContent
reactive representation of the request content. - contentLength() - Method in interface io.helidon.webserver.RequestHeaders
-
Optionally returns the length of the request body in octets (8-bit bytes).
- contentLength() - Method in interface io.helidon.webserver.ResponseHeaders
-
Optionally gets the value of "Content-Length" header.
- contentLength(long) - Method in interface io.helidon.webserver.ResponseHeaders
-
Sets the value of "Content-Length" header.
- contentType() - Method in interface io.helidon.webserver.RequestHeaders
-
Optionally returns the MIME type of the body of the request.
- contentType() - Method in interface io.helidon.webserver.ResponseHeaders
-
Optionally gets the MIME type of the response body.
- contentType(MediaType) - Method in interface io.helidon.webserver.ResponseHeaders
-
Sets the MIME type of the response body.
- contentType(String, MediaType) - Method in class io.helidon.webserver.StaticContentSupport.Builder
-
Deprecated.Maps a filename extension to the response content type.
- context() - Method in interface io.helidon.webserver.ServerConfiguration
-
The top level
Context
to be used by this webserver. - context() - Method in interface io.helidon.webserver.ServerRequest
-
Returns a request context as a child of
WebServer
context. - context() - Method in interface io.helidon.webserver.WebServer
-
Gets a
WebServer
context. - context(Context) - Method in class io.helidon.webserver.ServerConfiguration.Builder
-
Deprecated.Configure the application scoped context to be used as a parent for webserver request contexts.
- context(Context) - Method in class io.helidon.webserver.WebServer.Builder
-
Configure the application scoped context to be used as a parent for webserver request contexts.
- CONTEXT_SETTING_HANDLER - Static variable in interface io.helidon.webserver.KeyPerformanceIndicatorSupport.DeferrableRequestContext
-
A
Handler
which registers a KPI deferrable request context in the request's context. - CONTINUE - io.helidon.webserver.DirectHandler.EventType
-
Continue (see
Http.Status.CONTINUE_100
). - cookies() - Method in interface io.helidon.webserver.RequestHeaders
-
Returns cookies (parsed from '
Cookie:
' header) based on RFC6265. - create() - Static method in class io.helidon.webserver.FormParamsSupport
-
Deprecated.
- create() - Static method in interface io.helidon.webserver.KeyPerformanceIndicatorSupport.Context
-
Provides a
Context
for use with an immediate (non-deferrable) request. - create() - Static method in interface io.helidon.webserver.KeyPerformanceIndicatorSupport.DeferrableRequestContext
-
Provides a
Context
for use with a deferrable request. - create() - Static method in class io.helidon.webserver.RequestPredicate
-
Creates new empty
RequestPredicate
instance. - create() - Static method in class io.helidon.webserver.WebTracingConfig
-
Create a tracing configuration that is enabled for all paths and spans (that are enabled by default).
- create(boolean, boolean, ByteBuf...) - Static method in class io.helidon.webserver.ByteBufDataChunk
-
Creates an instance given an array of
ByteBuf
's. - create(boolean, boolean, Runnable, ByteBuf...) - Static method in class io.helidon.webserver.ByteBufDataChunk
-
Creates an instance given an array of
ByteBuf
's. - create(KeyConfig) - Static method in class io.helidon.webserver.SSLContextBuilder
-
Deprecated.since 2.0.0, please use
WebServerTls.builder()
instead, then configure it withWebServer.Builder.tls(WebServerTls)
orSocketConfiguration.SocketConfigurationBuilder.tls(WebServerTls)
- create(Config) - Static method in interface io.helidon.webserver.PathTracingConfig
-
Create a new traced path configuration from
Config
. - create(Config) - Static method in interface io.helidon.webserver.ServerConfiguration
-
Creates new instance with defaults from external configuration source.
- create(Config) - Static method in class io.helidon.webserver.SSLContextBuilder
-
Deprecated.since 2.0.0, please use
WebServerTls.builder()
instead, then configure it withWebServer.Builder.tls(WebServerTls)
orSocketConfiguration.SocketConfigurationBuilder.tls(WebServerTls)
- create(Config) - Static method in class io.helidon.webserver.WebServerTls
-
Create TLS configuration from config.
- create(Config) - Static method in class io.helidon.webserver.WebTracingConfig
-
Create a new tracing support base on
Config
. - create(TracingConfig) - Static method in class io.helidon.webserver.WebTracingConfig
-
Create a new tracing support base on
TracingConfig
. - create(Routing) - Static method in interface io.helidon.webserver.WebServer
-
Creates new instance from provided routing and default configuration.
- create(Routing, Config) - Static method in interface io.helidon.webserver.WebServer
-
Creates new instance from provided configuration and routing.
- create(ServerConfiguration, Routing) - Static method in interface io.helidon.webserver.WebServer
-
Deprecated.since 2.0.0 - please use
WebServer.create(Routing, io.helidon.config.Config)
instead for instances based onConfig
, orWebServer.builder(Routing)
to configure server configuration by hand (as you would onSocketConfiguration.Builder
now. - create(ServerConfiguration, Supplier<? extends Routing>) - Static method in interface io.helidon.webserver.WebServer
-
Deprecated.since 2.0.0 - please use
WebServer.create(java.util.function.Supplier, io.helidon.config.Config)
instead for instances based onConfig
, orWebServer.builder(java.util.function.Supplier)
to configure server configuration by hand (as you would onSocketConfiguration.Builder
now. - create(Class<T>, Handler.EntityHandler<T>) - Static method in interface io.helidon.webserver.Handler
-
Creates new instance of the
Handler
for the entity representing HTTP request content. - create(Class<T>, Handler.EntityHandler<T>, ErrorHandler<Throwable>) - Static method in interface io.helidon.webserver.Handler
-
Creates new instance of the
Handler
for the entity representing HTTP request content. - create(String) - Static method in class io.helidon.webserver.DirectHandler.TransportResponse
-
Create a response with
Http.Status.BAD_REQUEST_400
status and provided message. - create(String) - Static method in interface io.helidon.webserver.PathMatcher
-
Creates new instance from provided Web Server path pattern.
- create(String) - Static method in interface io.helidon.webserver.SocketConfiguration
-
Create a default named configuration.
- create(String) - Static method in class io.helidon.webserver.StaticContentSupport
-
Deprecated.Creates new instance with defined static content root as a class-loader resource.
- create(String, ClassLoader) - Static method in class io.helidon.webserver.StaticContentSupport
-
Deprecated.Creates new instance with defined static content root as a class-loader resource.
- create(Path) - Static method in class io.helidon.webserver.StaticContentSupport
-
Deprecated.Creates new instance with defined static content root as a path to the file system.
- create(Supplier<? extends Routing>) - Static method in interface io.helidon.webserver.WebServer
-
Creates new instance from provided routing and default configuration.
- create(Supplier<? extends ServerConfiguration>, Routing) - Static method in interface io.helidon.webserver.WebServer
-
Deprecated.since 2.0.0 - please use
WebServer.create(io.helidon.webserver.Routing, io.helidon.config.Config)
instead for instances based onConfig
, orWebServer.builder(io.helidon.webserver.Routing)
to configure server configuration by hand (as you would onSocketConfiguration.Builder
now. - create(Supplier<? extends ServerConfiguration>, Supplier<? extends Routing>) - Static method in interface io.helidon.webserver.WebServer
-
Deprecated.since 2.0.0 - please use
WebServer.create(java.util.function.Supplier, io.helidon.config.Config)
instead for instances based onConfig
, orWebServer.builder(java.util.function.Supplier)
to configure server configuration by hand (as you would onSocketConfiguration.Builder
now. - create(Supplier<Routing>, Config) - Static method in interface io.helidon.webserver.WebServer
-
Creates new instance from provided configuration and routing.
- createServer() - Method in class io.helidon.webserver.Routing.Builder
-
Deprecated.since 2.0.0, please use
WebServer.create(Routing)
. - createServer() - Method in interface io.helidon.webserver.Routing
-
Deprecated.since 2.0.0 please use
WebServer.builder(Routing)
instead - createServer(ServerConfiguration) - Method in class io.helidon.webserver.Routing.Builder
-
Deprecated.since 2.0.0, please use
WebServer.Builder.build()
to create a new server, configuring routing usingWebServer.Builder.routing(Routing)
. - createServer(ServerConfiguration) - Method in interface io.helidon.webserver.Routing
-
Deprecated.since 2.0.0 please use
WebServer.builder(Routing)
instead - createServer(ServerConfiguration.Builder) - Method in class io.helidon.webserver.Routing.Builder
-
Deprecated.since 2.0.0, please use
WebServer.Builder.build()
to create a new server, configuring routing usingWebServer.Builder.routing(Routing)
. - createTransportArtifact(Class<T>, String, ServerConfiguration) - Method in interface io.helidon.webserver.Transport
-
Creates and returns a suitable transport artifact, if one can be created or is available, and an empty
Optional
otherwise.
D
- data() - Method in class io.helidon.webserver.ByteBufDataChunk
-
This method is needed for testing some of our examples.
- data(Class<T>) - Method in class io.helidon.webserver.ByteBufDataChunk
- date() - Method in interface io.helidon.webserver.RequestHeaders
-
Optionally returns request date ("Accept-Datetime" header).
- DEFAULT - Static variable in interface io.helidon.webserver.SocketConfiguration
-
Deprecated.since 2.0.0 This configuration does not contain a name and will be removed
- DEFAULT_BACKLOG_SIZE - Static variable in interface io.helidon.webserver.SocketConfiguration
-
The default backlog size to configure the server sockets with if no other value is provided.
- DEFAULT_MAX_CONTENT_LENGTH - Static variable in interface io.helidon.webserver.Http2Configuration
-
Default value for max content length.
- DEFAULT_SOCKET_NAME - Static variable in interface io.helidon.webserver.ServerConfiguration
-
Deprecated.since 2.0.0, please use
WebServer.DEFAULT_SOCKET_NAME
- DEFAULT_SOCKET_NAME - Static variable in interface io.helidon.webserver.WebServer
-
The default server socket configuration name.
- delete(Handler...) - Method in class io.helidon.webserver.Routing.Builder
- delete(Handler...) - Method in interface io.helidon.webserver.Routing.Rules
-
Routes all DELETE requests to provided handler(s).
- delete(PathMatcher, Handler...) - Method in class io.helidon.webserver.Routing.Builder
- delete(PathMatcher, Handler...) - Method in interface io.helidon.webserver.Routing.Rules
-
Routes DELETE requests with corresponding path to provided handler(s).
- delete(String, Handler...) - Method in class io.helidon.webserver.Routing.Builder
- delete(String, Handler...) - Method in interface io.helidon.webserver.Routing.Rules
-
Routes DELETE requests with corresponding path to provided handler(s).
- directHandler(DirectHandler, DirectHandler.EventType...) - Method in class io.helidon.webserver.WebServer.Builder
-
Provide a custom handler for events that bypass routing.
- DirectHandler - Interface in io.helidon.webserver
-
A handler that is invoked when a response is sent outside of routing.
- DirectHandler.EventType - Enum in io.helidon.webserver
-
Types of events that can be triggered outside of routing that immediately return a response.
- DirectHandler.TransportRequest - Interface in io.helidon.webserver
-
Request information.
- DirectHandler.TransportResponse - Class in io.helidon.webserver
-
Response to correctly reply to the original client.
- DirectHandler.TransportResponse.Builder - Class in io.helidon.webserver
-
Fluent API builder for
DirectHandler.TransportResponse
. - duplicate() - Method in class io.helidon.webserver.ByteBufDataChunk
E
- enable() - Method in interface io.helidon.webserver.Http2Configuration
-
Config property to enable HTTP/2 support.
- enable(boolean) - Method in class io.helidon.webserver.Http2Configuration.Builder
-
Sets value to enable HTTP/2 support.
- enableCompression() - Method in interface io.helidon.webserver.SocketConfiguration
-
Whether to allow negotiation for a gzip/deflate content encoding.
- enableCompression(boolean) - Method in class io.helidon.webserver.ServerConfiguration.Builder
-
Deprecated.
- enableCompression(boolean) - Method in class io.helidon.webserver.SocketConfiguration.Builder
-
Configure whether to enable content negotiation for compression.
- enableCompression(boolean) - Method in interface io.helidon.webserver.SocketConfiguration.SocketConfigurationBuilder
-
Enable negotiation for gzip/deflate content encodings.
- enableCompression(boolean) - Method in class io.helidon.webserver.WebServer.Builder
- enabled() - Method in interface io.helidon.webserver.SocketConfiguration
-
Whether this socket is enabled (and will be opened on server startup), or disabled (and ignored on server startup).
- enabled() - Method in class io.helidon.webserver.WebServerTls
-
Whether this TLS config has security enabled (and the socket is going to be protected by one of the TLS protocols), or no (and the socket is going to be plain).
- enabled(boolean) - Method in class io.helidon.webserver.SocketConfiguration.Builder
-
Set this socket builder to enabled or disabled.
- enabled(boolean) - Method in class io.helidon.webserver.WebServerTls.Builder
-
Whether the TLS config should be enabled or not.
- enabledProtocols(String...) - Method in class io.helidon.webserver.WebServerTls.Builder
-
Configures the TLS protocols to enable with the server socket.
- enabledProtocols(Collection<String>) - Method in class io.helidon.webserver.WebServerTls.Builder
-
Configures the TLS protocols to enable with the server socket.
- enabledSslProtocols() - Method in interface io.helidon.webserver.SocketConfiguration
-
Deprecated, for removal: This API element is subject to removal in a future version.use
tls().enabledTlsProtocols()
instead. This method will be removed at 3.0.0 version. - enabledSSlProtocols(String...) - Method in class io.helidon.webserver.ServerConfiguration.Builder
-
Deprecated.Configures the SSL protocols to enable with the default server socket.
- enabledSSlProtocols(String...) - Method in class io.helidon.webserver.SocketConfiguration.Builder
-
Deprecated.since 2.0.0, please use
WebServerTls.Builder.enabledProtocols(String...)
instead - enabledSSlProtocols(List<String>) - Method in class io.helidon.webserver.ServerConfiguration.Builder
-
Deprecated.Configures the SSL protocols to enable with the default server socket.
- enabledSSlProtocols(List<String>) - Method in class io.helidon.webserver.SocketConfiguration.Builder
-
Deprecated.
- encode(String) - Static method in class io.helidon.webserver.HtmlEncoder
-
Encode HTML string replacing the special characters by their corresponding entities.
- entity(byte[]) - Method in class io.helidon.webserver.DirectHandler.TransportResponse.Builder
-
Custom entity.
- entity(String) - Method in class io.helidon.webserver.DirectHandler.TransportResponse.Builder
-
Custom entity.
- envConfig(TracingConfig) - Method in class io.helidon.webserver.WebTracingConfig.Builder
-
Use the provided configuration as a default for any request.
- error(Class<T>, ErrorHandler<T>) - Method in class io.helidon.webserver.Routing.Builder
-
Registers an error handler that handles the given type of exceptions.
- ErrorHandler<T extends Throwable> - Interface in io.helidon.webserver
-
The routing error handler.
- exceptionCaught(ChannelHandlerContext, Throwable) - Method in class io.helidon.webserver.ForwardingHandler
-
Overrides behavior when exception is thrown in pipeline.
- experimental() - Method in interface io.helidon.webserver.ServerConfiguration
-
Returns an
ExperimentalConfiguration
. - experimental(ExperimentalConfiguration) - Method in class io.helidon.webserver.ServerConfiguration.Builder
-
Deprecated.Configure experimental features.
- experimental(ExperimentalConfiguration) - Method in class io.helidon.webserver.WebServer.Builder
-
Configure experimental features.
- ExperimentalConfiguration - Interface in io.helidon.webserver
-
Interface ExperimentalConfiguration.
- ExperimentalConfiguration.Builder - Class in io.helidon.webserver
-
Builder for
ExperimentalConfiguration
. - expires() - Method in interface io.helidon.webserver.ResponseHeaders
-
Optionally gets the value of "Expires" header.
- expires(Instant) - Method in interface io.helidon.webserver.ResponseHeaders
-
Sets the value of "Expires" header.
- expires(ZonedDateTime) - Method in interface io.helidon.webserver.ResponseHeaders
-
Sets the value of "Expires" header.
F
- flush() - Method in class io.helidon.webserver.ByteBufDataChunk
- FormParamsSupport - Class in io.helidon.webserver
-
Deprecated.use
DefaultMediaSupport.formParamReader()
instead - FormParamsSupport() - Constructor for class io.helidon.webserver.FormParamsSupport
-
Deprecated.
- ForwardingHandler - Class in io.helidon.webserver
-
ForwardingHandler bridges Netty response and request related APIs to
BareRequest
andBareResponse
.
G
- get(Handler...) - Method in class io.helidon.webserver.Routing.Builder
- get(Handler...) - Method in interface io.helidon.webserver.Routing.Rules
-
Routes all GET requests to provided handler(s).
- get(PathMatcher, Handler...) - Method in class io.helidon.webserver.Routing.Builder
- get(PathMatcher, Handler...) - Method in interface io.helidon.webserver.Routing.Rules
-
Routes GET requests with corresponding path to provided handler(s).
- get(String, Handler...) - Method in class io.helidon.webserver.Routing.Builder
- get(String, Handler...) - Method in interface io.helidon.webserver.Routing.Rules
-
Routes GET requests with corresponding path to provided handler(s).
H
- handle(DirectHandler.TransportRequest, DirectHandler.EventType, Http.ResponseStatus, String) - Method in interface io.helidon.webserver.DirectHandler
-
Handler of responses that bypass routing, MUST NOT block the current thread.
- handle(DirectHandler.TransportRequest, DirectHandler.EventType, Http.ResponseStatus, Throwable) - Method in interface io.helidon.webserver.DirectHandler
-
Handler of responses that bypass routing, MUST NOT block the current thread.
- Handler - Interface in io.helidon.webserver
-
The
ServerRequest
andServerResponse
handler. - Handler.EntityHandler<T> - Interface in io.helidon.webserver
- hasContentType(MediaType...) - Method in class io.helidon.webserver.RequestPredicate
-
Only accept requests with any of the given content types.
- hasContentType(String...) - Method in class io.helidon.webserver.RequestPredicate
-
Only accept requests with any of the given content types.
- hasSocket(String) - Method in class io.helidon.webserver.WebServer.Builder
-
A method to validate a named socket configuration exists in this builder.
- hasTls() - Method in interface io.helidon.webserver.WebServer
-
Returns
true
if TLS is configured for the default socket. - hasTls(String) - Method in interface io.helidon.webserver.WebServer
-
Returns
true
if TLS is configured for the named socket. - head(Handler...) - Method in class io.helidon.webserver.Routing.Builder
- head(Handler...) - Method in interface io.helidon.webserver.Routing.Rules
-
Routes all HEAD requests to provided handler(s).
- head(PathMatcher, Handler...) - Method in class io.helidon.webserver.Routing.Builder
- head(PathMatcher, Handler...) - Method in interface io.helidon.webserver.Routing.Rules
-
Routes HEAD requests with corresponding path to provided handler(s).
- head(String, Handler...) - Method in class io.helidon.webserver.Routing.Builder
- head(String, Handler...) - Method in interface io.helidon.webserver.Routing.Rules
-
Routes HEAD requests with corresponding path to provided handler(s).
- header(String, String...) - Method in class io.helidon.webserver.DirectHandler.TransportResponse.Builder
-
Add/replace a header.
- headers() - Method in interface io.helidon.webserver.BareRequest
-
Gets http request headers.
- headers() - Method in interface io.helidon.webserver.DirectHandler.TransportRequest
-
Headers, if found in request.
- headers() - Method in interface io.helidon.webserver.ServerRequest
-
Returns http request headers.
- headers() - Method in interface io.helidon.webserver.ServerResponse
-
Returns response headers.
- host(String) - Method in interface io.helidon.webserver.SocketConfiguration.SocketConfigurationBuilder
-
A helper method that just calls
SocketConfiguration.SocketConfigurationBuilder.bindAddress(String)
. - HtmlEncoder - Class in io.helidon.webserver
-
HTML encoding of special characters to prevent cross site scripting (XSS) attacks.
- http2() - Method in interface io.helidon.webserver.ExperimentalConfiguration
-
Config property to set HTTP/2 configuration.
- http2(Http2Configuration) - Method in class io.helidon.webserver.ExperimentalConfiguration.Builder
-
Sets value for HTTP/2 configuration.
- Http2Configuration - Interface in io.helidon.webserver
-
Interface Http2Configuration.
- Http2Configuration.Builder - Class in io.helidon.webserver
-
Builder for
Http2Configuration
. - HttpException - Exception in io.helidon.webserver
-
Runtime exception for applications.
- HttpException(String) - Constructor for exception io.helidon.webserver.HttpException
-
Creates
HttpException
associated withHttp.Status.INTERNAL_SERVER_ERROR_500
. - HttpException(String, Http.ResponseStatus) - Constructor for exception io.helidon.webserver.HttpException
-
Creates
HttpException
. - HttpException(String, Http.ResponseStatus, Throwable) - Constructor for exception io.helidon.webserver.HttpException
-
Creates
HttpException
. - HttpException(String, Throwable) - Constructor for exception io.helidon.webserver.HttpException
-
Creates
HttpException
associated withHttp.Status.INTERNAL_SERVER_ERROR_500
.
I
- ifModifiedSince() - Method in interface io.helidon.webserver.RequestHeaders
-
Optionally returns a value of "If-Modified-Since" header.
- ifUnmodifiedSince() - Method in interface io.helidon.webserver.RequestHeaders
-
Optionally returns a value of "If-Unmodified-Since" header.
- IllegalPathPatternException - Exception in io.helidon.webserver
-
Cannot parse path pattern.
- IllegalPathPatternException(String, String, int) - Constructor for exception io.helidon.webserver.IllegalPathPatternException
-
Creates new instance.
- index() - Method in exception io.helidon.webserver.IllegalPathPatternException
-
Index of character.
- initialBufferSize() - Method in interface io.helidon.webserver.SocketConfiguration
-
Initial size of the buffer used to parse HTTP line and headers.
- initialBufferSize(int) - Method in class io.helidon.webserver.SocketConfiguration.Builder
-
Configure initial size of the buffer used to parse HTTP line and headers.
- io.helidon.webserver - module io.helidon.webserver
-
Reactive web server.
- io.helidon.webserver - package io.helidon.webserver
-
Reactive web server API.
- isAccepted(MediaType) - Method in interface io.helidon.webserver.RequestHeaders
-
Test if the given media type is acceptable as a response for this request.
- isAvailableFor(WebServer) - Method in interface io.helidon.webserver.Transport
- isBackedBy(Class<T>) - Method in class io.helidon.webserver.ByteBufDataChunk
- isHttp2Enabled() - Method in interface io.helidon.webserver.ServerConfiguration
-
Checks if HTTP/2 is enabled in config.
- isOfMethod(Http.Method...) - Method in class io.helidon.webserver.RequestPredicate
-
Accepts only requests with one of specified HTTP methods.
- isOfMethod(String...) - Method in class io.helidon.webserver.RequestPredicate
-
Accepts only requests with one of specified HTTP methods.
- isReadOnly() - Method in class io.helidon.webserver.ByteBufDataChunk
- isReleased() - Method in class io.helidon.webserver.ByteBufDataChunk
- isRunning() - Method in interface io.helidon.webserver.WebServer
-
Returns
true
if the server is currently running. - isSecure() - Method in interface io.helidon.webserver.BareRequest
-
Gets an indicating whether this request was made using a secure channel, such as HTTPS.
- isSecure() - Method in interface io.helidon.webserver.ServerRequest
-
Returns an indicating whether this request was made using a secure channel, such as HTTPS.
- iterator() - Method in class io.helidon.webserver.ByteBufDataChunk
J
- JsonService - Class in io.helidon.webserver
- JsonService() - Constructor for class io.helidon.webserver.JsonService
K
- KeyPerformanceIndicatorSupport - Interface in io.helidon.webserver
-
Definitions and factory methods for key performance indicator
KeyPerformanceIndicatorSupport.Context
andKeyPerformanceIndicatorSupport.Metrics
. - KeyPerformanceIndicatorSupport.Context - Interface in io.helidon.webserver
-
Per-request key performance indicator context, with behavior common to immediately-processed requests and deferrable ones.
- KeyPerformanceIndicatorSupport.DeferrableRequestContext - Interface in io.helidon.webserver
-
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 - Interface in io.helidon.webserver
-
Key performance indicator metrics behavior.
L
- lastModified() - Method in interface io.helidon.webserver.ResponseHeaders
-
Optionally gets the value of "Last-Modified" header.
- lastModified(Instant) - Method in interface io.helidon.webserver.ResponseHeaders
-
Sets the value of "Last-Modified" header.
- lastModified(ZonedDateTime) - Method in interface io.helidon.webserver.ResponseHeaders
-
Sets the value of "Last-Modified" header.
- localAddress() - Method in interface io.helidon.webserver.BareRequest
-
Gets the Internet Protocol (IP) address of the interface on which the request was received.
- localAddress() - Method in interface io.helidon.webserver.ServerRequest
-
Returns the Internet Protocol (IP) address of the interface on which the request was received.
- localPort() - Method in interface io.helidon.webserver.BareRequest
-
Returns the Internet Protocol (IP) port number of the interface on which the request was received.
- localPort() - Method in interface io.helidon.webserver.ServerRequest
-
Returns the Internet Protocol (IP) port number of the interface on which the request was received.
- location() - Method in interface io.helidon.webserver.ResponseHeaders
-
Optionally gets the value of "Location" header.
- location(URI) - Method in interface io.helidon.webserver.ResponseHeaders
-
Sets the value of "Location" header.
M
- match(CharSequence) - Method in interface io.helidon.webserver.PathMatcher
-
Matches this matcher against a URI path.
- matches() - Method in interface io.helidon.webserver.PathMatcher.Result
-
Whether the tested vector matches the associated path template.
- maxChunkSize() - Method in interface io.helidon.webserver.SocketConfiguration
-
Maximal size of a single chunk of received data.
- maxChunkSize(int) - Method in class io.helidon.webserver.SocketConfiguration.Builder
-
Configure maximal size of a chunk to be read from incoming requests.
- maxContentLength() - Method in interface io.helidon.webserver.Http2Configuration
-
Default HTTP/2 content length.
- maxContentLength(int) - Method in class io.helidon.webserver.Http2Configuration.Builder
-
Sets max content length for HTTP/2.
- maxHeaderSize() - Method in interface io.helidon.webserver.SocketConfiguration
-
Maximal size of all headers combined.
- maxHeaderSize(int) - Method in class io.helidon.webserver.ServerConfiguration.Builder
-
Deprecated.
- maxHeaderSize(int) - Method in class io.helidon.webserver.SocketConfiguration.Builder
- maxHeaderSize(int) - Method in interface io.helidon.webserver.SocketConfiguration.SocketConfigurationBuilder
-
Maximal number of bytes of all header values combined.
- maxHeaderSize(int) - Method in class io.helidon.webserver.WebServer.Builder
- maxInitialLineLength() - Method in interface io.helidon.webserver.SocketConfiguration
-
Maximal length of the initial HTTP line.
- maxInitialLineLength(int) - Method in class io.helidon.webserver.ServerConfiguration.Builder
-
Deprecated.
- maxInitialLineLength(int) - Method in class io.helidon.webserver.SocketConfiguration.Builder
- maxInitialLineLength(int) - Method in interface io.helidon.webserver.SocketConfiguration.SocketConfigurationBuilder
-
Maximal number of characters in the initial HTTP line.
- maxInitialLineLength(int) - Method in class io.helidon.webserver.WebServer.Builder
- maxPayloadSize() - Method in interface io.helidon.webserver.SocketConfiguration
-
Maximum size allowed for an HTTP payload in a client request.
- maxPayloadSize(long) - Method in class io.helidon.webserver.ServerConfiguration.Builder
-
Deprecated.Configure maximum client payload size.
- maxPayloadSize(long) - Method in class io.helidon.webserver.SocketConfiguration.Builder
- maxPayloadSize(long) - Method in interface io.helidon.webserver.SocketConfiguration.SocketConfigurationBuilder
-
Set a maximum payload size for a client request.
- maxPayloadSize(long) - Method in class io.helidon.webserver.WebServer.Builder
- maxShutdownTimeout() - Method in interface io.helidon.webserver.ServerConfiguration
-
The maximum amount of time that the server will wait to shut down regardless of the value of any additionally requested quiet period.
- maxShutdownTimeout(Duration) - Method in class io.helidon.webserver.ServerConfiguration.Builder
-
Deprecated.Configure the maximum amount of time that the server will wait to shut down regardless of the value of any additionally requested quiet period.
- mediaContext(MediaContext) - Method in class io.helidon.webserver.WebServer.Builder
- method() - Method in interface io.helidon.webserver.BareRequest
-
Gets an HTTP request method.
- method() - Method in interface io.helidon.webserver.DirectHandler.TransportRequest
-
HTTP method.
- methods() - Method in interface io.helidon.webserver.PathTracingConfig
-
Method(s) this configuration should be valid for.
- methods(List<String>) - Method in class io.helidon.webserver.PathTracingConfig.Builder
-
HTTP methods to restrict registration of this configuration on web server.
N
- name() - Method in interface io.helidon.webserver.SocketConfiguration
-
Name of this socket.
- name(String) - Method in class io.helidon.webserver.SocketConfiguration.Builder
-
Configure a socket name, to bind named routings to.
- namedSocket(String) - Method in interface io.helidon.webserver.ServerConfiguration
-
A socket configuration of an additional named server socket.
- negate() - Method in class io.helidon.webserver.RequestPredicate
-
Return a predicate that represents the logical negation of this predicate.
- next() - Method in interface io.helidon.webserver.ServerRequest
-
Continue request processing on the next registered handler.
- next(Throwable) - Method in interface io.helidon.webserver.ServerRequest
-
Continues or enters an error branch of a request processing.
- NO_CACHING - io.helidon.webserver.ServerResponse.CachingStrategy
-
Discourage caching.
- NO_OP - Static variable in interface io.helidon.webserver.KeyPerformanceIndicatorSupport.Context
-
No-op implementation of
Context
. - NO_OP - Static variable in interface io.helidon.webserver.KeyPerformanceIndicatorSupport.Metrics
-
No-op implementation of
Metrics
. - NONE - io.helidon.webserver.ClientAuthentication
-
Authentication is not required.
- NORMAL - io.helidon.webserver.ServerResponse.CachingStrategy
-
Normal cache control: permit caching but prohibit transforming the content.
- NotFoundException - Exception in io.helidon.webserver
-
A runtime exception indicating a
not found
. - NotFoundException(String) - Constructor for exception io.helidon.webserver.NotFoundException
-
Creates
NotFoundException
. - NotFoundException(String, Throwable) - Constructor for exception io.helidon.webserver.NotFoundException
-
Creates
NotFoundException
.
O
- onComplete() - Method in interface io.helidon.webserver.BareResponse
-
Response should be flushed and closed.
- onError(Throwable) - Method in interface io.helidon.webserver.BareResponse
-
Response should be flushed and closed.
- onNewWebServer(Consumer<WebServer>) - Method in class io.helidon.webserver.Routing.Builder
- onNewWebServer(Consumer<WebServer>) - Method in interface io.helidon.webserver.Routing.Rules
-
Registers callback on created new
WebServer
instance with this routing. - onNext(DataChunk) - Method in interface io.helidon.webserver.BareResponse
-
Provided
ByteBuffer
MUST be fully read during the method call. - onRequestCompleted(boolean, long) - Method in interface io.helidon.webserver.KeyPerformanceIndicatorSupport.Metrics
-
Invoked when processing on a request has finished.
- onRequestReceived() - Method in interface io.helidon.webserver.KeyPerformanceIndicatorSupport.Metrics
-
Invoked when a request has been received.
- onRequestStarted() - Method in interface io.helidon.webserver.KeyPerformanceIndicatorSupport.Metrics
-
Invoked when processing on a request has been started.
- onSubscribe(Flow.Subscription) - Method in interface io.helidon.webserver.BareResponse
-
Each response is subscribed up to a single publisher and AFTER
BareResponse.writeStatusAndHeaders(Http.ResponseStatus, Map)
method is called and returned. - OPTIONAL - io.helidon.webserver.ClientAuthentication
-
Authentication is optional.
- options(Handler...) - Method in class io.helidon.webserver.Routing.Builder
- options(Handler...) - Method in interface io.helidon.webserver.Routing.Rules
-
Routes all OPTIONS requests to provided handler(s).
- options(PathMatcher, Handler...) - Method in class io.helidon.webserver.Routing.Builder
- options(PathMatcher, Handler...) - Method in interface io.helidon.webserver.Routing.Rules
-
Routes OPTIONS requests with corresponding path to provided handler(s).
- options(String, Handler...) - Method in class io.helidon.webserver.Routing.Builder
- options(String, Handler...) - Method in interface io.helidon.webserver.Routing.Rules
-
Routes OPTIONS requests with corresponding path to provided handler(s).
- or(Predicate<ServerRequest>) - Method in class io.helidon.webserver.RequestPredicate
-
Returns a composed predicate that represents a logical OR expression between this predicate and another predicate.
- otherwise(Handler) - Method in class io.helidon.webserver.RequestPredicate.ConditionalHandler
-
Set the
Handler
to use when the predicate does not match the request.
P
- param(String) - Method in interface io.helidon.webserver.PathMatcher.Result
-
Get value for a given parameter of the associated path matcher.
- params() - Method in interface io.helidon.webserver.PathMatcher.Result
-
Returns the values of parameters that were specified in the associated path template.
- patch(Handler...) - Method in class io.helidon.webserver.Routing.Builder
- patch(Handler...) - Method in interface io.helidon.webserver.Routing.Rules
-
Routes all RFC 5789 PATCH requests to provided handler(s).
- patch(PathMatcher, Handler...) - Method in class io.helidon.webserver.Routing.Builder
- patch(PathMatcher, Handler...) - Method in interface io.helidon.webserver.Routing.Rules
-
Routes RFC 5789 PATCH requests with corresponding path to provided handler(s).
- patch(String, Handler...) - Method in class io.helidon.webserver.Routing.Builder
- patch(String, Handler...) - Method in interface io.helidon.webserver.Routing.Rules
-
Routes RFC 5789 PATCH requests with corresponding path to provided handler(s).
- path() - Method in interface io.helidon.webserver.PathTracingConfig
-
Path this configuration should configure.
- path(String) - Method in class io.helidon.webserver.PathTracingConfig.Builder
-
Path to register the traced configuration on.
- PathMatcher - Interface in io.helidon.webserver
-
URI Path Matcher.
- PathMatcher.PrefixResult - Interface in io.helidon.webserver
-
The result of prefix matching a
PathMatcher
to a given URI path. - PathMatcher.Result - Interface in io.helidon.webserver
-
The result of matching a
PathMatcher
to a given URI path. - PathTracingConfig - Interface in io.helidon.webserver
-
Traced system configuration for web server for a specific path.
- PathTracingConfig.Builder - Class in io.helidon.webserver
-
Fluent API builder for
PathTracingConfig
. - pattern() - Method in exception io.helidon.webserver.IllegalPathPatternException
-
Illegal used pattern.
- PAYLOAD_TOO_LARGE - io.helidon.webserver.DirectHandler.EventType
-
Payload is bigger than the configured maximal size.
- port() - Method in interface io.helidon.webserver.ServerConfiguration
-
Returns a server port to listen on with the default server socket.
- port() - Method in interface io.helidon.webserver.SocketConfiguration
-
Returns a server port to listen on with the server socket.
- port() - Method in interface io.helidon.webserver.WebServer
-
Returns a port number the default server socket is bound to and is listening on; or
-1
if unknown or not active. - port(int) - Method in class io.helidon.webserver.ServerConfiguration.Builder
-
Deprecated.Sets server port.
- port(int) - Method in class io.helidon.webserver.SocketConfiguration.Builder
- port(int) - Method in interface io.helidon.webserver.SocketConfiguration.SocketConfigurationBuilder
-
Configures a server port to listen on with the server socket.
- port(int) - Method in class io.helidon.webserver.WebServer.Builder
- port(String) - Method in interface io.helidon.webserver.WebServer
-
Returns a port number an additional named server socket is bound to and is listening on; or
-1
if unknown or not active. - post(Handler...) - Method in class io.helidon.webserver.Routing.Builder
- post(Handler...) - Method in interface io.helidon.webserver.Routing.Rules
-
Routes all POST requests to provided handler(s).
- post(PathMatcher, Handler...) - Method in class io.helidon.webserver.Routing.Builder
- post(PathMatcher, Handler...) - Method in interface io.helidon.webserver.Routing.Rules
-
Routes POST requests with corresponding path to provided handler(s).
- post(String, Handler...) - Method in class io.helidon.webserver.Routing.Builder
- post(String, Handler...) - Method in interface io.helidon.webserver.Routing.Rules
-
Routes POST requests with corresponding path to provided handler(s).
- prefixMatch(CharSequence) - Method in interface io.helidon.webserver.PathMatcher
-
Matches this matcher against a left part (prefix) of URI path with granularity on the path segment.
- printFeatureDetails() - Method in interface io.helidon.webserver.ServerConfiguration
-
Whether to print details of
HelidonFeatures
. - printFeatureDetails(boolean) - Method in class io.helidon.webserver.ServerConfiguration.Builder
-
Deprecated.Set to
true
to print detailed feature information on startup. - printFeatureDetails(boolean) - Method in class io.helidon.webserver.WebServer.Builder
-
Set to
true
to print detailed feature information on startup. - privateKey(KeyConfig) - Method in class io.helidon.webserver.WebServerTls.Builder
-
Configure private key to use for SSL context.
- privateKey(Supplier<KeyConfig>) - Method in class io.helidon.webserver.WebServerTls.Builder
-
Configure private key to use for SSL context.
- protocolVersion() - Method in interface io.helidon.webserver.DirectHandler.TransportRequest
-
Protocol version (either from actual request, or guessed).
- put(Handler...) - Method in class io.helidon.webserver.Routing.Builder
- put(Handler...) - Method in interface io.helidon.webserver.Routing.Rules
-
Routes all PUT requests to provided handler(s).
- put(PathMatcher, Handler...) - Method in class io.helidon.webserver.Routing.Builder
- put(PathMatcher, Handler...) - Method in interface io.helidon.webserver.Routing.Rules
-
Routes PUT requests with corresponding path to provided handler(s).
- put(String, Handler...) - Method in class io.helidon.webserver.Routing.Builder
- put(String, Handler...) - Method in interface io.helidon.webserver.Routing.Rules
-
Routes PUT requests with corresponding path to provided handler(s).
- putAll(Parameters) - Method in interface io.helidon.webserver.ResponseHeaders
R
- readerContext() - Method in interface io.helidon.webserver.WebServer
-
Get the parent
MessageBodyReaderContext
context. - receiveBufferSize() - Method in interface io.helidon.webserver.ServerConfiguration
-
Returns proposed value of the TCP receive window that is advertised to the remote peer on the default server socket.
- receiveBufferSize() - Method in interface io.helidon.webserver.SocketConfiguration
-
Returns proposed value of the TCP receive window that is advertised to the remote peer on the server socket.
- receiveBufferSize(int) - Method in class io.helidon.webserver.ServerConfiguration.Builder
-
Deprecated.Propose value of the TCP receive window that is advertised to the remote peer.
- receiveBufferSize(int) - Method in class io.helidon.webserver.SocketConfiguration.Builder
-
Configures proposed value of the TCP receive window that is advertised to the remote peer on the server socket.
- receiveBufferSize(int) - Method in interface io.helidon.webserver.SocketConfiguration.SocketConfigurationBuilder
-
Configures proposed value of the TCP receive window that is advertised to the remote peer on the server socket.
- receiveBufferSize(int) - Method in class io.helidon.webserver.WebServer.Builder
- referer() - Method in interface io.helidon.webserver.RequestHeaders
-
Optionally returns the address of the previous web page (header "Referer") from which a link to the currently requested page was followed.
- register(Service...) - Method in class io.helidon.webserver.Routing.Builder
- register(Service...) - Method in interface io.helidon.webserver.Routing.Rules
-
Registers builder consumer.
- register(WebTracingConfig) - Method in class io.helidon.webserver.Routing.Builder
- register(WebTracingConfig) - Method in interface io.helidon.webserver.Routing.Rules
-
Configuration of tracing for this routing.
- register(String, Service...) - Method in class io.helidon.webserver.Routing.Builder
- register(String, Service...) - Method in interface io.helidon.webserver.Routing.Rules
-
Registers builder consumer.
- register(String, Supplier<? extends Service>...) - Method in class io.helidon.webserver.Routing.Builder
- register(String, Supplier<? extends Service>...) - Method in interface io.helidon.webserver.Routing.Rules
-
Registers builder consumer.
- register(Supplier<? extends Service>...) - Method in class io.helidon.webserver.Routing.Builder
- register(Supplier<? extends Service>...) - Method in interface io.helidon.webserver.Routing.Rules
-
Registers builder consumer.
- registerFilter(MessageBodyFilter) - Method in interface io.helidon.webserver.ServerResponse
- registerFilter(Function<Flow.Publisher<DataChunk>, Flow.Publisher<DataChunk>>) - Method in interface io.helidon.webserver.ServerResponse
-
Deprecated.since 2.0.0, use
ServerResponse.registerFilter(io.helidon.media.common.MessageBodyFilter)
instead - registerWriter(MessageBodyStreamWriter<?>) - Method in interface io.helidon.webserver.ServerResponse
- registerWriter(MessageBodyWriter<?>) - Method in interface io.helidon.webserver.ServerResponse
- registerWriter(Class<T>, MediaType, Function<? extends T, Flow.Publisher<DataChunk>>) - Method in interface io.helidon.webserver.ServerResponse
-
Deprecated.since 2.0.0, use
ServerResponse.registerWriter(io.helidon.media.common.MessageBodyWriter)
instead - registerWriter(Class<T>, Function<T, Flow.Publisher<DataChunk>>) - Method in interface io.helidon.webserver.ServerResponse
-
Deprecated.Since 2.0.0, use
ServerResponse.registerWriter(io.helidon.media.common.MessageBodyWriter)
instead - registerWriter(Predicate<?>, MediaType, Function<T, Flow.Publisher<DataChunk>>) - Method in interface io.helidon.webserver.ServerResponse
-
Deprecated.since 2.0.0, use
ServerResponse.registerWriter(io.helidon.media.common.MessageBodyWriter)
instead - registerWriter(Predicate<?>, Function<T, Flow.Publisher<DataChunk>>) - Method in interface io.helidon.webserver.ServerResponse
-
Deprecated.since 2.0.0, use
ServerResponse.registerWriter(io.helidon.media.common.MessageBodyWriter)
instead - release() - Method in class io.helidon.webserver.ByteBufDataChunk
- remaining() - Method in class io.helidon.webserver.ByteBufDataChunk
- remainingPart() - Method in interface io.helidon.webserver.PathMatcher.PrefixResult
-
In case of prefix match this returns the reminder that wasn't matched.
- remoteAddress() - Method in interface io.helidon.webserver.BareRequest
-
Gets the Internet Protocol (IP) address of the client or last proxy that sent the request.
- remoteAddress() - Method in interface io.helidon.webserver.ServerRequest
-
Returns the Internet Protocol (IP) address of the client or last proxy that sent the request.
- remotePort() - Method in interface io.helidon.webserver.BareRequest
-
Returns the Internet Protocol (IP) source port of the client or last proxy that sent the request.
- remotePort() - Method in interface io.helidon.webserver.ServerRequest
-
Returns the Internet Protocol (IP) source port of the client or last proxy that sent the request.
- requestHandlingCompleted(boolean) - Method in interface io.helidon.webserver.KeyPerformanceIndicatorSupport.Context
-
Records that handling of a request has completed.
- requestHandlingStarted(KeyPerformanceIndicatorSupport.Metrics) - Method in interface io.helidon.webserver.KeyPerformanceIndicatorSupport.Context
-
Records that handling of the request is about to begin.
- RequestHeaders - Interface in io.helidon.webserver
-
Extends
Parameters
interface by adding HTTP request headers oriented convenient methods. - requestId() - Method in interface io.helidon.webserver.BareRequest
-
A unique correlation ID that is associated with this request and its associated response.
- requestId() - Method in interface io.helidon.webserver.BareResponse
-
A unique correlation ID that is associated with this response and its associated request.
- requestId() - Method in interface io.helidon.webserver.ServerRequest
-
A unique correlation ID that is associated with this request and its associated response.
- requestId() - Method in interface io.helidon.webserver.ServerResponse
-
A unique correlation ID that is associated with this response and its associated request.
- RequestPredicate - Class in io.helidon.webserver
-
Fluent API that allows to create chains of request conditions for composing logical expressions to match requests.
- RequestPredicate.ConditionalHandler - Class in io.helidon.webserver
- requestProcessingCompleted(boolean) - Method in interface io.helidon.webserver.KeyPerformanceIndicatorSupport.Context
-
Records that a request has completed its processing.
- requestProcessingStarted() - Method in interface io.helidon.webserver.KeyPerformanceIndicatorSupport.DeferrableRequestContext
-
Records that a request is about to begin its processing.
- REQUIRE - io.helidon.webserver.ClientAuthentication
-
Authentication is required.
- ResponseHeaders - Interface in io.helidon.webserver
-
Extends
Parameters
interface by adding HTTP response headers oriented constants and convenient methods. - route(BareRequest, BareResponse) - Method in interface io.helidon.webserver.Routing
-
Process bare minimal request and response using this routing.
- routing(Routing) - Method in class io.helidon.webserver.WebServer.Builder
-
Configure the default routing of this WebServer.
- routing(Supplier<Routing>) - Method in class io.helidon.webserver.WebServer.Builder
-
Configure the default routing of this WebServer.
- Routing - Interface in io.helidon.webserver
-
Routing represents composition of HTTP request-response handlers with routing rules.
- Routing.Builder - Class in io.helidon.webserver
-
A
Routing
builder. - Routing.Rules - Interface in io.helidon.webserver
-
An API to define HTTP request routing rules.
S
- send() - Method in interface io.helidon.webserver.ResponseHeaders
-
Send headers and status code to the client.
- send() - Method in interface io.helidon.webserver.ServerResponse
-
Sends an empty response.
- send(Throwable) - Method in interface io.helidon.webserver.ServerResponse
-
Send a
Throwable
and close the response. - send(Flow.Publisher<DataChunk>) - Method in interface io.helidon.webserver.ServerResponse
-
Send a message as is without any other marshalling, registered filters are applied.
- send(Flow.Publisher<DataChunk>, boolean) - Method in interface io.helidon.webserver.ServerResponse
-
Send a message as is without any other marshalling.
- send(Flow.Publisher<T>, Class<T>) - Method in interface io.helidon.webserver.ServerResponse
-
Send a message with the given entity stream as content and close the response.
- send(Function<MessageBodyWriterContext, Flow.Publisher<DataChunk>>) - Method in interface io.helidon.webserver.ServerResponse
-
Send a message using the given marshalling function.
- send(T) - Method in interface io.helidon.webserver.ServerResponse
-
Send a message and close the response.
- ServerConfiguration - Interface in io.helidon.webserver
-
WebServer
configuration. - ServerConfiguration.Builder - Class in io.helidon.webserver
-
Deprecated.since 2.0.0 - use
WebServer.Builder
instead - ServerRequest - Interface in io.helidon.webserver
-
Represents HTTP Request and provides WebServer related API.
- ServerResponse - Interface in io.helidon.webserver
-
Represents HTTP Response.
- ServerResponse.CachingStrategy - Enum in io.helidon.webserver
-
Declares common groups of
Cache-Control
settings. - Service - Interface in io.helidon.webserver
-
Encapsulates a set of
routing
rules and related logic. - sessionCacheSize(long) - Method in class io.helidon.webserver.SSLContextBuilder
-
Deprecated.since 2.0.0, please use
WebServerTls.builder()
instead, then configure it withWebServer.Builder.tls(WebServerTls)
orSocketConfiguration.SocketConfigurationBuilder.tls(WebServerTls)
- sessionCacheSize(long) - Method in class io.helidon.webserver.WebServerTls.Builder
-
Set the size of the cache used for storing SSL session objects.
- sessionTimeout(long) - Method in class io.helidon.webserver.SSLContextBuilder
-
Deprecated.since 2.0.0, please use
WebServerTls.builder()
instead, then configure it withWebServer.Builder.tls(WebServerTls)
orSocketConfiguration.SocketConfigurationBuilder.tls(WebServerTls)
- sessionTimeout(long, TimeUnit) - Method in class io.helidon.webserver.WebServerTls.Builder
-
Set the timeout for the cached SSL session objects.
- sessionTimeoutSeconds(long) - Method in class io.helidon.webserver.WebServerTls.Builder
-
Set the timeout for the cached SSL session objects, in seconds.
- shutdown() - Method in interface io.helidon.webserver.WebServer
-
Attempt to gracefully shutdown server.
- shutdownQuietPeriod() - Method in interface io.helidon.webserver.ServerConfiguration
-
The quiet period during which the webserver will wait for new incoming connections after it has been told to shut down.
- shutdownQuietPeriod(Duration) - Method in class io.helidon.webserver.ServerConfiguration.Builder
-
Deprecated.Configure the quiet period during which the webserver will wait for new incoming connections after it has been told to shut down.
- socket(String) - Method in interface io.helidon.webserver.ServerConfiguration
-
Deprecated.since 2.0.0, please use
ServerConfiguration.namedSocket(String)
instead - SocketClosedException - Exception in io.helidon.webserver
-
Signals that socket was closed before server request it.
- SocketClosedException(String) - Constructor for exception io.helidon.webserver.SocketClosedException
-
Creates new instance.
- SocketClosedException(String, Throwable) - Constructor for exception io.helidon.webserver.SocketClosedException
-
Creates new instance.
- SocketClosedException(Throwable) - Constructor for exception io.helidon.webserver.SocketClosedException
-
Creates new instance.
- SocketConfiguration - Interface in io.helidon.webserver
-
The SocketConfiguration configures a port to listen on and its associated server socket parameters.
- SocketConfiguration.Builder - Class in io.helidon.webserver
-
The
SocketConfiguration
builder class. - SocketConfiguration.SocketConfigurationBuilder<B extends SocketConfiguration.SocketConfigurationBuilder<B>> - Interface in io.helidon.webserver
-
Socket configuration builder API, used by
SocketConfiguration.Builder
to configure additional sockets, and byWebServer.Builder
to configure the default socket. - sockets() - Method in interface io.helidon.webserver.ServerConfiguration
-
A map of all the configured server sockets; that is the default server socket which is identified by the key
ServerConfiguration.DEFAULT_SOCKET_NAME
and also all the additional named server socket configurations. - spanContext() - Method in interface io.helidon.webserver.ServerRequest
-
Returns a span context related to the current request.
- ssl() - Method in interface io.helidon.webserver.ServerConfiguration
-
Deprecated, for removal: This API element is subject to removal in a future version.use
tls().sslContext()
instead. This method will be removed at 3.0.0 version. - ssl() - Method in interface io.helidon.webserver.SocketConfiguration
-
Deprecated, for removal: This API element is subject to removal in a future version.use
tls().sslContext()
instead. This method will be removed at 3.0.0 version. - ssl(Supplier<? extends SSLContext>) - Method in class io.helidon.webserver.ServerConfiguration.Builder
-
Deprecated.Sets
SSLContext
to to use with the server. - ssl(Supplier<? extends SSLContext>) - Method in class io.helidon.webserver.SocketConfiguration.Builder
-
Deprecated.since 2.0.0, please use
SocketConfiguration.SocketConfigurationBuilder.tls(Supplier)
instead - ssl(SSLContext) - Method in class io.helidon.webserver.ServerConfiguration.Builder
-
Deprecated.Sets
SSLContext
to to use with the server. - ssl(SSLContext) - Method in class io.helidon.webserver.SocketConfiguration.Builder
-
Deprecated.since 2.0.0, please use
SocketConfiguration.Builder.tls(WebServerTls)
instead - sslContext(SSLContext) - Method in class io.helidon.webserver.WebServerTls.Builder
-
Configures a
SSLContext
to use with the server socket. - SSLContextBuilder - Class in io.helidon.webserver
-
Deprecated.since 2.0.0, please use
WebServerTls.builder()
instead, then configure it withWebServer.Builder.tls(WebServerTls)
orSocketConfiguration.SocketConfigurationBuilder.tls(WebServerTls)
- start() - Method in interface io.helidon.webserver.WebServer
-
Starts the server.
- StaticContentSupport - Class in io.helidon.webserver
-
Deprecated, for removal: This API element is subject to removal in a future version.please use module
helidon-webserver-static-content
- StaticContentSupport.Builder - Class in io.helidon.webserver
-
Deprecated.Fluent builder of the StaticContent detailed parameters.
- status() - Method in exception io.helidon.webserver.HttpException
-
Obtain the associated http status.
- status() - Method in interface io.helidon.webserver.ServerResponse
-
Returns actual response status code.
- status(int) - Method in interface io.helidon.webserver.ServerResponse
-
Sets new HTTP status code.
- status(Http.ResponseStatus) - Method in class io.helidon.webserver.DirectHandler.TransportResponse.Builder
-
Custom status.
- status(Http.ResponseStatus) - Method in interface io.helidon.webserver.ServerResponse
-
Sets new HTTP status.
T
- test(ServerRequest) - Method in class io.helidon.webserver.RequestPredicate
-
Evaluate this predicate.
- thenApply(Handler) - Method in class io.helidon.webserver.RequestPredicate
-
Set the
Handler
to use when this predicate matches the request. - timeout(int) - Method in class io.helidon.webserver.ServerConfiguration.Builder
-
Deprecated.Sets a socket timeout in milliseconds or
0
for infinite timeout. - timeout(long, TimeUnit) - Method in class io.helidon.webserver.ServerConfiguration.Builder
-
Deprecated.
- timeout(long, TimeUnit) - Method in class io.helidon.webserver.SocketConfiguration.Builder
- timeout(long, TimeUnit) - Method in interface io.helidon.webserver.SocketConfiguration.SocketConfigurationBuilder
-
Configures a server socket timeout.
- timeout(long, TimeUnit) - Method in class io.helidon.webserver.WebServer.Builder
- timeoutMillis() - Method in interface io.helidon.webserver.ServerConfiguration
-
Returns a default server socket timeout in milliseconds or
0
for an infinite timeout. - timeoutMillis() - Method in interface io.helidon.webserver.SocketConfiguration
-
Returns a server socket timeout in milliseconds or
0
for an infinite timeout. - timeoutMillis(int) - Method in class io.helidon.webserver.SocketConfiguration.Builder
-
Deprecated.since 2.0.0 please use
SocketConfiguration.Builder.timeout(long, java.util.concurrent.TimeUnit)
instead - tls() - Method in interface io.helidon.webserver.SocketConfiguration
-
Return a
WebServerTls
containing server TLS configuration. - tls(WebServerTls) - Method in class io.helidon.webserver.ServerConfiguration.Builder
-
Deprecated.
- tls(WebServerTls) - Method in class io.helidon.webserver.SocketConfiguration.Builder
- tls(WebServerTls) - Method in interface io.helidon.webserver.SocketConfiguration.SocketConfigurationBuilder
-
Configures SSL for this socket.
- tls(WebServerTls) - Method in class io.helidon.webserver.WebServer.Builder
- tls(Supplier<WebServerTls>) - Method in interface io.helidon.webserver.SocketConfiguration.SocketConfigurationBuilder
-
Configures SSL for this socket.
- tmpDir(Path) - Method in class io.helidon.webserver.StaticContentSupport.Builder
-
Deprecated.Sets custom temporary folder for extracting static content from a jar.
- toJsonResponseType(MediaType) - Method in class io.helidon.webserver.JsonService
-
Returns the response type for the given type if it is an accepted JSON type.
- trace(Handler...) - Method in class io.helidon.webserver.Routing.Builder
- trace(Handler...) - Method in interface io.helidon.webserver.Routing.Rules
-
Routes all TRACE requests to provided handler(s).
- trace(PathMatcher, Handler...) - Method in class io.helidon.webserver.Routing.Builder
- trace(PathMatcher, Handler...) - Method in interface io.helidon.webserver.Routing.Rules
-
Routes TRACE requests with corresponding path to provided handler(s).
- trace(String, Handler...) - Method in class io.helidon.webserver.Routing.Builder
- trace(String, Handler...) - Method in interface io.helidon.webserver.Routing.Rules
-
Routes TRACE requests with corresponding path to provided handler(s).
- tracedConfig() - Method in interface io.helidon.webserver.PathTracingConfig
-
Associated configuration of tracing valid for the configured path and (possibly) methods.
- tracer() - Method in interface io.helidon.webserver.ServerConfiguration
-
Returns an opentracing.io tracer.
- tracer() - Method in interface io.helidon.webserver.ServerRequest
- tracer(Tracer) - Method in class io.helidon.webserver.ServerConfiguration.Builder
-
Deprecated.Sets an opentracing.io tracer.
- tracer(Tracer) - Method in class io.helidon.webserver.WebServer.Builder
-
Sets an opentracing.io tracer.
- tracer(Supplier<? extends Tracer>) - Method in class io.helidon.webserver.ServerConfiguration.Builder
-
Deprecated.Sets an opentracing.io tracer.
- tracer(Supplier<? extends Tracer>) - Method in class io.helidon.webserver.WebServer.Builder
-
Sets an opentracing.io tracer.
- tracingConfig(TracingConfig) - Method in class io.helidon.webserver.PathTracingConfig.Builder
-
Configuration of a traced system to use on this path and possibly method(s).
- transport() - Method in interface io.helidon.webserver.ServerConfiguration
-
Returns an optional
Transport
. - transport(Transport) - Method in class io.helidon.webserver.ServerConfiguration.Builder
-
Deprecated.Configure transport.
- transport(Transport) - Method in class io.helidon.webserver.WebServer.Builder
- Transport - Interface in io.helidon.webserver
-
A very abstract notion of a transport for a particular implementation of the
WebServer
interface. - trust(KeyConfig) - Method in class io.helidon.webserver.WebServerTls.Builder
-
Set the trust key configuration to be used to validate certificates.
- trust(Supplier<KeyConfig>) - Method in class io.helidon.webserver.WebServerTls.Builder
-
Set the trust key configuration to be used to validate certificates.
- trustConfig(KeyConfig) - Method in class io.helidon.webserver.SSLContextBuilder
-
Deprecated.since 2.0.0, please use
WebServerTls.builder()
instead, then configure it withWebServer.Builder.tls(WebServerTls)
orSocketConfiguration.SocketConfigurationBuilder.tls(WebServerTls)
U
- UnsupportedBodyTypeException - Exception in io.helidon.webserver
-
Cannot marshal requested type.
- UnsupportedBodyTypeException(String) - Constructor for exception io.helidon.webserver.UnsupportedBodyTypeException
-
Constructs a new instance with the specified detail message.
- UnsupportedBodyTypeException(String, Throwable) - Constructor for exception io.helidon.webserver.UnsupportedBodyTypeException
-
Constructs a new runtime exception with the specified detail message and cause.
- update(Routing.Rules) - Method in class io.helidon.webserver.FormParamsSupport
-
Deprecated.
- update(Routing.Rules) - Method in class io.helidon.webserver.JsonService
-
Registers this handler for any HTTP method.
- update(Routing.Rules) - Method in interface io.helidon.webserver.Service
-
Updates
Routing.Rules
withhandlers
representing this service. - update(Routing.Rules) - Method in class io.helidon.webserver.StaticContentSupport
-
Deprecated.
- update(Consumer<WebServer.Builder>) - Method in class io.helidon.webserver.WebServer.Builder
-
A helper method to support fluentAPI when invoking another method.
- updateTls(WebServerTls) - Method in interface io.helidon.webserver.WebServer
-
Update the TLS configuration of the default socket
WebServer.DEFAULT_SOCKET_NAME
. - updateTls(WebServerTls, String) - Method in interface io.helidon.webserver.WebServer
-
Update the TLS configuration of the named socket.
- uri() - Method in interface io.helidon.webserver.BareRequest
-
Gets a Request-URI (or alternatively path) as defined in request line.
- uri() - Method in interface io.helidon.webserver.DirectHandler.TransportRequest
-
Requested URI, if found in request.
V
- validateHeaders() - Method in interface io.helidon.webserver.SocketConfiguration
-
Whether to validate HTTP header names.
- validateHeaders(boolean) - Method in class io.helidon.webserver.SocketConfiguration.Builder
-
Configure whether to validate header names.
- valueOf(String) - Static method in enum io.helidon.webserver.ClientAuthentication
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.helidon.webserver.DirectHandler.EventType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.helidon.webserver.ServerResponse.CachingStrategy
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum io.helidon.webserver.ClientAuthentication
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum io.helidon.webserver.DirectHandler.EventType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum io.helidon.webserver.ServerResponse.CachingStrategy
-
Returns an array containing the constants of this enum type, in the order they are declared.
- version() - Method in interface io.helidon.webserver.BareRequest
-
Gets an HTTP version from the request line such as
HTTP/1.1
.
W
- webServer() - Method in interface io.helidon.webserver.BareRequest
-
Gets actual
WebServer
instance. - webServer() - Method in interface io.helidon.webserver.ServerRequest
-
Returns actual
WebServer
instance. - webServer() - Method in interface io.helidon.webserver.ServerResponse
-
Returns actual
WebServer
instance. - WebServer - Interface in io.helidon.webserver
-
Represents a immutably configured WEB server.
- WebServer.Builder - Class in io.helidon.webserver
-
WebServer builder class provides a convenient way to set up WebServer with multiple server sockets and optional multiple routings.
- WebServerTls - Class in io.helidon.webserver
-
A class wrapping transport layer security (TLS) configuration for WebServer sockets.
- WebServerTls.Builder - Class in io.helidon.webserver
-
Fluent API builder for
WebServerTls
. - WebTracingConfig - Class in io.helidon.webserver
-
Tracing configuration for webserver.
- WebTracingConfig() - Constructor for class io.helidon.webserver.WebTracingConfig
- WebTracingConfig.Builder - Class in io.helidon.webserver
-
A fluent API builder for
WebTracingConfig
. - welcomeFileName(String) - Method in class io.helidon.webserver.StaticContentSupport.Builder
-
Deprecated.Sets a name of the "file" which will be returned if directory is requested.
- whenCompleted() - Method in interface io.helidon.webserver.BareResponse
-
Returns a
Single
of this response. - whenHeadersCompleted() - Method in interface io.helidon.webserver.BareResponse
-
Returns a
Single
of headers part of this response. - whenSend() - Method in interface io.helidon.webserver.ResponseHeaders
-
Deprecated.since 2.0.0, please use
ResponseHeaders.whenSent()
- whenSent() - Method in interface io.helidon.webserver.ResponseHeaders
-
Returns a
Single
which is completed when all headers are sent to the client. - whenSent() - Method in interface io.helidon.webserver.ServerResponse
-
Completion stage is completed when response is completed.
- whenShutdown() - Method in interface io.helidon.webserver.WebServer
-
Completion stage is completed when server is shut down.
- workersCount() - Method in interface io.helidon.webserver.ServerConfiguration
-
Returns the count of threads in the pool used to process HTTP requests.
- workersCount(int) - Method in class io.helidon.webserver.ServerConfiguration.Builder
-
Deprecated.Sets a count of threads in pool used to process HTTP requests.
- workersCount(int) - Method in class io.helidon.webserver.WebServer.Builder
-
Sets a count of threads in pool used to process HTTP requests.
- writeFuture() - Method in class io.helidon.webserver.ByteBufDataChunk
- writeFuture(CompletableFuture<DataChunk>) - Method in class io.helidon.webserver.ByteBufDataChunk
- writerContext() - Method in interface io.helidon.webserver.ServerResponse
-
Get the writer context used to marshall data.
- writerContext() - Method in interface io.helidon.webserver.WebServer
-
Get the parent
MessageBodyWriterContext
context. - writeStatusAndHeaders(Http.ResponseStatus, Map<String, List<String>>) - Method in interface io.helidon.webserver.BareResponse
-
Send response line and headers to the client.
All Classes All Packages