Module com.renomad.minum

Package com.renomad.minum.web

package com.renomad.minum.web

Code and data for HTTP web serving.

Here is a typical "main" method for an application. The important thing to note is we are initializing FullSystem and using it to register endpoints. A more organized approach is to put the endpoint registrations into another file. See the example project in the Minum codebase or any of the other example projects.

 
 package org.example;

 import com.renomad.minum.web.FullSystem;
 import com.renomad.minum.web.Response;

 import static com.renomad.minum.web.RequestLine.Method.GET;

 public class Main {

     public static void main(String[] args) {
         FullSystem fs = FullSystem.initialize();
         fs.getWebFramework().registerPath(GET, "", request -> Response.htmlOk("<p>Hi there world!</p>"));
         fs.block();
     }
 }
 
 

Here's an example of a business-related function using authentication and the Minum database. This code is extracted from the SampleDomain.java file in the src/test directory:

       public IResponse formEntry(IRequest r) {
         final var authResult = auth.processAuth(r);
         if (! authResult.isAuthenticated()) {
             return Response.buildLeanResponse(CODE_401_UNAUTHORIZED);
         }
         final String names = db
                 .values().stream().sorted(Comparator.comparingLong(PersonName::getIndex))
                 .map(x -> "<li>" + StringUtils.safeHtml(x.getFullname()) + "</li>\n")
                 .collect(Collectors.joining());

         return Response.htmlOk(nameEntryTemplate.renderTemplate(Map.of("names", names)));
     }
     
  

Related Packages

Package	Description
com.renomad.minum	Minum is a web library with all the components needed to build a web application, including a web server and a database.

Class	Description
Body	This class represents the body of an HTML message.
BodyType	The type of HTTP request body
ContentDisposition	This class represents the information in the Content-Disposition header of a multipart/form-data partition.
FullSystem	This class is responsible for instantiating necessary classes for a valid system, in the proper order.
FunctionalTesting	Tools to enable system-wide integration testing
FunctionalTesting.TestResponse	A Response designed to work with FunctionalTesting
Headers	Details extracted from the headers.
HttpServerType	An enum to represent the mode of conversation for HTTP - plain text or encrypted (TLS)
HttpVersion	The HTTP versions we handle
IBodyProcessor	An interface for the BodyProcessor implementation.
InvalidRangeException	This exception is thrown if the range of bytes provided for a request is improper - such as if the range values were negative, wrongly-ordered, and so on.
IRequest	An interface for Request.
IResponse	An interface for Response.
IServer	An interface for the Server implementation.
ISocketWrapper	This is the public interface to ISocketWrapper, whose purpose is to make our lives easier when working with Socket.
LastMinuteHandlerInputs	The parameters required to set up a handler that is run after everything else in the web framework.
Partition	Represents a single partition in a multipart/form-data body response
PathDetails	Some essential characteristics of the path portion of the start line
PreHandlerInputs	The input parameters that are required to add a pre-handler.
Request	An HTTP request.
RequestLine	This class holds data and methods for dealing with the "start line" in an HTTP request.
RequestLine.Method	These are the HTTP methods we handle.
Response	Represents an HTTP response.
StatusLine	This class represents the text that is sent back in a Response
StatusLine.StatusCode	See Status Codes
StreamingMultipartPartition	This class represents a single partition in a multipart/form Request body, when read as an InputStream.
ThrowingConsumer<T>	This exists so that we are able to better manage exceptions in a highly threaded system.
ThrowingFunction<T,R>	This exists so that we are able to better manage exceptions in a highly threaded system.
UrlEncodedDataGetter	This class enables pulling key-value pairs one at a time from the Request body.
UrlEncodedKeyValue	Represents a key-value pair with URL-encoding.
WebFramework	This class is responsible for the HTTP handling after socket connection.
WebServerException	This is just a RuntimeException that is scoped for our web server.