Package de.kosmos_lab.web.server

Class ExampleBaseServlet

java.lang.Object

jakarta.servlet.GenericServlet

jakarta.servlet.http.HttpServlet

de.kosmos_lab.web.server.ExampleBaseServlet

All Implemented Interfaces:

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

Direct Known Subclasses:

AuthedServlet

public class ExampleBaseServlet
extends jakarta.servlet.http.HttpServlet

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected static org.slf4j.Logger	logger
protected static Pattern	pattern_host
protected ExampleWebServer	server
protected static int	STATUS_CONFLICT
protected static int	STATUS_ERROR
protected static int	STATUS_FAILED
protected static int	STATUS_FORBIDDEN
protected static int	STATUS_METHOD_NOT_ALLOWED
protected static int	STATUS_NO_AUTH
protected static int	STATUS_NO_RESPONSE
protected static int	STATUS_NOT_FOUND
protected static int	STATUS_OK
protected static int	STATUS_UNPROCESSABLE

Constructor Summary

Constructors

Constructor	Description
ExampleBaseServlet(ExampleWebServer server)

Method Summary

Modifier and Type	Method	Description
protected void	addCORSHeader(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse resp)
protected boolean	checkParameter(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse response, String[] keys)
void	delete(MyHttpServletRequest 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(MyHttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
protected boolean	isAllowed(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
void	options(MyHttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
void	post(MyHttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
void	put(MyHttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
protected void	sendJSON(MyHttpServletRequest req, jakarta.servlet.http.HttpServletResponse response, org.json.JSONArray obj)
protected void	sendJSON(MyHttpServletRequest req, jakarta.servlet.http.HttpServletResponse response, org.json.JSONObject obj)
protected void	sendJWT(MyHttpServletRequest req, jakarta.servlet.http.HttpServletResponse response, String text)
protected void	sendText(MyHttpServletRequest req, jakarta.servlet.http.HttpServletResponse response, String text)
protected void	sendXML(MyHttpServletRequest 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

STATUS_OK

protected static final int STATUS_OK

See Also:

Constant Field Values

STATUS_NO_RESPONSE

protected static final int STATUS_NO_RESPONSE

See Also:

Constant Field Values

STATUS_FORBIDDEN

protected static final int STATUS_FORBIDDEN

See Also:

Constant Field Values

STATUS_FAILED

protected static final int STATUS_FAILED

See Also:

Constant Field Values

STATUS_NO_AUTH

protected static final int STATUS_NO_AUTH

See Also:

Constant Field Values

STATUS_NOT_FOUND

protected static final int STATUS_NOT_FOUND

See Also:

Constant Field Values

STATUS_CONFLICT

protected static final int STATUS_CONFLICT

See Also:

Constant Field Values

STATUS_UNPROCESSABLE

protected static final int STATUS_UNPROCESSABLE

See Also:

Constant Field Values

STATUS_ERROR

protected static final int STATUS_ERROR

See Also:

Constant Field Values

STATUS_METHOD_NOT_ALLOWED

protected static final int STATUS_METHOD_NOT_ALLOWED

See Also:

Constant Field Values

pattern_host

protected static final Pattern pattern_host

server

protected final ExampleWebServer server

Constructor Detail

ExampleBaseServlet

public ExampleBaseServlet(ExampleWebServer server)

Method Detail

addCORSHeader

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

checkParameter

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

Throws:

IOException

delete

public void delete(MyHttpServletRequest request,
                   jakarta.servlet.http.HttpServletResponse response)
            throws jakarta.servlet.ServletException,
                   IOException,
                   ParameterNotFoundException,
                   NotFoundException

Throws:

jakarta.servlet.ServletException

IOException

ParameterNotFoundException

NotFoundException

doDelete

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

Overrides:

doDelete in class jakarta.servlet.http.HttpServlet

Throws:

jakarta.servlet.ServletException

IOException

doGet

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

Overrides:

doGet in class jakarta.servlet.http.HttpServlet

Throws:

jakarta.servlet.ServletException

IOException

doOptions

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

Overrides:

doOptions in class jakarta.servlet.http.HttpServlet

Throws:

jakarta.servlet.ServletException

IOException

doPost

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

Overrides:

doPost in class jakarta.servlet.http.HttpServlet

Throws:

jakarta.servlet.ServletException

IOException

doPut

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

Overrides:

doPut in class jakarta.servlet.http.HttpServlet

Throws:

jakarta.servlet.ServletException

IOException

get

public void get(MyHttpServletRequest request,
                jakarta.servlet.http.HttpServletResponse response)
         throws jakarta.servlet.ServletException,
                IOException,
                ParameterNotFoundException,
                NotFoundException,
                LoginFailedException,
                UnauthorizedException,
                NoPersistenceException

Throws:

jakarta.servlet.ServletException

IOException

ParameterNotFoundException

NotFoundException

LoginFailedException

UnauthorizedException

NoPersistenceException

isAllowed

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

options

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

post

public void post(MyHttpServletRequest request,
                 jakarta.servlet.http.HttpServletResponse response)
          throws jakarta.servlet.ServletException,
                 IOException,
                 ParameterNotFoundException,
                 NotFoundException,
                 UnauthorizedException,
                 NoSuchAlgorithmException,
                 InvalidKeyException,
                 NoPersistenceException,
                 LoginFailedException

Throws:

jakarta.servlet.ServletException

IOException

ParameterNotFoundException

NotFoundException

UnauthorizedException

NoSuchAlgorithmException

InvalidKeyException

NoPersistenceException

LoginFailedException

put

public void put(MyHttpServletRequest request,
                jakarta.servlet.http.HttpServletResponse response)
         throws jakarta.servlet.ServletException,
                IOException,
                ParameterNotFoundException,
                NotFoundException,
                LoginFailedException,
                UnauthorizedException

Throws:

jakarta.servlet.ServletException

IOException

ParameterNotFoundException

NotFoundException

LoginFailedException

UnauthorizedException

sendJSON

protected void sendJSON(MyHttpServletRequest req,
                        jakarta.servlet.http.HttpServletResponse response,
                        org.json.JSONObject obj)
                 throws IOException

Throws:

IOException

sendJSON

protected void sendJSON(MyHttpServletRequest req,
                        jakarta.servlet.http.HttpServletResponse response,
                        org.json.JSONArray obj)
                 throws IOException

Throws:

IOException

sendJWT

protected void sendJWT(MyHttpServletRequest req,
                       jakarta.servlet.http.HttpServletResponse response,
                       String text)
                throws IOException

Throws:

IOException

sendText

protected void sendText(MyHttpServletRequest req,
                        jakarta.servlet.http.HttpServletResponse response,
                        String text)
                 throws IOException

Throws:

IOException

sendXML

protected void sendXML(MyHttpServletRequest req,
                       jakarta.servlet.http.HttpServletResponse response,
                       String text)
                throws IOException

Throws:

IOException