org.sakaiproject.dav

Class DavServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.sakaiproject.dav.DavServlet

All Implemented Interfaces:

Serializable, Servlet, ServletConfig

public class DavServlet
extends HttpServlet

Servlet which adds support for WebDAV level 2. All the basic HTTP requests are handled by the DefaultServlet.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DavServlet.DirContextSAKAI
class	DavServlet.ResourceInfoSAKAI
class	DavServlet.SakaidavServletInfo

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	DEFAULT_NAMESPACE Default namespace.
protected static char[]	hexadecimal
protected boolean	m_siteAlias Configuration: allow use of alias for site id in references.
protected static int	MAX_XML_STREAM_LENGTH Max Size for xml property streams 4K
protected static MessageDigest	md5Helper MD5 message digest provider.
protected static org.sakaiproject.util.ResourceLoader	rb
protected boolean	readOnly Read only flag.
protected static BitSet	safeCharacters Array containing the safe characters set.
protected static int	STREAM_BUFFER_SIZE Size of buffer for streaming downloads

Constructor Summary

Constructors

Constructor and Description
DavServlet()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	adjustId(String id) Adjust the id (a resource id) to map between any tricks we want to play and the real id for content hosting.
protected int	countSlashes(String s)
protected void	doCopy(HttpServletRequest req, HttpServletResponse resp) COPY Method.
protected void	doDelete(HttpServletRequest req, HttpServletResponse resp) DELETE Method.
protected void	doDispatch(DavServlet.SakaidavServletInfo info, HttpServletRequest req, HttpServletResponse resp) Handles the special Webdav methods
protected void	doGet(HttpServletRequest req, HttpServletResponse resp) GET Method.
protected void	doHead(HttpServletRequest request, HttpServletResponse response) Process a HEAD request for the specified resource.
protected void	doLock(HttpServletRequest req, HttpServletResponse resp) LOCK Method.
protected void	doMkcol(HttpServletRequest req, HttpServletResponse resp) MKCOL Method.
protected void	doMove(HttpServletRequest req, HttpServletResponse resp) MOVE Method.
protected void	doOptions(HttpServletRequest req, HttpServletResponse resp) OPTIONS Method.
protected void	doPost(HttpServletRequest req, HttpServletResponse resp) POST Method.
protected void	doPropfind(HttpServletRequest req, HttpServletResponse resp) PROPFIND Method.
protected void	doProppatch(HttpServletRequest req, HttpServletResponse resp) PROPPATCH Method.
protected void	doPut(HttpServletRequest req, HttpServletResponse resp) Process a PUT request for the specified resource.
protected void	doUnlock(HttpServletRequest req, HttpServletResponse resp) UNLOCK Method.
String	fixDirPathSAKAI(String path)
protected DocumentBuilder	getDocumentBuilder() Return JAXP document builder instance.
protected String	getRelativePath(HttpServletRequest request) Return the relative path associated with this servlet.
String	getRelativePathSAKAI(HttpServletRequest req)
String	getResourceNameSAKAI(org.sakaiproject.entity.api.Entity mbr) getResourceNameSAKAI - Needs to become a method of resource returns the internal name for a resource.
DavServlet.DirContextSAKAI	getResourcesSAKAI()
protected String	getUserPropertyDisplayName(org.sakaiproject.entity.api.ResourceProperties props, String name)
void	init() Initialize this servlet.
protected boolean	isFileNameAllowed(HttpServletRequest req) Determine if this path is one of the prefixes that we have been requested to ignore by the properties settings
protected String	justName(String str)
void	log(HttpServletRequest req, DavServlet.SakaidavServletInfo info) log a request processed
DavServlet.SakaidavServletInfo	newInfo(HttpServletRequest req) create the info
protected String	normalize(String path) Return a context-relative path, beginning with a "/", that represents the canonical version of the specified path after ".." and "." elements are resolved out.
protected boolean	prohibited(String id)
protected String	rewriteUrl(String path) URL rewriter.
protected void	service(HttpServletRequest req, HttpServletResponse res) Setup and cleanup around this request.
protected void	showRequestInfo(HttpServletRequest req) Show HTTP header information.

Methods inherited from class javax.servlet.http.HttpServlet

doTrace, getLastModified, 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

rb

protected static org.sakaiproject.util.ResourceLoader rb

readOnly

protected boolean readOnly

Read only flag. By default, it's set to true.

DEFAULT_NAMESPACE

protected static final String DEFAULT_NAMESPACE

Default namespace.

See Also:

Constant Field Values

STREAM_BUFFER_SIZE

protected static final int STREAM_BUFFER_SIZE

Size of buffer for streaming downloads

See Also:

Constant Field Values

MAX_XML_STREAM_LENGTH

protected static final int MAX_XML_STREAM_LENGTH

Max Size for xml property streams 4K

See Also:

Constant Field Values

m_siteAlias

protected boolean m_siteAlias

Configuration: allow use of alias for site id in references.

md5Helper

protected static MessageDigest md5Helper

MD5 message digest provider.

safeCharacters

protected static BitSet safeCharacters

Array containing the safe characters set.

hexadecimal

protected static final char[] hexadecimal

Constructor Detail

DavServlet

public DavServlet()

Method Detail

prohibited

protected boolean prohibited(String id)

adjustId

protected String adjustId(String id)

Adjust the id (a resource id) to map between any tricks we want to play and the real id for content hosting.

Parameters:

id - the id to adjust.

Returns:

the adjusted id.

init

public void init()
          throws ServletException

Initialize this servlet.

Overrides:

init in class GenericServlet

Throws:

ServletException

newInfo

public DavServlet.SakaidavServletInfo newInfo(HttpServletRequest req)

create the info

getUserPropertyDisplayName

protected String getUserPropertyDisplayName(org.sakaiproject.entity.api.ResourceProperties props,
                                String name)

showRequestInfo

protected void showRequestInfo(HttpServletRequest req)

Show HTTP header information.

getRelativePath

protected String getRelativePath(HttpServletRequest request)

Return the relative path associated with this servlet.

Parameters:

request - The servlet request we are processing

normalize

protected String normalize(String path)

Return a context-relative path, beginning with a "/", that represents the canonical version of the specified path after ".." and "." elements are resolved out. If the specified path attempts to go outside the boundaries of the current context (i.e. too many ".." path elements are present), return null instead.

Parameters:

path - Path to be normalized

rewriteUrl

protected String rewriteUrl(String path)

URL rewriter.

Parameters:

path - Path which has to be rewiten

getDocumentBuilder

protected DocumentBuilder getDocumentBuilder()
                                      throws ServletException

Return JAXP document builder instance.

Throws:

ServletException

service

protected void service(HttpServletRequest req,
           HttpServletResponse res)
                throws ServletException,
                       IOException

Setup and cleanup around this request.

Overrides:

service in class HttpServlet

Parameters:

req - HttpServletRequest object with the client request

res - HttpServletResponse object back to the client

Throws:

ServletException

IOException

log

public void log(HttpServletRequest req,
       DavServlet.SakaidavServletInfo info)

log a request processed

doDispatch

protected void doDispatch(DavServlet.SakaidavServletInfo info,
              HttpServletRequest req,
              HttpServletResponse resp)
                   throws ServletException,
                          IOException

Handles the special Webdav methods

Throws:

ServletException

IOException

isFileNameAllowed

protected boolean isFileNameAllowed(HttpServletRequest req)

Determine if this path is one of the prefixes that we have been requested to ignore by the properties settings

Parameters:

request - The servlet request we are processing

doHead

protected void doHead(HttpServletRequest request,
          HttpServletResponse response)
               throws IOException,
                      ServletException

Process a HEAD request for the specified resource.

Overrides:

doHead in class HttpServlet

Parameters:

request - The servlet request we are processing

response - The servlet response we are creating

Throws:

IOException - if an input/output error occurs

ServletException - if a servlet-specified error occurs

doOptions

protected void doOptions(HttpServletRequest req,
             HttpServletResponse resp)
                  throws ServletException,
                         IOException

OPTIONS Method.

Overrides:

doOptions in class HttpServlet

Throws:

ServletException

IOException

getResourcesSAKAI

public DavServlet.DirContextSAKAI getResourcesSAKAI()

fixDirPathSAKAI

public String fixDirPathSAKAI(String path)

doPost

protected void doPost(HttpServletRequest req,
          HttpServletResponse resp)
               throws ServletException,
                      IOException

POST Method.

Overrides:

doPost in class HttpServlet

Throws:

ServletException

IOException

doGet

protected void doGet(HttpServletRequest req,
         HttpServletResponse resp)
              throws ServletException,
                     IOException

GET Method.

Overrides:

doGet in class HttpServlet

Throws:

ServletException

IOException

countSlashes

protected int countSlashes(String s)

getRelativePathSAKAI

public String getRelativePathSAKAI(HttpServletRequest req)

getResourceNameSAKAI

public String getResourceNameSAKAI(org.sakaiproject.entity.api.Entity mbr)

getResourceNameSAKAI - Needs to become a method of resource returns the internal name for a resource.

doPropfind

protected void doPropfind(HttpServletRequest req,
              HttpServletResponse resp)
                   throws ServletException,
                          IOException

PROPFIND Method.

Throws:

ServletException

IOException

doProppatch

protected void doProppatch(HttpServletRequest req,
               HttpServletResponse resp)
                    throws ServletException,
                           IOException

PROPPATCH Method.

Throws:

ServletException

IOException

justName

protected String justName(String str)

doMkcol

protected void doMkcol(HttpServletRequest req,
           HttpServletResponse resp)
                throws ServletException,
                       IOException

MKCOL Method.

Throws:

ServletException

IOException

doDelete

protected void doDelete(HttpServletRequest req,
            HttpServletResponse resp)
                 throws ServletException,
                        IOException

DELETE Method.

Overrides:

doDelete in class HttpServlet

Throws:

ServletException

IOException

doPut

protected void doPut(HttpServletRequest req,
         HttpServletResponse resp)
              throws ServletException,
                     IOException

Process a PUT request for the specified resource.

Overrides:

doPut in class HttpServlet

Parameters:

request - The servlet request we are processing

response - The servlet response we are creating

Throws:

IOException - if an input/output error occurs

ServletException - if a servlet-specified error occurs

doCopy

protected void doCopy(HttpServletRequest req,
          HttpServletResponse resp)
               throws ServletException,
                      IOException

COPY Method.

Throws:

ServletException

IOException

doMove

protected void doMove(HttpServletRequest req,
          HttpServletResponse resp)
               throws ServletException,
                      IOException

MOVE Method.

Throws:

ServletException

IOException

doLock

protected void doLock(HttpServletRequest req,
          HttpServletResponse resp)
               throws ServletException,
                      IOException

LOCK Method.

Throws:

ServletException

IOException

doUnlock

protected void doUnlock(HttpServletRequest req,
            HttpServletResponse resp)
                 throws ServletException,
                        IOException

UNLOCK Method.

Throws:

ServletException

IOException