| javax.servlet.http.HttpServlet
 org.apache.catalina.servlets.DefaultServlet
All known Subclasses: org.apache.catalina.servlets.WebdavServlet,
| DefaultServlet | | public class DefaultServlet extends HttpServlet (Code) | | The default resource-serving servlet for most web applications,
used to serve static resources such as HTML pages and images.
author:
Craig R. McClanahan
author:
Remy Maucherat
version:
$Revision: 543680 $ $Date: 2007-06-02 02:42:36 +0200 (sam., 02 juin 2007) $ |
| Inner Class :protected class Range | |
| Method Summary | |
| protected boolean | checkIfHeaders(HttpServletRequest request, HttpServletResponse response, ResourceAttributes resourceAttributes)
Check if the conditions specified in the optional If headers are
satisfied. | | protected boolean | checkIfMatch(HttpServletRequest request, HttpServletResponse response, ResourceAttributes resourceAttributes)
Check if the if-match condition is satisfied. | | protected boolean | checkIfModifiedSince(HttpServletRequest request, HttpServletResponse response, ResourceAttributes resourceAttributes)
Check if the if-modified-since condition is satisfied. | | protected boolean | checkIfNoneMatch(HttpServletRequest request, HttpServletResponse response, ResourceAttributes resourceAttributes)
Check if the if-none-match condition is satisfied. | | protected boolean | checkIfUnmodifiedSince(HttpServletRequest request, HttpServletResponse response, ResourceAttributes resourceAttributes)
Check if the if-unmodified-since condition is satisfied. | | protected boolean | checkSendfile(HttpServletRequest request, HttpServletResponse response, CacheEntry entry, long length, Range range)
Check if sendfile can be used. | | protected void | copy(CacheEntry cacheEntry, 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(CacheEntry cacheEntry, InputStream is, 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). | | protected void | copy(CacheEntry cacheEntry, ServletOutputStream ostream, 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(CacheEntry cacheEntry, PrintWriter writer, 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(CacheEntry cacheEntry, ServletOutputStream ostream, Iterator ranges, 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 void | copy(CacheEntry cacheEntry, PrintWriter writer, Iterator ranges, 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 IOException | copyRange(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 IOException | copyRange(Reader reader, 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). | | protected IOException | copyRange(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 IOException | copyRange(Reader reader, PrintWriter writer, 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). | | public void | destroy()
Finalize this servlet. | | protected void | displaySize(StringBuffer buf, int filesize)
Display the size of a file. | | protected void | doDelete(HttpServletRequest req, HttpServletResponse resp)
Process a POST 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 | doPost(HttpServletRequest request, HttpServletResponse response)
Process a POST request for the specified resource. | | protected void | doPut(HttpServletRequest req, HttpServletResponse resp)
Process a POST request for the specified resource. | | protected File | executePartialPut(HttpServletRequest req, Range range, String path)
Handle a partial PUT. | | protected InputStream | findXsltInputStream(DirContext directory)
| | protected String | getETag(ResourceAttributes resourceAttributes)
Get the ETag associated with a file. | | protected String | getReadme(DirContext directory)
Get the readme file as a string. | | protected String | getRelativePath(HttpServletRequest request)
Return the relative path associated with this servlet. | | public void | init()
Initialize this servlet. | | protected Range | parseContentRange(HttpServletRequest request, HttpServletResponse response)
Parse the content-range header. | | protected ArrayList | parseRange(HttpServletRequest request, HttpServletResponse response, ResourceAttributes resourceAttributes)
Parse the range header. | | protected InputStream | render(String contextPath, CacheEntry cacheEntry)
Decide which way to render. | | protected InputStream | renderHtml(String contextPath, CacheEntry cacheEntry)
Return an InputStream to an HTML representation of the contents
of this directory. | | protected String | renderSize(long size)
Render the specified file size (in bytes). | | protected InputStream | renderXml(String contextPath, CacheEntry cacheEntry, InputStream xsltInputStream)
Return an InputStream to an HTML representation of the contents
of this directory. | | protected String | rewriteUrl(String path)
URL rewriter. | | protected void | serveResource(HttpServletRequest request, HttpServletResponse response, boolean content)
Serve the specified resource, optionally including the data content. |
| BUFFER_SIZE | | final protected static int BUFFER_SIZE(Code) | | Size of file transfer buffer in bytes.
|
| RESOURCES_JNDI_NAME | | final protected static String RESOURCES_JNDI_NAME(Code) | | JNDI resources name.
|
| debug | | protected int debug(Code) | | The debugging detail level for this servlet.
|
| fileEncoding | | protected String fileEncoding(Code) | | File encoding to be used when reading static files. If none is specified
the platform default is used.
|
| globalXsltFile | | protected String globalXsltFile(Code) | | Allow customized directory listing per instance.
|
| input | | protected int input(Code) | | The input buffer size to use when serving resources.
|
| listings | | protected boolean listings(Code) | | Should we generate directory listings?
|
| localXsltFile | | protected String localXsltFile(Code) | | Allow customized directory listing per directory.
|
| mimeSeparation | | final protected static String mimeSeparation(Code) | | MIME multipart separation string
|
| output | | protected int output(Code) | | The output buffer size to use when serving resources.
|
| readOnly | | protected boolean readOnly(Code) | | Read only flag. By default, it's set to true.
|
| readmeFile | | protected String readmeFile(Code) | | Allow a readme file to be included.
|
| sendfileSize | | protected int sendfileSize(Code) | | Minimum size for sendfile usage in bytes.
|
| urlEncoder | | protected static URLEncoder urlEncoder(Code) | | Array containing the safe characters set.
|
| checkIfHeaders | | protected boolean checkIfHeaders(HttpServletRequest request, HttpServletResponse response, ResourceAttributes resourceAttributes) throws IOException(Code) | | Check if the conditions specified in the optional If headers are
satisfied.
Parameters:
request - The servlet request we are processing
Parameters:
response - The servlet response we are creating
Parameters:
resourceAttributes - The resource information boolean true if the resource meets all the specified conditions,and false if any of the conditions is not satisfied, in which caserequest processing is stopped |
| checkIfMatch | | protected boolean checkIfMatch(HttpServletRequest request, HttpServletResponse response, ResourceAttributes resourceAttributes) throws IOException(Code) | | Check if the if-match condition is satisfied.
Parameters:
request - The servlet request we are processing
Parameters:
response - The servlet response we are creating
Parameters:
resourceInfo - File object boolean true if the resource meets the specified condition,and false if the condition is not satisfied, in which case requestprocessing is stopped |
| checkIfModifiedSince | | protected boolean checkIfModifiedSince(HttpServletRequest request, HttpServletResponse response, ResourceAttributes resourceAttributes) throws IOException(Code) | | Check if the if-modified-since condition is satisfied.
Parameters:
request - The servlet request we are processing
Parameters:
response - The servlet response we are creating
Parameters:
resourceInfo - File object boolean true if the resource meets the specified condition,and false if the condition is not satisfied, in which case requestprocessing is stopped |
| checkIfNoneMatch | | protected boolean checkIfNoneMatch(HttpServletRequest request, HttpServletResponse response, ResourceAttributes resourceAttributes) throws IOException(Code) | | Check if the if-none-match condition is satisfied.
Parameters:
request - The servlet request we are processing
Parameters:
response - The servlet response we are creating
Parameters:
resourceInfo - File object boolean true if the resource meets the specified condition,and false if the condition is not satisfied, in which case requestprocessing is stopped |
| checkIfUnmodifiedSince | | protected boolean checkIfUnmodifiedSince(HttpServletRequest request, HttpServletResponse response, ResourceAttributes resourceAttributes) throws IOException(Code) | | Check if the if-unmodified-since condition is satisfied.
Parameters:
request - The servlet request we are processing
Parameters:
response - The servlet response we are creating
Parameters:
resourceInfo - File object boolean true if the resource meets the specified condition,and false if the condition is not satisfied, in which case requestprocessing is stopped |
| copy | | protected void copy(CacheEntry cacheEntry, InputStream is, ServletOutputStream ostream) throws IOException(Code) | | 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).
Parameters:
resourceInfo - The resource information
Parameters:
ostream - The output stream to write to
exception:
IOException - if an input/output error occurs |
| copy | | protected void copy(CacheEntry cacheEntry, InputStream is, PrintWriter writer) throws IOException(Code) | | 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).
Parameters:
resourceInfo - The resource info
Parameters:
writer - The writer to write to
exception:
IOException - if an input/output error occurs |
| copy | | protected void copy(CacheEntry cacheEntry, ServletOutputStream ostream, Range range) throws IOException(Code) | | 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).
Parameters:
resourceInfo - The ResourceInfo object
Parameters:
ostream - The output stream to write to
Parameters:
range - Range the client wanted to retrieve
exception:
IOException - if an input/output error occurs |
| copy | | protected void copy(CacheEntry cacheEntry, PrintWriter writer, Range range) throws IOException(Code) | | 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).
Parameters:
resourceInfo - The ResourceInfo object
Parameters:
writer - The writer to write to
Parameters:
range - Range the client wanted to retrieve
exception:
IOException - if an input/output error occurs |
| copy | | protected void copy(CacheEntry cacheEntry, ServletOutputStream ostream, Iterator ranges, String contentType) throws IOException(Code) | | 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).
Parameters:
resourceInfo - The ResourceInfo object
Parameters:
ostream - The output stream to write to
Parameters:
ranges - Enumeration of the ranges the client wanted to retrieve
Parameters:
contentType - Content type of the resource
exception:
IOException - if an input/output error occurs |
| copy | | protected void copy(CacheEntry cacheEntry, PrintWriter writer, Iterator ranges, String contentType) throws IOException(Code) | | 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).
Parameters:
resourceInfo - The ResourceInfo object
Parameters:
writer - The writer to write to
Parameters:
ranges - Enumeration of the ranges the client wanted to retrieve
Parameters:
contentType - Content type of the resource
exception:
IOException - if an input/output error occurs |
| copyRange | | protected IOException copyRange(InputStream istream, ServletOutputStream ostream)(Code) | | 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).
Parameters:
istream - The input stream to read from
Parameters:
ostream - The output stream to write to Exception which occurred during processing |
| copyRange | | protected IOException copyRange(Reader reader, PrintWriter writer)(Code) | | 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).
Parameters:
reader - The reader to read from
Parameters:
writer - The writer to write to Exception which occurred during processing |
| copyRange | | protected IOException copyRange(InputStream istream, ServletOutputStream ostream, long start, long end)(Code) | | 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).
Parameters:
istream - The input stream to read from
Parameters:
ostream - The output stream to write to
Parameters:
start - Start of the range which will be copied
Parameters:
end - End of the range which will be copied Exception which occurred during processing |
| copyRange | | protected IOException copyRange(Reader reader, PrintWriter writer, long start, long end)(Code) | | 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).
Parameters:
reader - The reader to read from
Parameters:
writer - The writer to write to
Parameters:
start - Start of the range which will be copied
Parameters:
end - End of the range which will be copied Exception which occurred during processing |
| destroy | | public void destroy()(Code) | | Finalize this servlet.
|
| displaySize | | protected void displaySize(StringBuffer buf, int filesize)(Code) | | Display the size of a file.
|
| executePartialPut | | protected File executePartialPut(HttpServletRequest req, Range range, String path) throws IOException(Code) | | Handle a partial PUT. New content specified in request is appended to
existing content in oldRevisionContent (if present). This code does
not support simultaneous partial updates to the same resource.
|
| getETag | | protected String getETag(ResourceAttributes resourceAttributes)(Code) | | Get the ETag associated with a file.
Parameters:
resourceAttributes - The resource information |
| getRelativePath | | protected String getRelativePath(HttpServletRequest request)(Code) | | Return the relative path associated with this servlet.
Parameters:
request - The servlet request we are processing |
| parseContentRange | | protected Range parseContentRange(HttpServletRequest request, HttpServletResponse response) throws IOException(Code) | | Parse the content-range header.
Parameters:
request - The servlet request we are processing
Parameters:
response - The servlet response we are creating Range |
| renderSize | | protected String renderSize(long size)(Code) | | Render the specified file size (in bytes).
Parameters:
size - File size (in bytes) |
| rewriteUrl | | protected String rewriteUrl(String path)(Code) | | URL rewriter.
Parameters:
path - Path which has to be rewiten |
| serveResource | | protected void serveResource(HttpServletRequest request, HttpServletResponse response, boolean content) throws IOException, ServletException(Code) | | Serve the specified resource, optionally including the data content.
Parameters:
request - The servlet request we are processing
Parameters:
response - The servlet response we are creating
Parameters:
content - Should the content be included?
exception:
IOException - if an input/output error occurs
exception:
ServletException - if a servlet-specified error occurs |
| Methods inherited from javax.servlet.http.HttpServlet | protected void doDelete(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException(Code)(Java Doc)
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException(Code)(Java Doc)
protected void doHead(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException(Code)(Java Doc)
protected void doOptions(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException(Code)(Java Doc)
protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException(Code)(Java Doc)
protected void doPut(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException(Code)(Java Doc)
protected void doTrace(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException(Code)(Java Doc)
protected long getLastModified(HttpServletRequest req)(Code)(Java Doc)
protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException(Code)(Java Doc)
public void service(ServletRequest req, ServletResponse res) throws ServletException, IOException(Code)(Java Doc)
|
|
|