BasicServlet (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- javax.servlet.GenericServlet
- - javax.servlet.http.HttpServlet
  - - org.klomp.snark.web.BasicServlet

All Implemented Interfaces:
Serializable, Servlet, ServletConfig
Direct Known Subclasses:
I2PSnarkServlet
```
class BasicServlet
extends HttpServlet
```
Based on DefaultServlet from Jetty 6.1.26, heavily simplified and modified to remove all dependencies on Jetty libs.
Supports HEAD and GET only, for resources from the .war and local files. Supports files and resource only. Supports MIME types with local overrides and additions. Supports Last-Modified. Supports single request ranges.
Does not support directories or "welcome files". Does not support gzip. Does not support multiple request ranges. Does not cache.
POST returns 405. Directories return 403. Jar resources are sent with a long cache directive.
------------------------------------------------------------
The default servlet. This servlet, normally mapped to /, provides the handling for static content, OPTION and TRACE methods for the context. The following initParameters are supported, these can be set on the servlet itself:
```
  resourceBase  Set to replace the context resource base
  warBase      Path allowed for resource in war

 
```

Nested Class Summary
Nested Classes
Modifier and Type Class and Description
static interface BasicServlet.HttpContent
from Jetty HttpContent.java

Nested Classes
Modifier and Type	Class and Description
`static interface`	`BasicServlet.HttpContent` from Jetty HttpContent.java

Field Summary
Fields
Modifier and Type Field and Description
protected I2PAppContext _context
protected Log _log
protected File _resourceBase
Base directory for serving static files.

Fields
Modifier and Type	Field and Description
`protected I2PAppContext`	`_context`
`protected Log`	`_log`
`protected File`	`_resourceBase` Base directory for serving static files.

Constructor Summary
Constructors
Constructor and Description
BasicServlet()

Constructors
Constructor and Description
`BasicServlet()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addMimeMapping(String extension, String type)` Add a MIME type mapping for an extension.
`protected static String`	`addPaths(String base, String path)` Simple version of URIUtil.addPaths().
`protected static String`	`decodePath(String path)` Simple version of URIUtil.decodePath().
`protected void`	`doDelete(HttpServletRequest request, HttpServletResponse response)` Handles HTTP DELETE requests.
`protected void`	`doGet(HttpServletRequest request, HttpServletResponse response)`
`protected void`	`doOptions(HttpServletRequest request, HttpServletResponse response)` Handles HTTP OPTIONS requests.
`protected void`	`doPost(HttpServletRequest request, HttpServletResponse response)` Handles HTTP POST requests.
`protected void`	`doTrace(HttpServletRequest request, HttpServletResponse response)` Handles HTTP TRACE requests.
`protected static String`	`encodePath(String path)` Simple version of URIUtil.encodePath().
`BasicServlet.HttpContent`	`getContent(String pathInContext, long limit)` Get Resource to serve.
`protected String`	`getMimeType(String filename)` Get the MIME type by filename extension.
`File`	`getResource(String pathInContext)` Get Resource to serve.
`void`	`init(ServletConfig cfg)` Initializes the servlet with resource and war base directories.
`protected void`	`loadMimeMap(String resourcePath)` Load MIME type mappings from a resource file.
`protected boolean`	`passConditionalHeaders(HttpServletRequest request, HttpServletResponse response, BasicServlet.HttpContent content)` Check modification date headers.
`protected void`	`sendData(HttpServletRequest request, HttpServletResponse response, BasicServlet.HttpContent content)` Sends the content to the client, handling range requests.
`protected void`	`setResourceBase(File base)` Files are served from here.
`protected void`	`setWarBase(String base)` Only paths starting with this in the path are served.
`protected void`	`writeHeaders(HttpServletResponse response, BasicServlet.HttpContent content, long count)` Write response headers for the content.

Methods inherited from class javax.servlet.http.HttpServlet
doHead, doPut, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet
destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - _context
```
protected final transient I2PAppContext _context
```
  - _log
```
protected final transient Log _log
```
  - _resourceBase
```
protected File _resourceBase
```
    Base directory for serving static files.
- Constructor Detail
  - BasicServlet
```
public BasicServlet()
```
- Method Detail
  - addMimeMapping
```
protected void addMimeMapping(String extension,
                              String type)
```
    Add a MIME type mapping for an extension.
    Parameters:
    extension - the file extension (without the dot)
    type - the MIME type to associate with the extension
  - addPaths
```
protected static String addPaths(String base,
                                 String path)
```
    Simple version of URIUtil.addPaths().
    Parameters:
    base - the base path
    path - the path to add (may be null)
    Returns:
    the combined path
  - decodePath
```
protected static String decodePath(String path)
                            throws MalformedURLException
```
    Simple version of URIUtil.decodePath().
    Parameters:
    path - the path to decode
    Returns:
    the decoded path
    Throws:
    MalformedURLException - if the path contains invalid escape sequences
  - doDelete
```
protected void doDelete(HttpServletRequest request,
                        HttpServletResponse response)
                 throws ServletException,
                        IOException
```
    Handles HTTP DELETE requests. Returns 405 Method Not Allowed.
    Overrides:
    doDelete in class HttpServlet
    Parameters:
    request - the HTTP request
    response - the HTTP response
    Throws:
    ServletException - if a servlet error occurs
    IOException - if an I/O error occurs
  - doGet
```
protected void doGet(HttpServletRequest request,
                     HttpServletResponse response)
              throws ServletException,
                     IOException
```
    Overrides:
    doGet in class HttpServlet
    Throws:
    ServletException
    IOException
  - doOptions
```
protected void doOptions(HttpServletRequest request,
                         HttpServletResponse response)
                  throws ServletException,
                         IOException
```
    Handles HTTP OPTIONS requests. Returns 405 Method Not Allowed.
    Overrides:
    doOptions in class HttpServlet
    Parameters:
    request - the HTTP request
    response - the HTTP response
    Throws:
    ServletException - if a servlet error occurs
    IOException - if an I/O error occurs
  - doPost
```
protected void doPost(HttpServletRequest request,
                      HttpServletResponse response)
               throws ServletException,
                      IOException
```
    Handles HTTP POST requests. Returns 405 Method Not Allowed.
    Overrides:
    doPost in class HttpServlet
    Parameters:
    request - the HTTP request
    response - the HTTP response
    Throws:
    ServletException - if a servlet error occurs
    IOException - if an I/O error occurs
  - doTrace
```
protected void doTrace(HttpServletRequest request,
                       HttpServletResponse response)
                throws ServletException,
                       IOException
```
    Handles HTTP TRACE requests. Returns 405 Method Not Allowed.
    Overrides:
    doTrace in class HttpServlet
    Parameters:
    request - the HTTP request
    response - the HTTP response
    Throws:
    ServletException - if a servlet error occurs
    IOException - if an I/O error occurs
  - encodePath
```
protected static String encodePath(String path)
```
    Simple version of URIUtil.encodePath().
    Parameters:
    path - the path to encode
    Returns:
    the encoded path
  - getContent
```
public BasicServlet.HttpContent getContent(String pathInContext,
                                           long limit)
```
    Get Resource to serve. Map a path to a resource. The default implementation calls HttpContext.getResource but derived servlets may provide their own mapping.
    Parameters:
    pathInContext - The path to find a resource for.
    limit - the maximum content length to serve, or 0 for unlimited
    Returns:
    The resource to serve or null. Returns null for directories
  - getMimeType
```
protected String getMimeType(String filename)
```
    Get the MIME type by filename extension.
    Parameters:
    filename - A file name
    Returns:
    MIME type matching the longest dot extension of the file name.
  - getResource
```
public File getResource(String pathInContext)
```
    Get Resource to serve. Map a path to a resource. The default implementation calls HttpContext.getResource but derived servlets may provide their own mapping.
    Parameters:
    pathInContext - The path to find a resource for.
    Returns:
    The resource to serve or null if not existing
  - init
```
public void init(ServletConfig cfg)
          throws ServletException
```
    Initializes the servlet with resource and war base directories.
    Specified by:
    init in interface Servlet
    Overrides:
    init in class GenericServlet
    Parameters:
    cfg - the servlet configuration
    Throws:
    ServletException - if initialization fails
  - loadMimeMap
```
protected void loadMimeMap(String resourcePath)
```
    Load MIME type mappings from a resource file.
    Parameters:
    resourcePath - the resource path in the classpath, without ".properties" extension
  - passConditionalHeaders
```
protected boolean passConditionalHeaders(HttpServletRequest request,
                                         HttpServletResponse response,
                                         BasicServlet.HttpContent content)
                                  throws IOException
```
    Check modification date headers.
    Parameters:
    request - the HTTP request
    response - the HTTP response
    content - the content
    Returns:
    true to keep going, false if handled here
    Throws:
    IOException - if an I/O error occurs
  - sendData
```
protected void sendData(HttpServletRequest request,
                        HttpServletResponse response,
                        BasicServlet.HttpContent content)
                 throws IOException
```
    Sends the content to the client, handling range requests.
    Parameters:
    request - the HTTP request
    response - the HTTP response
    content - the content
    Throws:
    IOException - if an I/O error occurs
  - setResourceBase
```
protected void setResourceBase(File base)
                        throws UnavailableException
```
    Files are served from here.
    Parameters:
    base - the directory to serve files from
    Throws:
    UnavailableException - if the base directory doesn't exist
  - setWarBase
```
protected void setWarBase(String base)
```
    Only paths starting with this in the path are served.
    Parameters:
    base - the base path that must be matched
  - writeHeaders
```
protected void writeHeaders(HttpServletResponse response,
                            BasicServlet.HttpContent content,
                            long count)
                     throws IOException
```
    Write response headers for the content.
    Parameters:
    response - the HTTP response
    content - the content
    count - the content length
    Throws:
    IOException - if an I/O error occurs

Class BasicServlet

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class javax.servlet.http.HttpServlet

Methods inherited from class javax.servlet.GenericServlet

Methods inherited from class java.lang.Object

Field Detail

_context

_log

_resourceBase

Constructor Detail

BasicServlet

Method Detail

addMimeMapping

addPaths

decodePath

doDelete

doGet

doOptions

doPost

doTrace

encodePath

getContent

getMimeType

getResource

init

loadMimeMap

passConditionalHeaders

sendData

setResourceBase

setWarBase

writeHeaders