Module io.avaje.jex

Package io.avaje.jex

Class Jex

java.lang.Object

io.avaje.jex.Jex

public class Jex
extends Object

Create configure and start Jex.

     final Jex.Server app = Jex.create()
       .routing(routing -> routing
         .get("/", ctx -> ctx.text("hello world"))
         .get("/one", ctx -> ctx.text("one"))
       .port(8080)
       .start();

     app.shutdown();

 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Jex.Inner
static class	Jex.Jetty	Jetty specific configuration options.
static interface	Jex.Server	The running server.

Field Summary

Fields

Modifier and Type	Field	Description
Jex.Inner	inner
Jex.Jetty	jetty

Method Summary

Modifier and Type	Method	Description
Jex	accessManager(AccessManager accessManager)	Set the AccessManager.
Jex	configure(Consumer<Jex> configure)	Configure via a lambda taking the jex instance.
Jex	context(String contextPath)	Set the context path.
static Jex	create()	Create Jex to configure with routes etc before starting.
ErrorHandling	errorHandling()	Return the Error handler to add error handlers.
Jex	errorHandling(ErrorHandling.Service service)	Configure error handlers.
<T extends Exception> Jex	exception(Class<T> exceptionClass, ExceptionHandler<T> handler)	Add an exception handler for the given exception type.
Jex	jsonService(JsonService jsonService)	Set the JsonService.
Jex	port(int port)	Set the port to use.
Jex	register(TemplateRender renderer, String... extensions)	Explicitly register a template renderer.
Routing	routing()	Return the Routing to configure.
Jex	routing(Routing.Service routes)	Add routes and handlers to the routing.
Jex	routing(Collection<Routing.Service> routes)	Add many routes and handlers to the routing.
Jex.Server	start()	Start the server.
StaticFileConfig	staticFiles()	Return the static file configuration.

Methods inherited from class java.lang.Object

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

Field Details

inner

public final Jex.Inner inner

jetty

public final Jex.Jetty jetty

Method Details

create

public static Jex create()

Create Jex to configure with routes etc before starting.

errorHandling

public Jex errorHandling(ErrorHandling.Service service)

Configure error handlers.

errorHandling

public ErrorHandling errorHandling()

Return the Error handler to add error handlers.

routing

public Jex routing(Routing.Service routes)

Add routes and handlers to the routing.

routing

public Jex routing(Collection<Routing.Service> routes)

Add many routes and handlers to the routing.

routing

public Routing routing()

Return the Routing to configure.

accessManager

public Jex accessManager(AccessManager accessManager)

Set the AccessManager.

jsonService

public Jex jsonService(JsonService jsonService)

Set the JsonService.

configure

public Jex configure(Consumer<Jex> configure)

Configure via a lambda taking the jex instance.

exception

public <T extends Exception> Jex exception(Class<T> exceptionClass,
 ExceptionHandler<T> handler)

Add an exception handler for the given exception type.

port

public Jex port(int port)

Set the port to use.

context

public Jex context(String contextPath)

Set the context path.

staticFiles

public StaticFileConfig staticFiles()

Return the static file configuration.

register

public Jex register(TemplateRender renderer,
 String... extensions)

Explicitly register a template renderer.

Note that if not explicitly registered TemplateRender's can be automatically registered via ServiceLoader just by including them to the class path.

Parameters:

renderer - The template renderer to register

extensions - The extensions the renderer is used for

start

public Jex.Server start()

Start the server.