Package de.kosmos_lab.web.server.servlets

Class BaseServlet

java.lang.Object

jakarta.servlet.GenericServlet

jakarta.servlet.http.HttpServlet

de.kosmos_lab.web.server.servlets.BaseServlet

All Implemented Interfaces:

jakarta.servlet.Servlet, jakarta.servlet.ServletConfig, Serializable

Direct Known Subclasses:

AsyncApiStudioServlet, AsyncApiYamlServlet, AsyncCSSServlet, AsyncJSMapServlet, AsyncJSServlet, AsyncServlet, ExampleAuthedServlet, HelloWorldServlet, LoginServlet, OnlineServlet, OpenApiIndexServlet, OpenApiJSONServlet, OpenApiRapidocServlet, OpenApiYamlServlet

public class BaseServlet
extends jakarta.servlet.http.HttpServlet

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BaseServlet.ALLOW_AUTH

Field Summary

Fields

Modifier and Type	Field	Description
protected static org.slf4j.Logger	logger
protected WebServer	server
protected ConcurrentHashMap<String,Object>	values

Constructor Summary

Constructors

Constructor	Description
BaseServlet(WebServer server)
BaseServlet(WebServer server, BaseServlet.ALLOW_AUTH allow_auth)

Method Summary

Modifier and Type	Method	Description
protected void	addCORSHeader(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse response)
protected boolean	checkParameter(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse response, String[] keys)
void	delete(BaseServletRequest request, jakarta.servlet.http.HttpServletResponse response)
void	doDelete(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
void	doGet(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
void	doOptions(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
void	doPost(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
void	doPut(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
void	get(BaseServletRequest request, jakarta.servlet.http.HttpServletResponse response)
void	handleException(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, Exception e)
protected boolean	isAllowed(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
void	options(BaseServletRequest request, jakarta.servlet.http.HttpServletResponse response)
void	post(BaseServletRequest request, jakarta.servlet.http.HttpServletResponse response)
void	put(BaseServletRequest request, jakarta.servlet.http.HttpServletResponse response)
static void	sendHTML(BaseServletRequest req, jakarta.servlet.http.HttpServletResponse response, String text)
static void	sendJSON(BaseServletRequest req, jakarta.servlet.http.HttpServletResponse response, String text)
static void	sendJSON(BaseServletRequest req, jakarta.servlet.http.HttpServletResponse response, org.json.JSONArray obj)
static void	sendJSON(BaseServletRequest req, jakarta.servlet.http.HttpServletResponse response, org.json.JSONObject obj)
static void	sendJWT(BaseServletRequest req, jakarta.servlet.http.HttpServletResponse response, String text)
static void	sendText(BaseServletRequest req, jakarta.servlet.http.HttpServletResponse response, String text)
static void	sendTextAs(BaseServletRequest req, jakarta.servlet.http.HttpServletResponse response, String text, String type)
static void	sendXML(BaseServletRequest req, jakarta.servlet.http.HttpServletResponse response, String text)

Methods inherited from class jakarta.servlet.http.HttpServlet

doHead, doTrace, getLastModified, service, service

Methods inherited from class jakarta.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, log, log

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.slf4j.Logger logger

server

protected final WebServer server

values

protected ConcurrentHashMap<String,Object> values

Constructor Detail

BaseServlet

public BaseServlet(WebServer server)

BaseServlet

public BaseServlet(WebServer server,
                   BaseServlet.ALLOW_AUTH allow_auth)

Method Detail

sendJSON

public static void sendJSON(BaseServletRequest req,
                            jakarta.servlet.http.HttpServletResponse response,
                            org.json.JSONObject obj)
                     throws IOException

Throws:

IOException

sendJSON

public static void sendJSON(BaseServletRequest req,
                            jakarta.servlet.http.HttpServletResponse response,
                            org.json.JSONArray obj)
                     throws IOException

Throws:

IOException

sendJSON

public static void sendJSON(BaseServletRequest req,
                            jakarta.servlet.http.HttpServletResponse response,
                            String text)
                     throws IOException

Throws:

IOException

sendJWT

public static void sendJWT(BaseServletRequest req,
                           jakarta.servlet.http.HttpServletResponse response,
                           String text)
                    throws IOException

Throws:

IOException

sendText

public static void sendText(BaseServletRequest req,
                            jakarta.servlet.http.HttpServletResponse response,
                            String text)
                     throws IOException

Throws:

IOException

sendHTML

public static void sendHTML(BaseServletRequest req,
                            jakarta.servlet.http.HttpServletResponse response,
                            String text)
                     throws IOException

Throws:

IOException

sendTextAs

public static void sendTextAs(BaseServletRequest req,
                              jakarta.servlet.http.HttpServletResponse response,
                              String text,
                              String type)
                       throws IOException

Throws:

IOException

sendXML

public static void sendXML(BaseServletRequest req,
                           jakarta.servlet.http.HttpServletResponse response,
                           String text)
                    throws IOException

Throws:

IOException

addCORSHeader

protected void addCORSHeader(jakarta.servlet.http.HttpServletRequest req,
                             jakarta.servlet.http.HttpServletResponse response)

handleException

public void handleException(jakarta.servlet.http.HttpServletRequest request,
                            jakarta.servlet.http.HttpServletResponse response,
                            Exception e)

checkParameter

protected boolean checkParameter(jakarta.servlet.http.HttpServletRequest req,
                                 jakarta.servlet.http.HttpServletResponse response,
                                 String[] keys)
                          throws IOException

Throws:

IOException

delete

public void delete(BaseServletRequest request,
                   jakarta.servlet.http.HttpServletResponse response)
            throws Exception

Throws:

Exception

doDelete

public void doDelete(jakarta.servlet.http.HttpServletRequest request,
                     jakarta.servlet.http.HttpServletResponse response)
              throws IOException

Overrides:

doDelete in class jakarta.servlet.http.HttpServlet

Throws:

IOException

doGet

public void doGet(jakarta.servlet.http.HttpServletRequest request,
                  jakarta.servlet.http.HttpServletResponse response)
           throws IOException

Overrides:

doGet in class jakarta.servlet.http.HttpServlet

Throws:

IOException

doOptions

public void doOptions(jakarta.servlet.http.HttpServletRequest request,
                      jakarta.servlet.http.HttpServletResponse response)
               throws IOException

Overrides:

doOptions in class jakarta.servlet.http.HttpServlet

Throws:

IOException

doPost

public void doPost(jakarta.servlet.http.HttpServletRequest request,
                   jakarta.servlet.http.HttpServletResponse response)
            throws IOException

Overrides:

doPost in class jakarta.servlet.http.HttpServlet

Throws:

IOException

doPut

public void doPut(jakarta.servlet.http.HttpServletRequest request,
                  jakarta.servlet.http.HttpServletResponse response)
           throws IOException

Overrides:

doPut in class jakarta.servlet.http.HttpServlet

Throws:

IOException

get

public void get(BaseServletRequest request,
                jakarta.servlet.http.HttpServletResponse response)
         throws Exception

Throws:

Exception

isAllowed

protected boolean isAllowed(jakarta.servlet.http.HttpServletRequest request,
                            jakarta.servlet.http.HttpServletResponse response)
                     throws UnauthorizedException

Throws:

UnauthorizedException

options

public void options(BaseServletRequest request,
                    jakarta.servlet.http.HttpServletResponse response)

post

public void post(BaseServletRequest request,
                 jakarta.servlet.http.HttpServletResponse response)
          throws Exception

Throws:

Exception

put

public void put(BaseServletRequest request,
                jakarta.servlet.http.HttpServletResponse response)
         throws Exception

Throws:

Exception