public class DefaultServlet extends HttpServlet
The default resource-serving servlet for most web applications, used to serve static resources such as HTML pages and images.
This servlet is intended to be mapped to / e.g.:
<servlet-mapping> <servlet-name>default</servlet-name> <url-pattern>/</url-pattern> </servlet-mapping>
It can be mapped to sub-paths, however in all cases resources are served
from the web application resource root using the full path from the root
of the web application context.
e.g. given a web application structure:
/context /images tomcat2.jpg /static /images tomcat.jpg
... and a servlet mapping that maps only /static/*
to the default servlet:
<servlet-mapping> <servlet-name>default</servlet-name> <url-pattern>/static/*</url-pattern> </servlet-mapping>
Then a request to /context/static/images/tomcat.jpg
will succeed
while a request to /context/images/tomcat2.jpg
will fail.
Modifier and Type | Class and Description |
---|---|
protected static class |
DefaultServlet.Range |
Modifier and Type | Field and Description |
---|---|
protected static int |
BUFFER_SIZE
Size of file transfer buffer in bytes.
|
protected java.lang.String |
contextXsltFile
Allow customized directory listing per context.
|
protected int |
debug
The debugging detail level for this servlet.
|
protected java.lang.String |
fileEncoding
File encoding to be used when reading static files.
|
protected static java.util.ArrayList<DefaultServlet.Range> |
FULL
Full range marker.
|
protected java.lang.String |
globalXsltFile
Allow customized directory listing per instance.
|
protected boolean |
gzip
Should be serve gzip versions of files.
|
protected int |
input
The input buffer size to use when serving resources.
|
protected boolean |
listings
Should we generate directory listings?
|
protected java.lang.String |
localXsltFile
Allow customized directory listing per directory.
|
protected static java.lang.String |
mimeSeparation
MIME multipart separation string
|
protected int |
output
The output buffer size to use when serving resources.
|
protected java.lang.String |
readmeFile
Allow a readme file to be included.
|
protected boolean |
readOnly
Read only flag.
|
protected WebResourceRoot |
resources
The complete set of web application resources
|
protected static java.lang.String |
RESOURCES_JNDI_NAME
JNDI resources name.
|
protected int |
sendfileSize
Minimum size for sendfile usage in bytes.
|
protected boolean |
showServerInfo
Flag to determine if server information is presented.
|
protected static StringManager |
sm
The string manager for this package.
|
protected boolean |
useAcceptRanges
Should the Accept-Ranges: bytes header be send with static resources?
|
Constructor and Description |
---|
DefaultServlet() |
Modifier and Type | Method and Description |
---|---|
protected boolean |
checkIfGzip(HttpServletRequest request)
Check if the user agent supports gzip encoding.
|
protected boolean |
checkIfHeaders(HttpServletRequest request,
HttpServletResponse response,
WebResource resource)
Check if the conditions specified in the optional If headers are
satisfied.
|
protected boolean |
checkIfMatch(HttpServletRequest request,
HttpServletResponse response,
WebResource resource)
Check if the if-match condition is satisfied.
|
protected boolean |
checkIfModifiedSince(HttpServletRequest request,
HttpServletResponse response,
WebResource resource)
Check if the if-modified-since condition is satisfied.
|
protected boolean |
checkIfNoneMatch(HttpServletRequest request,
HttpServletResponse response,
WebResource resource)
Check if the if-none-match condition is satisfied.
|
protected boolean |
checkIfUnmodifiedSince(HttpServletRequest request,
HttpServletResponse response,
WebResource resource)
Check if the if-unmodified-since condition is satisfied.
|
protected boolean |
checkSendfile(HttpServletRequest request,
HttpServletResponse response,
WebResource resource,
long length,
DefaultServlet.Range range)
Check if sendfile can be used.
|
protected void |
copy(WebResource resource,
java.io.InputStream is,
java.io.PrintWriter writer,
java.lang.String encoding)
Copy the contents of the specified input stream to the specified
output stream, and ensure that both streams are closed before returning
(even in the face of an exception).
|
protected void |
copy(WebResource resource,
java.io.InputStream is,
ServletOutputStream ostream)
Copy the contents of the specified input stream to the specified
output stream, and ensure that both streams are closed before returning
(even in the face of an exception).
|
protected void |
copy(WebResource resource,
ServletOutputStream ostream,
DefaultServlet.Range range)
Copy the contents of the specified input stream to the specified
output stream, and ensure that both streams are closed before returning
(even in the face of an exception).
|
protected void |
copy(WebResource resource,
ServletOutputStream ostream,
java.util.Iterator<DefaultServlet.Range> ranges,
java.lang.String contentType)
Copy the contents of the specified input stream to the specified
output stream, and ensure that both streams are closed before returning
(even in the face of an exception).
|
protected java.io.IOException |
copyRange(java.io.InputStream istream,
ServletOutputStream ostream)
Copy the contents of the specified input stream to the specified
output stream, and ensure that both streams are closed before returning
(even in the face of an exception).
|
protected java.io.IOException |
copyRange(java.io.InputStream istream,
ServletOutputStream ostream,
long start,
long end)
Copy the contents of the specified input stream to the specified
output stream, and ensure that both streams are closed before returning
(even in the face of an exception).
|
protected java.io.IOException |
copyRange(java.io.Reader reader,
java.io.PrintWriter writer)
Copy the contents of the specified input stream to the specified
output stream, and ensure that both streams are closed before returning
(even in the face of an exception).
|
void |
destroy()
Finalize this servlet.
|
protected void |
doDelete(HttpServletRequest req,
HttpServletResponse resp)
Process a DELETE request for the specified resource.
|
protected void |
doGet(HttpServletRequest request,
HttpServletResponse response)
Process a GET request for the specified resource.
|
protected void |
doHead(HttpServletRequest request,
HttpServletResponse response)
Process a HEAD request for the specified resource.
|
protected void |
doOptions(HttpServletRequest req,
HttpServletResponse resp)
Override default implementation to ensure that TRACE is correctly
handled.
|
protected void |
doPost(HttpServletRequest request,
HttpServletResponse response)
Process a POST request for the specified resource.
|
protected void |
doPut(HttpServletRequest req,
HttpServletResponse resp)
Process a PUT request for the specified resource.
|
protected java.io.File |
executePartialPut(HttpServletRequest req,
DefaultServlet.Range range,
java.lang.String path)
Handle a partial PUT.
|
protected javax.xml.transform.Source |
findXsltSource(WebResource directory)
Return a Source for the xsl template (if possible)
|
protected java.lang.String |
getPathPrefix(HttpServletRequest request)
Determines the appropriate path to prepend resources with
when generating directory listings.
|
protected java.lang.String |
getReadme(WebResource directory)
Get the readme file as a string.
|
protected java.lang.String |
getReadme(WebResource directory,
java.lang.String encoding) |
protected java.lang.String |
getRelativePath(HttpServletRequest request)
Return the relative path associated with this servlet.
|
protected java.lang.String |
getRelativePath(HttpServletRequest request,
boolean allowEmptyPath) |
void |
init()
Initialize this servlet.
|
protected DefaultServlet.Range |
parseContentRange(HttpServletRequest request,
HttpServletResponse response)
Parse the content-range header.
|
protected java.util.ArrayList<DefaultServlet.Range> |
parseRange(HttpServletRequest request,
HttpServletResponse response,
WebResource resource)
Parse the range header.
|
protected java.io.InputStream |
render(java.lang.String contextPath,
WebResource resource)
Decide which way to render.
|
protected java.io.InputStream |
render(java.lang.String contextPath,
WebResource resource,
java.lang.String encoding) |
protected java.io.InputStream |
renderHtml(java.lang.String contextPath,
WebResource resource)
Return an InputStream to an HTML representation of the contents
of this directory.
|
protected java.io.InputStream |
renderHtml(java.lang.String contextPath,
WebResource resource,
java.lang.String encoding) |
protected java.lang.String |
renderSize(long size)
Render the specified file size (in bytes).
|
protected java.io.InputStream |
renderXml(java.lang.String contextPath,
WebResource resource,
javax.xml.transform.Source xsltSource)
Return an InputStream to an HTML representation of the contents
of this directory.
|
protected java.io.InputStream |
renderXml(java.lang.String contextPath,
WebResource resource,
javax.xml.transform.Source xsltSource,
java.lang.String encoding) |
protected java.lang.String |
rewriteUrl(java.lang.String path)
URL rewriter.
|
protected void |
serveResource(HttpServletRequest request,
HttpServletResponse response,
boolean content,
java.lang.String encoding)
Serve the specified resource, optionally including the data content.
|
protected void |
service(HttpServletRequest req,
HttpServletResponse resp)
Receives standard HTTP requests from the public
service method and dispatches
them to the do Method methods defined in
this class. |
doTrace, getLastModified, service
getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log
protected static final StringManager sm
protected static final java.util.ArrayList<DefaultServlet.Range> FULL
protected static final java.lang.String mimeSeparation
protected static final java.lang.String RESOURCES_JNDI_NAME
protected static final int BUFFER_SIZE
protected int debug
protected int input
protected boolean listings
protected boolean readOnly
protected boolean gzip
protected int output
protected java.lang.String localXsltFile
protected java.lang.String contextXsltFile
protected java.lang.String globalXsltFile
protected java.lang.String readmeFile
protected transient WebResourceRoot resources
protected java.lang.String fileEncoding
protected int sendfileSize
protected boolean useAcceptRanges
protected boolean showServerInfo
public void destroy()
destroy
in interface Servlet
destroy
in class GenericServlet
public void init() throws ServletException
init
in class GenericServlet
ServletException
- if an exception occurs that interrupts the servlet's
normal operationprotected java.lang.String getRelativePath(HttpServletRequest request)
request
- The servlet request we are processingprotected java.lang.String getRelativePath(HttpServletRequest request, boolean allowEmptyPath)
protected java.lang.String getPathPrefix(HttpServletRequest request)
getRelativePath(HttpServletRequest)
this will change.request
- the request to determine the path forprotected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, java.io.IOException
javax.servlet.http.HttpServlet
service
method and dispatches
them to the do
Method methods defined in
this class. This method is an HTTP-specific version of the
Servlet.service(javax.servlet.ServletRequest, javax.servlet.ServletResponse)
method. There's no
need to override this method.service
in class HttpServlet
req
- the HttpServletRequest
object that
contains the request the client made of
the servletresp
- the HttpServletResponse
object that
contains the response the servlet returns
to the clientServletException
- if the HTTP request
cannot be handledjava.io.IOException
- if an input or output error occurs
while the servlet is handling the
HTTP requestServlet.service(javax.servlet.ServletRequest, javax.servlet.ServletResponse)
protected void doGet(HttpServletRequest request, HttpServletResponse response) throws java.io.IOException, ServletException
doGet
in class HttpServlet
request
- The servlet request we are processingresponse
- The servlet response we are creatingjava.io.IOException
- if an input/output error occursServletException
- if a servlet-specified error occursServletResponse.setContentType(java.lang.String)
protected void doHead(HttpServletRequest request, HttpServletResponse response) throws java.io.IOException, ServletException
doHead
in class HttpServlet
request
- The servlet request we are processingresponse
- The servlet response we are creatingjava.io.IOException
- if an input/output error occursServletException
- if a servlet-specified error occursprotected void doOptions(HttpServletRequest req, HttpServletResponse resp) throws ServletException, java.io.IOException
doOptions
in class HttpServlet
req
- the HttpServletRequest
object that
contains the request the client made of
the servletresp
- the HttpServletResponse
object that
contains the response the servlet returns
to the clientjava.io.IOException
- if an input or output error occurs
while the servlet is handling the
OPTIONS requestServletException
- if the request for the
OPTIONS cannot be handledprotected void doPost(HttpServletRequest request, HttpServletResponse response) throws java.io.IOException, ServletException
doPost
in class HttpServlet
request
- The servlet request we are processingresponse
- The servlet response we are creatingjava.io.IOException
- if an input/output error occursServletException
- if a servlet-specified error occursServletOutputStream
,
ServletResponse.setContentType(java.lang.String)
protected void doPut(HttpServletRequest req, HttpServletResponse resp) throws ServletException, java.io.IOException
doPut
in class HttpServlet
req
- The servlet request we are processingresp
- The servlet response we are creatingjava.io.IOException
- if an input/output error occursServletException
- if a servlet-specified error occursprotected java.io.File executePartialPut(HttpServletRequest req, DefaultServlet.Range range, java.lang.String path) throws java.io.IOException
java.io.IOException
protected void doDelete(HttpServletRequest req, HttpServletResponse resp) throws ServletException, java.io.IOException
doDelete
in class HttpServlet
req
- The servlet request we are processingresp
- The servlet response we are creatingjava.io.IOException
- if an input/output error occursServletException
- if a servlet-specified error occursprotected boolean checkIfHeaders(HttpServletRequest request, HttpServletResponse response, WebResource resource) throws java.io.IOException
request
- The servlet request we are processingresponse
- The servlet response we are creatingresource
- The resourcejava.io.IOException
protected java.lang.String rewriteUrl(java.lang.String path)
path
- Path which has to be rewrittenprotected void serveResource(HttpServletRequest request, HttpServletResponse response, boolean content, java.lang.String encoding) throws java.io.IOException, ServletException
request
- The servlet request we are processingresponse
- The servlet response we are creatingcontent
- Should the content be included?encoding
- The encoding to use if it is necessary to access the
source as characters rather than as bytesjava.io.IOException
- if an input/output error occursServletException
- if a servlet-specified error occursprotected DefaultServlet.Range parseContentRange(HttpServletRequest request, HttpServletResponse response) throws java.io.IOException
request
- The servlet request we a)re processingresponse
- The servlet response we are creatingjava.io.IOException
protected java.util.ArrayList<DefaultServlet.Range> parseRange(HttpServletRequest request, HttpServletResponse response, WebResource resource) throws java.io.IOException
request
- The servlet request we are processingresponse
- The servlet response we are creatingresource
- The resourcejava.io.IOException
protected java.io.InputStream render(java.lang.String contextPath, WebResource resource) throws java.io.IOException, ServletException
java.io.IOException
ServletException
protected java.io.InputStream render(java.lang.String contextPath, WebResource resource, java.lang.String encoding) throws java.io.IOException, ServletException
java.io.IOException
ServletException
protected java.io.InputStream renderXml(java.lang.String contextPath, WebResource resource, javax.xml.transform.Source xsltSource) throws java.io.IOException, ServletException
contextPath
- Context path to which our internal paths are
relativejava.io.IOException
ServletException
protected java.io.InputStream renderXml(java.lang.String contextPath, WebResource resource, javax.xml.transform.Source xsltSource, java.lang.String encoding) throws java.io.IOException, ServletException
java.io.IOException
ServletException
protected java.io.InputStream renderHtml(java.lang.String contextPath, WebResource resource) throws java.io.IOException
contextPath
- Context path to which our internal paths are
relativejava.io.IOException
protected java.io.InputStream renderHtml(java.lang.String contextPath, WebResource resource, java.lang.String encoding) throws java.io.IOException
java.io.IOException
protected java.lang.String renderSize(long size)
size
- File size (in bytes)protected java.lang.String getReadme(WebResource directory)
protected java.lang.String getReadme(WebResource directory, java.lang.String encoding)
protected javax.xml.transform.Source findXsltSource(WebResource directory) throws java.io.IOException
java.io.IOException
protected boolean checkSendfile(HttpServletRequest request, HttpServletResponse response, WebResource resource, long length, DefaultServlet.Range range)
protected boolean checkIfMatch(HttpServletRequest request, HttpServletResponse response, WebResource resource) throws java.io.IOException
request
- The servlet request we are processingresponse
- The servlet response we are creatingresource
- The resourcejava.io.IOException
protected boolean checkIfModifiedSince(HttpServletRequest request, HttpServletResponse response, WebResource resource)
request
- The servlet request we are processingresponse
- The servlet response we are creatingresource
- The resourceprotected boolean checkIfNoneMatch(HttpServletRequest request, HttpServletResponse response, WebResource resource) throws java.io.IOException
request
- The servlet request we are processingresponse
- The servlet response we are creatingresource
- The resourcejava.io.IOException
protected boolean checkIfGzip(HttpServletRequest request)
request
- The servlet request we are processingprotected boolean checkIfUnmodifiedSince(HttpServletRequest request, HttpServletResponse response, WebResource resource) throws java.io.IOException
request
- The servlet request we are processingresponse
- The servlet response we are creatingresource
- The resourcejava.io.IOException
protected void copy(WebResource resource, java.io.InputStream is, ServletOutputStream ostream) throws java.io.IOException
resource
- The source resourceis
- The input stream to read the source resource fromostream
- The output stream to write tojava.io.IOException
- if an input/output error occursprotected void copy(WebResource resource, java.io.InputStream is, java.io.PrintWriter writer, java.lang.String encoding) throws java.io.IOException
resource
- The source resourceis
- The input stream to read the source resource fromwriter
- The writer to write toencoding
- The encoding to use when reading the source input streamjava.io.IOException
- if an input/output error occursprotected void copy(WebResource resource, ServletOutputStream ostream, DefaultServlet.Range range) throws java.io.IOException
resource
- The source resourceostream
- The output stream to write torange
- Range the client wanted to retrievejava.io.IOException
- if an input/output error occursprotected void copy(WebResource resource, ServletOutputStream ostream, java.util.Iterator<DefaultServlet.Range> ranges, java.lang.String contentType) throws java.io.IOException
resource
- The source resourceostream
- The output stream to write toranges
- Enumeration of the ranges the client wanted to
retrievecontentType
- Content type of the resourcejava.io.IOException
- if an input/output error occursprotected java.io.IOException copyRange(java.io.InputStream istream, ServletOutputStream ostream)
istream
- The input stream to read fromostream
- The output stream to write toprotected java.io.IOException copyRange(java.io.Reader reader, java.io.PrintWriter writer)
reader
- The reader to read fromwriter
- The writer to write toprotected java.io.IOException copyRange(java.io.InputStream istream, ServletOutputStream ostream, long start, long end)
istream
- The input stream to read fromostream
- The output stream to write tostart
- Start of the range which will be copiedend
- End of the range which will be copiedCopyright © 2000-2018 Apache Software Foundation. All Rights Reserved.