Package org.apache.catalina.servlets
Class WebdavServlet
- java.lang.Object
-
- jakarta.servlet.GenericServlet
-
- jakarta.servlet.http.HttpServlet
-
- org.apache.catalina.servlets.DefaultServlet
-
- org.apache.catalina.servlets.WebdavServlet
-
- All Implemented Interfaces:
Servlet,ServletConfig,Serializable
public class WebdavServlet extends DefaultServlet
Servlet which adds support for WebDAV level 2. All the basic HTTP requests are handled by the DefaultServlet. The WebDAVServlet must not be used as the default servlet (ie mapped to '/') as it will not work in this configuration.Mapping a subpath (e.g.
/webdav/*to this servlet has the effect of re-mounting the entire web application under that sub-path, with WebDAV access to all the resources. TheWEB-INFandMETA-INFdirectories are protected in this re-mounted resource tree.To enable WebDAV for a context add the following to web.xml:
<servlet> <servlet-name>webdav</servlet-name> <servlet-class>org.apache.catalina.servlets.WebdavServlet</servlet-class> <init-param> <param-name>debug</param-name> <param-value>0</param-value> </init-param> <init-param> <param-name>listings</param-name> <param-value>false</param-value> </init-param> </servlet> <servlet-mapping> <servlet-name>webdav</servlet-name> <url-pattern>/*</url-pattern> </servlet-mapping>This will enable read only access. To enable read-write access add:<init-param> <param-name>readonly</param-name> <param-value>false</param-value> </init-param>To make the content editable via a different URL, use the following mapping:<servlet-mapping> <servlet-name>webdav</servlet-name> <url-pattern>/webdavedit/*</url-pattern> </servlet-mapping>By default access to /WEB-INF and META-INF are not available via WebDAV. To enable access to these URLs, use add:<init-param> <param-name>allowSpecialPaths</param-name> <param-value>true</param-value> </init-param>Don't forget to secure access appropriately to the editing URLs, especially if allowSpecialPaths is used. With the mapping configuration above, the context will be accessible to normal users as before. Those users with the necessary access will be able to edit content available via http://host:port/context/content using http://host:port/context/webdavedit/content- Author:
- Remy Maucherat
- See Also:
- RFC 4918, Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.catalina.servlets.DefaultServlet
DefaultServlet.CompressionFormat
-
-
Field Summary
Fields Modifier and Type Field Description protected static ConcurrentDateFormatcreationDateFormatSimple date format for the creation date ISO representation (partial).protected static StringDEFAULT_NAMESPACEDefault namespace.-
Fields inherited from class org.apache.catalina.servlets.DefaultServlet
BUFFER_SIZE, compressionFormats, contextXsltFile, debug, fileEncoding, FULL, globalXsltFile, input, listings, localXsltFile, mimeSeparation, output, readmeFile, readOnly, resources, sendfileSize, showServerInfo, sm, sortListings, sortManager, useAcceptRanges
-
-
Constructor Summary
Constructors Constructor Description WebdavServlet()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected booleancheckIfHeaders(HttpServletRequest request, HttpServletResponse response, WebResource resource)Check if the conditions specified in the optional If headers are satisfied.protected StringdetermineMethodsAllowed(HttpServletRequest req)Determines the methods normally allowed for the resource.protected voiddoCopy(HttpServletRequest req, HttpServletResponse resp)COPY Method.protected voiddoDelete(HttpServletRequest req, HttpServletResponse resp)DELETE Method.protected voiddoLock(HttpServletRequest req, HttpServletResponse resp)LOCK Method.protected voiddoMkcol(HttpServletRequest req, HttpServletResponse resp)MKCOL Method.protected voiddoMove(HttpServletRequest req, HttpServletResponse resp)MOVE Method.protected voiddoOptions(HttpServletRequest req, HttpServletResponse resp)OPTIONS Method.protected voiddoPropfind(HttpServletRequest req, HttpServletResponse resp)PROPFIND Method.protected voiddoProppatch(HttpServletRequest req, HttpServletResponse resp)PROPPATCH Method.protected voiddoPut(HttpServletRequest req, HttpServletResponse resp)Process a PUT request for the specified resource.protected voiddoUnlock(HttpServletRequest req, HttpServletResponse resp)UNLOCK Method.protected DocumentBuildergetDocumentBuilder()Return JAXP document builder instance.protected StringgetPathPrefix(HttpServletRequest request)Determines the prefix for standard directory GET listings.protected StringgetRelativePath(HttpServletRequest request)Override the DefaultServlet implementation and only use the PathInfo.protected StringgetRelativePath(HttpServletRequest request, boolean allowEmptyPath)voidinit()Initialize this servlet.protected StringrewriteUrl(String path)URL rewriter.protected voidservice(HttpServletRequest req, HttpServletResponse resp)Handles the special WebDAV methods.-
Methods inherited from class org.apache.catalina.servlets.DefaultServlet
checkIfMatch, checkIfModifiedSince, checkIfNoneMatch, checkIfUnmodifiedSince, checkSendfile, copy, copy, copy, copy, copyRange, copyRange, copyRange, destroy, doGet, doHead, doPost, executePartialPut, findXsltSource, generateETag, getReadme, parseContentRange, parseRange, render, renderHtml, renderSize, renderXml, sendNotAllowed, serveResource
-
Methods inherited from class jakarta.servlet.http.HttpServlet
doTrace, getLastModified, service
-
Methods inherited from class jakarta.servlet.GenericServlet
getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log
-
-
-
-
Field Detail
-
DEFAULT_NAMESPACE
protected static final String DEFAULT_NAMESPACE
Default namespace.- See Also:
- Constant Field Values
-
creationDateFormat
protected static final ConcurrentDateFormat creationDateFormat
Simple date format for the creation date ISO representation (partial).
-
-
Method Detail
-
init
public void init() throws ServletExceptionInitialize this servlet.- Overrides:
initin classDefaultServlet- Throws:
ServletException- if an exception occurs that interrupts the servlet's normal operation
-
getDocumentBuilder
protected DocumentBuilder getDocumentBuilder() throws ServletException
Return JAXP document builder instance.- Returns:
- the document builder
- Throws:
ServletException- document builder creation failed (wrappedParserConfigurationExceptionexception)
-
service
protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException
Handles the special WebDAV methods.- Overrides:
servicein classDefaultServlet- Parameters:
req- theHttpServletRequestobject that contains the request the client made of the servletresp- theHttpServletResponseobject that contains the response the servlet returns to the client- Throws:
ServletException- if the HTTP request cannot be handledIOException- if an input or output error occurs while the servlet is handling the HTTP request- See Also:
Servlet.service(jakarta.servlet.ServletRequest, jakarta.servlet.ServletResponse)
-
checkIfHeaders
protected boolean checkIfHeaders(HttpServletRequest request, HttpServletResponse response, WebResource resource) throws IOException
Description copied from class:DefaultServletCheck if the conditions specified in the optional If headers are satisfied.- Overrides:
checkIfHeadersin classDefaultServlet- Parameters:
request- The servlet request we are processingresponse- The servlet response we are creatingresource- The resource- Returns:
trueif the resource meets all the specified conditions, andfalseif any of the conditions is not satisfied, in which case request processing is stopped- Throws:
IOException- an IO error occurred
-
rewriteUrl
protected String rewriteUrl(String path)
URL rewriter.- Overrides:
rewriteUrlin classDefaultServlet- Parameters:
path- Path which has to be rewritten- Returns:
- the rewritten path
-
getRelativePath
protected String getRelativePath(HttpServletRequest request)
Override the DefaultServlet implementation and only use the PathInfo. If the ServletPath is non-null, it will be because the WebDAV servlet has been mapped to a url other than /* to configure editing at different url than normal viewing.- Overrides:
getRelativePathin classDefaultServlet- Parameters:
request- The servlet request we are processing- Returns:
- the relative path
-
getRelativePath
protected String getRelativePath(HttpServletRequest request, boolean allowEmptyPath)
- Overrides:
getRelativePathin classDefaultServlet
-
getPathPrefix
protected String getPathPrefix(HttpServletRequest request)
Determines the prefix for standard directory GET listings.- Overrides:
getPathPrefixin classDefaultServlet- Parameters:
request- the request to determine the path for- Returns:
- the prefix to apply to all resources in the listing.
-
doOptions
protected void doOptions(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException
OPTIONS Method.- Overrides:
doOptionsin classDefaultServlet- Parameters:
req- The Servlet requestresp- The Servlet response- Throws:
ServletException- If an error occursIOException- If an IO error occurs
-
doPropfind
protected void doPropfind(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException
PROPFIND Method.- Parameters:
req- The Servlet requestresp- The Servlet response- Throws:
ServletException- If an error occursIOException- If an IO error occurs
-
doProppatch
protected void doProppatch(HttpServletRequest req, HttpServletResponse resp) throws IOException
PROPPATCH Method.- Parameters:
req- The Servlet requestresp- The Servlet response- Throws:
IOException- If an IO error occurs
-
doMkcol
protected void doMkcol(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException
MKCOL Method.- Parameters:
req- The Servlet requestresp- The Servlet response- Throws:
ServletException- If an error occursIOException- If an IO error occurs
-
doDelete
protected void doDelete(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException
DELETE Method.- Overrides:
doDeletein classDefaultServlet- Parameters:
req- The Servlet requestresp- The Servlet response- Throws:
ServletException- If an error occursIOException- If an IO error occurs
-
doPut
protected void doPut(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException
Process a PUT request for the specified resource.- Overrides:
doPutin classDefaultServlet- Parameters:
req- The servlet request we are processingresp- The servlet response we are creating- Throws:
IOException- if an input/output error occursServletException- if a servlet-specified error occurs
-
doCopy
protected void doCopy(HttpServletRequest req, HttpServletResponse resp) throws IOException
COPY Method.- Parameters:
req- The Servlet requestresp- The Servlet response- Throws:
IOException- If an IO error occurs
-
doMove
protected void doMove(HttpServletRequest req, HttpServletResponse resp) throws IOException
MOVE Method.- Parameters:
req- The Servlet requestresp- The Servlet response- Throws:
IOException- If an IO error occurs
-
doLock
protected void doLock(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException
LOCK Method.- Parameters:
req- The Servlet requestresp- The Servlet response- Throws:
ServletException- If an error occursIOException- If an IO error occurs
-
doUnlock
protected void doUnlock(HttpServletRequest req, HttpServletResponse resp) throws IOException
UNLOCK Method.- Parameters:
req- The Servlet requestresp- The Servlet response- Throws:
IOException- If an IO error occurs
-
determineMethodsAllowed
protected String determineMethodsAllowed(HttpServletRequest req)
Determines the methods normally allowed for the resource.- Overrides:
determineMethodsAllowedin classDefaultServlet- Parameters:
req- The Servlet request- Returns:
- The allowed HTTP methods
-
-