Class BeetRootWebServer

java.lang.Object

org.nanohttpd.protocols.http.NanoHTTPD

ch.autumo.beetroot.server.HTTPServer

ch.autumo.beetroot.BeetRootWebServer

All Implemented Interfaces:

BeetRootService

public class BeetRootWebServer
extends HTTPServer
implements BeetRootService

The beetRoot Web Server and Template Engine.

Nested Class Summary

Nested classes/interfaces inherited from class HTTPServer

HTTPServer.BaseRoutePrioritizer, HTTPServer.DefaultHandler, HTTPServer.DefaultRoutePrioritizer, HTTPServer.DefaultStreamHandler, HTTPServer.Error404UriHandler, HTTPServer.GeneralHandler, HTTPServer.IndexHandler, HTTPServer.InsertionOrderRoutePrioritizer, HTTPServer.IRoutePrioritizer, HTTPServer.NotImplementedHandler, HTTPServer.ProvidedPriorityRoutePrioritizer, HTTPServer.StaticPageHandler, HTTPServer.UriResource, HTTPServer.UriResponder, HTTPServer.UriRouter

Modifier and Type	Class	Description
static class	HTTPServer.BaseRoutePrioritizer	Base implementation of a route prioritizer that owns the route mappings.
static class	HTTPServer.DefaultHandler	General nanolet to inherit from if you provide text or html data, only fixed size responses will be generated.
static class	HTTPServer.DefaultRoutePrioritizer	Orders routes by the priority assigned when they were added.
static class	HTTPServer.DefaultStreamHandler	General nanolet to inherit from if you provide stream data, only chucked responses will be generated.
static class	HTTPServer.Error404UriHandler	Handling error 404 - unrecognized urls
static class	HTTPServer.GeneralHandler	General nanolet to print debug info's as a html page.
static class	HTTPServer.IndexHandler	Handling index
static class	HTTPServer.InsertionOrderRoutePrioritizer	Keeps routes in the order in which they were added.
static interface	HTTPServer.IRoutePrioritizer	Holds the registered routes and defines their processing order.
static class	HTTPServer.NotImplementedHandler	Fallback handler for routes that are registered without an implementation.
static class	HTTPServer.ProvidedPriorityRoutePrioritizer	Uses the priority that was passed to addRoute unchanged.
static class	HTTPServer.StaticPageHandler	Serves static files from a directory that is passed as init parameter.
static class	HTTPServer.UriResource	A single route: URI pattern, handler class, priority and init parameters.
static interface	HTTPServer.UriResponder	Responder for a routed URI.
static class	HTTPServer.UriRouter	Resolves a request URI to a registered route and processes the request with that route's handler.

Nested classes/interfaces inherited from class org.nanohttpd.protocols.http.NanoHTTPD

org.nanohttpd.protocols.http.NanoHTTPD.ResponseException

Field Summary

Fields

Modifier and Type	Field	Description
protected static final org.slf4j.Logger	LOG	Logger for this class.
static final String	VIRTUAL_TMP_PATH	Virtual relative path for temporary stored files to server (e.g.

Fields inherited from class HTTPServer

router

Modifier and Type	Field	Description
protected HTTPServer.UriRouter	router

Fields inherited from class org.nanohttpd.protocols.http.NanoHTTPD

asyncRunner, CONTENT_DISPOSITION_ATTRIBUTE_PATTERN, CONTENT_DISPOSITION_ATTRIBUTE_REGEX, CONTENT_DISPOSITION_PATTERN, CONTENT_DISPOSITION_REGEX, CONTENT_TYPE_PATTERN, CONTENT_TYPE_REGEX, hostname, interceptors, MIME_HTML, MIME_PLAINTEXT, MIME_TYPES, myPort, SOCKET_READ_TIMEOUT

Constructor Summary

Constructors

Constructor	Description
BeetRootWebServer()	Server.
BeetRootWebServer(int port)	Server.

Method Summary

Modifier and Type	Method	Description
final void	addMappings()	Add mappings respectively set web routes.
void	addRoute(String url, int priority, Class<?> handler, Object... initParameter)	New public method to add routes with priority.
protected org.nanohttpd.protocols.http.ClientHandler	createClientHandler(Socket finalAccept, InputStream inputStream)
void	destroy()	Cleanup method.
org.nanohttpd.protocols.http.threading.IAsyncRunner	getAsyncRunner()	Get async runner.
Class<?>	getDefaultHandlerClass()	Get default handler class.
String	getDefaultHandlerEntity()	Get default handler entity.
final Class<?>	getHandlerClass(String handlerName)	Get a handler class by handler name.
org.nanohttpd.protocols.http.tempfiles.ITempFileManager	newTempFileManager()	Get a new temporary file manager.
org.nanohttpd.protocols.http.response.Response	serve(BeetRootHTTPSession session, jakarta.servlet.http.HttpServletRequest request)	Main serve method for the beetroot-engine in a servlet context
org.nanohttpd.protocols.http.response.Response	serve(org.nanohttpd.protocols.http.IHTTPSession session)	Main serve method for the beetRoot-engine.
org.nanohttpd.protocols.http.response.Response	serveAtLast(BeetRootHTTPSession session)	Last call before the routed website is served.
static org.nanohttpd.protocols.http.response.Response	serverCommandResponse(BeetRootHTTPSession session, ClientAnswer answer)	Creates the JSON response for a client answer.
static org.nanohttpd.protocols.http.response.Response	serverResponse(BeetRootHTTPSession session, Class<?> handlerClass, Object... initParameter)	Creates the response by instantiating and calling the given handler.
void	setBaseServer(BaseServer baseServer)	Set base server.
void	start()	Start the server.
void	start(boolean daemon)	Start the server.
void	start(int timeout)	Starts the server (in setDaemon(true) mode).
void	start(int timeout, boolean daemon)	Start the server.
void	stop()	Stop the server.

Methods inherited from class HTTPServer

addRoute, normalizeUri, removeRoute, setNotFoundHandler, setNotImplementedHandler, setRoutePrioritizer

Modifier and Type	Method	Description
void	addRoute(String url, Class<?> handler, Object... initParameter)	Adds a route with the default priority 100.
static String	normalizeUri(String value)	Removes a leading and a trailing slash from the given URI.
void	removeRoute(String url)	Removes the route with the given URI pattern.
<T extends HTTPServer.UriResponder> void	setNotFoundHandler(Class<T> handler)	Sets the handler for URIs that match no route.
<T extends HTTPServer.UriResponder> void	setNotImplementedHandler(Class<T> handler)	Sets the handler for routes without an implementation.
void	setRoutePrioritizer(HTTPServer.IRoutePrioritizer routePrioritizer)	Replaces the route prioritizer.

Methods inherited from class org.nanohttpd.protocols.http.NanoHTTPD

addHTTPInterceptor, closeAllConnections, createServerRunnable, decodeParameters, decodeParameters, decodePercent, getHostname, getListeningPort, getMimeTypeForFile, getMyServerSocket, getServerSocketFactory, getTempFileManagerFactory, handle, isAlive, makeSecure, makeSSLSocketFactory, makeSSLSocketFactory, makeSSLSocketFactory, mimeTypes, safeClose, setAsyncRunner, setHTTPHandler, setServerSocketFactory, setTempFileManagerFactory, wasStarted

Methods inherited from class Object

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

Field Details

LOG

protected static final org.slf4j.Logger LOG

Logger for this class.

VIRTUAL_TMP_PATH

public static final String VIRTUAL_TMP_PATH

Virtual relative path for temporary stored files to server (e.g. generated images such as the 2FA QR code.

See Also:

• Constant Field Values

Constructor Details

BeetRootWebServer

public BeetRootWebServer()
                  throws Exception

Server.

Throws:

Exception - exception

BeetRootWebServer

public BeetRootWebServer(int port)
                  throws Exception

Server.

Parameters:

port - port

Throws:

Exception - exception

Method Details

createClientHandler

protected org.nanohttpd.protocols.http.ClientHandler createClientHandler(Socket finalAccept,
 InputStream inputStream)

Overrides:

createClientHandler in class org.nanohttpd.protocols.http.NanoHTTPD

getAsyncRunner

public org.nanohttpd.protocols.http.threading.IAsyncRunner getAsyncRunner()

Get async runner.

Returns:

async runner

setBaseServer

public void setBaseServer(BaseServer baseServer)

Set base server.

Parameters:

baseServer - base server

start

public void start()
           throws IOException

Start the server.

Overrides:

start in class org.nanohttpd.protocols.http.NanoHTTPD

Throws:

IOException

start

public void start(int timeout)
           throws IOException

Starts the server (in setDaemon(true) mode).

Overrides:

start in class org.nanohttpd.protocols.http.NanoHTTPD

Throws:

IOException

start

public void start(boolean daemon)
           throws IOException

Start the server.

Parameters:

daemon - start the web server as a daemon thread?

Throws:

IOException - IO exception

start

public void start(int timeout,
 boolean daemon)
           throws IOException

Start the server.

Overrides:

start in class org.nanohttpd.protocols.http.NanoHTTPD

Parameters:

timeout - timeout to use for socket connections.

daemon - start the thread daemon or not.

Throws:

IOException - if the socket is in use.

stop

public void stop()

Stop the server.

Overrides:

stop in class org.nanohttpd.protocols.http.NanoHTTPD

serve

public org.nanohttpd.protocols.http.response.Response serve(org.nanohttpd.protocols.http.IHTTPSession session)

Main serve method for the beetRoot-engine.

Overrides:

serve in class HTTPServer

Parameters:

session - nano session.

Returns:

response response

newTempFileManager

public org.nanohttpd.protocols.http.tempfiles.ITempFileManager newTempFileManager()

Description copied from interface: BeetRootService

Get a new temporary file manager.

Specified by:

newTempFileManager in interface BeetRootService

Returns:

new temporary file manager

destroy

public void destroy()

Description copied from interface: BeetRootService

Cleanup method. Close what needs to be closed and free resources.

Specified by:

destroy in interface BeetRootService

serve

public org.nanohttpd.protocols.http.response.Response serve(BeetRootHTTPSession session,
 jakarta.servlet.http.HttpServletRequest request)

Main serve method for the beetroot-engine in a servlet context

Parameters:

session - session.

request - servlet request

Returns:

response response

serverCommandResponse

public static org.nanohttpd.protocols.http.response.Response serverCommandResponse(BeetRootHTTPSession session,
 ClientAnswer answer)

Creates the JSON response for a client answer.

Parameters:

session - the HTTP session

answer - the client answer

Returns:

the response

serverResponse

public static org.nanohttpd.protocols.http.response.Response serverResponse(BeetRootHTTPSession session,
 Class<?> handlerClass,
 Object... initParameter)

Creates the response by instantiating and calling the given handler.

Parameters:

session - the HTTP session

handlerClass - the handler class

initParameter - the handler constructor parameters

Returns:

the response

getHandlerClass

public final Class<?> getHandlerClass(String handlerName)

Get a handler class by handler name.

Parameters:

handlerName - handler name

Returns:

handler class or null if not found

getDefaultHandlerClass

public Class<?> getDefaultHandlerClass()

Get default handler class. Overwrite for customization.

Returns:

default handler class

getDefaultHandlerEntity

public String getDefaultHandlerEntity()

Get default handler entity. Overwrite for customization.

Returns:

default handler entity

serveAtLast

public org.nanohttpd.protocols.http.response.Response serveAtLast(BeetRootHTTPSession session)

Last call before the routed website is served. At this point, templates have been parsed and compiled. Overwrite this method, if you still need to do something. In any case and at the end, it must call HTTPServer.serve(IHTTPSession)

Parameters:

session - HTTP sessiom

Returns:

response

addRoute

public void addRoute(String url,
 int priority,
 Class<?> handler,
 Object... initParameter)

New public method to add routes with priority. Beetroot has an own generic router where priorities are pre-defined.

Parameters:

url - url

priority - priority

handler - handler

initParameter - init parameter for handler

addMappings

public final void addMappings()

Add mappings respectively set web routes.

Overrides:

addMappings in class HTTPServer