Class BasicAuthServlet

java.lang.Object

jakarta.servlet.GenericServlet

jakarta.servlet.http.HttpServlet

org.deltava.servlet.GenericServlet

org.deltava.servlet.BasicAuthServlet

All Implemented Interfaces:

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

Direct Known Subclasses:

DownloadServlet, UploadServlet, WebServiceServlet

abstract class BasicAuthServlet
extends GenericServlet

A servlet that supports basic HTTP authentication.

Since:

1.0

Version:

11.3

Author:

Luke

Nested Class Summary

Nested classes/interfaces inherited from class GenericServlet

GenericServlet.ForbiddenException, GenericServlet.NotFoundException, GenericServlet.ServletSecurityContext

Field Summary

Fields inherited from class jakarta.servlet.http.HttpServlet

LEGACY_DO_HEAD

Constructor Summary

Constructors

Constructor	Description
BasicAuthServlet()

Method Summary

Modifier and Type	Method	Description
protected static Pilot	authenticate(jakarta.servlet.http.HttpServletRequest req)	Authenticates the current web user.
protected static void	challenge(jakarta.servlet.http.HttpServletResponse rsp, String realm)	Sets the response headers for a basic authentication challenge.

Methods inherited from class GenericServlet

getURL

Methods inherited from class jakarta.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPatch, doPost, doPut, doTrace, getLastModified, init, isSensitiveHeader, service, service

Methods inherited from class jakarta.servlet.GenericServlet

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

Methods inherited from class Object

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

Constructor Details

BasicAuthServlet

BasicAuthServlet()

Method Details

authenticate

protected static Pilot authenticate(jakarta.servlet.http.HttpServletRequest req)

Authenticates the current web user.

Parameters:

req - the current HTTP servlet request

Returns:

the authenticated Pilot's databse record, or null if not logged in

challenge

protected static void challenge(jakarta.servlet.http.HttpServletResponse rsp,
 String realm)
                         throws IOException

Sets the response headers for a basic authentication challenge.

Parameters:

rsp - the HTTP servlet response

realm - the realm name to present to the browser

Throws:

IOException - if a network error occurs