io.jooby

Interface Server

All Known Implementing Classes:

Server.Base

public interface Server

Web server contract. Defines operations to start, join and stop a web server. Jooby comes with three web server implementation: Jetty, Netty and Undertow. A web server is automatically discovered using the Java Service Loader API. All you need is to add the server dependency to your project classpath. When service loader is not an option or do you want to manually bootstrap a server:

 Server server = new Netty(); // or Jetty or Utow

 App app = new App();

 server.start(app);

 ...

 server.stop();

 

Since:

2.0.0

Author:

edgar

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Server.Base Base class for server.

Method Summary

Modifier and Type	Method and Description
static void	addAddressInUse(Predicate<Throwable> predicate) Add an address in use predicate.
static void	addConnectionLost(Predicate<Throwable> predicate) Add a connection lost predicate.
static boolean	connectionLost(Throwable cause) Test whenever the given exception is a connection-lost.
ServerOptions	getOptions() Get server options.
static boolean	isAddressInUse(Throwable cause) Whenever the given exception is an address already in use.
default void	join() Deprecated. This method is planned to be removed in next major release (3.x)
Server	setOptions(ServerOptions options) Set server options.
Server	start(Jooby application) Start an application.
Server	stop() Stop the server.

Method Detail

setOptions

@Nonnull
Server setOptions(@Nonnull
                           ServerOptions options)

Set server options.

Parameters:

options - Server options.

Returns:

This server.

getOptions

@Nonnull
ServerOptions getOptions()

Get server options.

Returns:

Server options.

start

@Nonnull
Server start(@Nonnull
                      Jooby application)

Start an application.

Parameters:

application - Application to start.

Returns:

This server.

join

@Deprecated
 @Nonnull
default void join()

Deprecated. This method is planned to be removed in next major release (3.x)

Block current thread.

stop

@Nonnull
Server stop()

Stop the server.

Returns:

Stop the server.

addConnectionLost

static void addConnectionLost(@Nonnull
                              Predicate<Throwable> predicate)

Add a connection lost predicate. On unexpected exception, this method allows to customize which error are considered connection lost. If the error is considered a connection lost, no log statement will be emitted by the application.

Parameters:

predicate - Customize connection lost error.

addAddressInUse

static void addAddressInUse(@Nonnull
                            Predicate<Throwable> predicate)

Add an address in use predicate. On unexpected exception, this method allows to customize which error are considered address in use. If the error is considered an address in use, no log statement will be emitted by the application.

Parameters:

predicate - Customize connection lost error.

connectionLost

static boolean connectionLost(@Nullable
                              Throwable cause)

Test whenever the given exception is a connection-lost. Connection-lost exceptions don't generate log.error statements.

Parameters:

cause - Exception to check.

Returns:

True for connection lost.

isAddressInUse

static boolean isAddressInUse(@Nullable
                              Throwable cause)

Whenever the given exception is an address already in use. This probably won't work in none English locale systems.

Parameters:

cause - Exception to check.

Returns:

True address alaredy in use.