io.werval.spi

Interface ApplicationSPI

All Superinterfaces:

Application

public interface ApplicationSPI
extends Application

Application SPI.

Intended for use by HttpServer implementations, the DevShell and Application unit tests.

Don't use in your Application code.

Method Summary

Modifier and Type	Method and Description
EventsSPI	events() Application Events SPI.
Global	global() Application Global object.
Outcome	handleError(RequestHeader requestHeader, Throwable cause) Handle an exception throwed in a HTTP Request context.
CompletableFuture<Outcome>	handleRequest(Request request) Handle a HTTP Request.
HttpBuildersSPI	httpBuilders() HTTP API Objects Builders SPI.
void	onHttpRequestComplete(RequestHeader requestHeader) Callback for completed HTTP requests.
void	reload(ClassLoader newClassLoader) Reload Application with a new ClassLoader.
CompletableFuture<Outcome>	shuttingDownOutcome(ProtocolVersion version, String requestIdentity) Build the Outcome of any request happening while shutting down.

Methods inherited from interface io.werval.api.Application

activate, cache, classLoader, config, crypto, defaultCharset, errors, executor, executors, isActive, langs, metaData, mimeTypes, mode, parameterBinders, passivate, plugin, plugins, reverseRoutes, routes, sourceFileURLGenerator, templates, tmpdir

Method Detail

global

Global global()

Application Global object.

The Application Global object should not be accessed by Application code, that's why this accessor is in ApplicationSPI only.

Returns:

Application Global object

events

EventsSPI events()

Application Events SPI.

Specified by:

events in interface Application

Returns:

Application Events SPI

httpBuilders

HttpBuildersSPI httpBuilders()

HTTP API Objects Builders SPI.

Use this to create instances of HTTP API Objects found in the io.werval.api.http package. All builders are immutable and reusable.

Specified by:

httpBuilders in interface Application

Returns:

HTTP API Objects Builders SPI

handleRequest

CompletableFuture<Outcome> handleRequest(Request request)

Handle a HTTP Request.

Parameters:

request - HTTP Request

Returns:

Future of Outcome

handleError

Outcome handleError(RequestHeader requestHeader,
                    Throwable cause)

Handle an exception throwed in a HTTP Request context.

Parameters:

requestHeader - HTTP Request Header

cause - Exception throwed

Returns:

Error Outcome

onHttpRequestComplete

void onHttpRequestComplete(RequestHeader requestHeader)

Callback for completed HTTP requests.

Called once the whole response has been sent to the client.

Parameters:

requestHeader - Original request header

shuttingDownOutcome

CompletableFuture<Outcome> shuttingDownOutcome(ProtocolVersion version,
                                               String requestIdentity)

Build the Outcome of any request happening while shutting down.

This should return a 503 Service Unavailable status and a wisely choosen Retry-After header.

Parameters:

version - Protocol version of the HTTP request

requestIdentity - Identity of the HTTP request

Returns:

Future of shutting down Outcome

reload

void reload(ClassLoader newClassLoader)

Reload Application with a new ClassLoader.

Parameters:

newClassLoader - New Application ClassLoader