org.dspace.app.dav

Class DAVServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.dspace.app.dav.DAVServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class DAVServlet
extends javax.servlet.http.HttpServlet

Servlet implementing WebDAV server for DSpace.

Version:

$Revision$

Author:

Larry Stone

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DAVServlet()

Method Summary

Methods

Modifier and Type	Method and Description
protected static String	decodeFromURL(String in) Sugar-coating for URLDecoder.decode, used all over.
protected void	doOptions(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Handler for HTTP OPTIONS method.
protected static boolean	getAuthFromCookie(Context context, javax.servlet.http.HttpServletRequest request) Get Session Cookie.
protected static void	putAuthCookie(Context context, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, boolean force) Set a new cookie -- only bother if there is no existing cookie or it's at least halfway stale, so you're not churning it..
protected void	service(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) override service() to add DAV methods.
protected static boolean	serviceInternal(String method, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Pass this request along to the appropriate resource and method.

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doPost, doPut, doTrace, getLastModified, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, log, log

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DAVServlet

public DAVServlet()

Method Detail

getAuthFromCookie

protected static boolean getAuthFromCookie(Context context,
                        javax.servlet.http.HttpServletRequest request)
                                    throws SQLException

Get Session Cookie.

DAVServlet rolls its own session cookie because the Servlet container's session cannot be constrained to use ONLY cookies and NOT URL-rewriting, and the latter would break the DAV protocol so we cannot use it. Since we really only need to cache the authenticated EPerson (an integer ID) anyway, it's easy enough so simply stuff that into a cookie.

Cookie format is:
{timestamp}!{epersonID}!{client-IP}!{MAC}
where timestamp and eperson are integers; client IP is dotted IP notation, and MAC is the hex MD5 of the preceding fields plus the "cookieSecret" string. The MAC ensures that the cookie was issued by this servlet.

Look for authentication cookie and try to get a previously-authenticated EPerson from it if found. Also check the timestamp to be sure the cookie isn't "stale".

NOTE This is also used by the SOAP servlet.

Parameters:

context - - set user in this context

request - - HTTP request.

Returns:

true when a fresh cookie yields a valid eperson.

Throws:

SQLException - the SQL exception

putAuthCookie

protected static void putAuthCookie(Context context,
                 javax.servlet.http.HttpServletRequest request,
                 javax.servlet.http.HttpServletResponse response,
                 boolean force)

Set a new cookie -- only bother if there is no existing cookie or it's at least halfway stale, so you're not churning it.. When force is true, always set a fresh cookie. (e.g. after mac failure upon server restart, etc)

Parameters:

context - - get user from context

request - the request

response - the response

force - the force

service

protected void service(javax.servlet.http.HttpServletRequest request,
           javax.servlet.http.HttpServletResponse response)
                throws javax.servlet.ServletException,
                       IOException

override service() to add DAV methods.

Overrides:

service in class javax.servlet.http.HttpServlet

Parameters:

request - the request

response - the response

Throws:

javax.servlet.ServletException - the servlet exception

IOException - Signals that an I/O exception has occurred.

serviceInternal

protected static boolean serviceInternal(String method,
                      javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)
                                  throws IOException

Pass this request along to the appropriate resource and method. Includes authentication, where needed. Return true if we handle this request, false otherwise. True means response has been "sent", false not.

Parameters:

method - the method

request - the request

response - the response

Returns:

true, if service internal

Throws:

IOException - Signals that an I/O exception has occurred.

doOptions

protected void doOptions(javax.servlet.http.HttpServletRequest request,
             javax.servlet.http.HttpServletResponse response)
                  throws javax.servlet.ServletException,
                         IOException

Handler for HTTP OPTIONS method. Same for all resources under the WeDAV root. Add DAV methods so client knows we handle DAV.

Overrides:

doOptions in class javax.servlet.http.HttpServlet

Parameters:

request - the request

response - the response

Throws:

javax.servlet.ServletException - the servlet exception

IOException - Signals that an I/O exception has occurred.

decodeFromURL

protected static String decodeFromURL(String in)

Sugar-coating for URLDecoder.decode, used all over.

Parameters:

in - the in

Returns:

the string