com.logicaldoc.webdav.web

Class AbstractWebdavServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.logicaldoc.webdav.web.AbstractWebdavServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig, org.apache.jackrabbit.webdav.DavConstants

Direct Known Subclasses:

WebdavServlet

public abstract class AbstractWebdavServlet
extends javax.servlet.http.HttpServlet
implements org.apache.jackrabbit.webdav.DavConstants

AbstractWebdavServlet

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_AUTHENTICATE_HEADER Default value for the 'WWW-Authenticate' header, that is set, if request results in a 401 (Unauthorized) error.
protected static org.slf4j.Logger	log

Fields inherited from interface org.apache.jackrabbit.webdav.DavConstants

creationDateFormat, DEPTH_0, DEPTH_1, DEPTH_INFINITY, DEPTH_INFINITY_S, HEADER_AUTHORIZATION, HEADER_CONTENT_LANGUAGE, HEADER_CONTENT_LENGTH, HEADER_CONTENT_TYPE, HEADER_DAV, HEADER_DEPTH, HEADER_DESTINATION, HEADER_ETAG, HEADER_IF, HEADER_LAST_MODIFIED, HEADER_LOCK_TOKEN, HEADER_OVERWRITE, HEADER_TIMEOUT, INFINITE_TIMEOUT, modificationDateFormat, NAMESPACE, OPAQUE_LOCK_TOKEN_PREFIX, PROPERTY_CREATIONDATE, PROPERTY_DISPLAYNAME, PROPERTY_GETCONTENTLANGUAGE, PROPERTY_GETCONTENTLENGTH, PROPERTY_GETCONTENTTYPE, PROPERTY_GETETAG, PROPERTY_GETLASTMODIFIED, PROPERTY_LOCKDISCOVERY, PROPERTY_RESOURCETYPE, PROPERTY_SOURCE, PROPERTY_SUPPORTEDLOCK, PROPFIND_ALL_PROP, PROPFIND_ALL_PROP_INCLUDE, PROPFIND_BY_PROPERTY, PROPFIND_PROPERTY_NAMES, TIMEOUT_INFINITE, UNDEFINED_TIME, UNDEFINED_TIMEOUT, XML_ACTIVELOCK, XML_ALLPROP, XML_COLLECTION, XML_DEPTH, XML_DST, XML_EXCLUSIVE, XML_HREF, XML_INCLUDE, XML_KEEPALIVE, XML_LINK, XML_LOCKENTRY, XML_LOCKINFO, XML_LOCKROOT, XML_LOCKSCOPE, XML_LOCKTOKEN, XML_LOCKTYPE, XML_MULTISTATUS, XML_OMIT, XML_OWNER, XML_PROP, XML_PROPERTYBEHAVIOR, XML_PROPERTYUPDATE, XML_PROPFIND, XML_PROPNAME, XML_PROPSTAT, XML_REMOVE, XML_RESPONSE, XML_RESPONSEDESCRIPTION, XML_SET, XML_SHARED, XML_SOURCE, XML_STATUS, XML_TIMEOUT, XML_WRITE

Constructor Summary

Constructors

Constructor and Description
AbstractWebdavServlet()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doCheckin(org.apache.jackrabbit.webdav.WebdavRequest request, org.apache.jackrabbit.webdav.WebdavResponse response, org.apache.jackrabbit.webdav.DavResource resource) The EVENT_CHECKEDIN method
protected void	doCheckout(org.apache.jackrabbit.webdav.WebdavRequest request, org.apache.jackrabbit.webdav.WebdavResponse response, org.apache.jackrabbit.webdav.DavResource resource) The EVENT_CHECKEDOUT method
protected void	doCopy(org.apache.jackrabbit.webdav.WebdavRequest request, org.apache.jackrabbit.webdav.WebdavResponse response, org.apache.jackrabbit.webdav.DavResource resource) The COPY method
protected void	doDelete(org.apache.jackrabbit.webdav.WebdavRequest request, org.apache.jackrabbit.webdav.WebdavResponse response, org.apache.jackrabbit.webdav.DavResource resource) The DELETE method
protected void	doGet(org.apache.jackrabbit.webdav.WebdavRequest request, org.apache.jackrabbit.webdav.WebdavResponse response, org.apache.jackrabbit.webdav.DavResource resource) The GET method
protected void	doHead(org.apache.jackrabbit.webdav.WebdavRequest request, org.apache.jackrabbit.webdav.WebdavResponse response, org.apache.jackrabbit.webdav.DavResource resource) The HEAD method
protected void	doLock(org.apache.jackrabbit.webdav.WebdavRequest request, org.apache.jackrabbit.webdav.WebdavResponse response, org.apache.jackrabbit.webdav.DavResource resource)
protected void	doMkCol(org.apache.jackrabbit.webdav.WebdavRequest request, org.apache.jackrabbit.webdav.WebdavResponse response, org.apache.jackrabbit.webdav.DavResource resource) The MKCOL method
protected void	doMove(org.apache.jackrabbit.webdav.WebdavRequest request, org.apache.jackrabbit.webdav.WebdavResponse response, org.apache.jackrabbit.webdav.DavResource resource) The MOVE method
protected void	doOptions(org.apache.jackrabbit.webdav.WebdavRequest request, org.apache.jackrabbit.webdav.WebdavResponse response, org.apache.jackrabbit.webdav.DavResource resource) The OPTION method
protected void	doPost(org.apache.jackrabbit.webdav.WebdavRequest request, org.apache.jackrabbit.webdav.WebdavResponse response, org.apache.jackrabbit.webdav.DavResource resource) The POST method.
protected void	doPropFind(org.apache.jackrabbit.webdav.WebdavRequest request, org.apache.jackrabbit.webdav.WebdavResponse response, org.apache.jackrabbit.webdav.DavResource resource) The PROPFIND method
protected void	doPropPatch(org.apache.jackrabbit.webdav.WebdavRequest request, org.apache.jackrabbit.webdav.WebdavResponse response, org.apache.jackrabbit.webdav.DavResource resource) The PROPPATCH method
protected void	doPut(org.apache.jackrabbit.webdav.WebdavRequest request, org.apache.jackrabbit.webdav.WebdavResponse response, org.apache.jackrabbit.webdav.DavResource resource) The PUT method
protected void	doReport(org.apache.jackrabbit.webdav.WebdavRequest request, org.apache.jackrabbit.webdav.WebdavResponse response, org.apache.jackrabbit.webdav.DavResource resource) The REPORT method
protected void	doUncheckout(org.apache.jackrabbit.webdav.WebdavRequest request, org.apache.jackrabbit.webdav.WebdavResponse response, org.apache.jackrabbit.webdav.DavResource resource) The EVENT_UNCHECKOUT method
protected void	doUnlock(org.apache.jackrabbit.webdav.WebdavRequest request, org.apache.jackrabbit.webdav.WebdavResponse response, org.apache.jackrabbit.webdav.DavResource resource) The UNLOCK method
protected void	doVersionControl(org.apache.jackrabbit.webdav.WebdavRequest request, org.apache.jackrabbit.webdav.WebdavResponse response, org.apache.jackrabbit.webdav.DavResource resource)
protected boolean	execute(org.apache.jackrabbit.webdav.WebdavRequest request, org.apache.jackrabbit.webdav.WebdavResponse response, int method, org.apache.jackrabbit.webdav.DavResource resource) Executes the respective method in the given webdav context
abstract String	getAuthenticateHeaderValue() Returns the value of the 'WWW-Authenticate' header, that is returned in case of 401 error.
protected org.apache.jackrabbit.webdav.io.InputContext	getInputContext(org.apache.jackrabbit.webdav.DavServletRequest request, InputStream in) Return a new InputContext used for adding resource members
abstract org.apache.jackrabbit.webdav.DavLocatorFactory	getLocatorFactory() Returns the DavLocatorFactory.
protected org.apache.jackrabbit.webdav.io.OutputContext	getOutputContext(org.apache.jackrabbit.webdav.DavServletResponse response, OutputStream out) Return a new OutputContext used for spooling resource properties and the resource content
abstract DavResourceFactory	getResourceFactory() Returns the DavResourceFactory.
protected abstract boolean	isPreconditionValid(org.apache.jackrabbit.webdav.WebdavRequest request, org.apache.jackrabbit.webdav.DavResource resource) Checks if the precondition for this request and resource is valid.
void	service(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Service the given request.
abstract void	setLocatorFactory(org.apache.jackrabbit.webdav.DavLocatorFactory locatorFactory) Sets the DavLocatorFactory.
abstract void	setResourceFactory(DavResourceFactory resourceFactory) Sets the DavResourceFactory.

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, 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

Field Detail

log

protected static org.slf4j.Logger log

DEFAULT_AUTHENTICATE_HEADER

public static final String DEFAULT_AUTHENTICATE_HEADER

Default value for the 'WWW-Authenticate' header, that is set, if request results in a 401 (Unauthorized) error.

See Also:

getAuthenticateHeaderValue(), Constant Field Values

Constructor Detail

AbstractWebdavServlet

public AbstractWebdavServlet()

Method Detail

isPreconditionValid

protected abstract boolean isPreconditionValid(org.apache.jackrabbit.webdav.WebdavRequest request,
                          org.apache.jackrabbit.webdav.DavResource resource)

Checks if the precondition for this request and resource is valid.

Parameters:

request -

resource -

Returns:

getLocatorFactory

public abstract org.apache.jackrabbit.webdav.DavLocatorFactory getLocatorFactory()

Returns the DavLocatorFactory.

Returns:

the locator factory

setLocatorFactory

public abstract void setLocatorFactory(org.apache.jackrabbit.webdav.DavLocatorFactory locatorFactory)

Sets the DavLocatorFactory.

Parameters:

locatorFactory -

getResourceFactory

public abstract DavResourceFactory getResourceFactory()

Returns the DavResourceFactory.

Returns:

the resource factory

setResourceFactory

public abstract void setResourceFactory(DavResourceFactory resourceFactory)

Sets the DavResourceFactory.

Parameters:

resourceFactory -

getAuthenticateHeaderValue

public abstract String getAuthenticateHeaderValue()

Returns the value of the 'WWW-Authenticate' header, that is returned in case of 401 error.

Returns:

value of the 'WWW-Authenticate' header

service

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

Service the given request.

Overrides:

service in class javax.servlet.http.HttpServlet

Parameters:

request -

response -

Throws:

javax.servlet.ServletException

IOException

execute

protected boolean execute(org.apache.jackrabbit.webdav.WebdavRequest request,
              org.apache.jackrabbit.webdav.WebdavResponse response,
              int method,
              org.apache.jackrabbit.webdav.DavResource resource)
                   throws javax.servlet.ServletException,
                          IOException,
                          org.apache.jackrabbit.webdav.DavException

Executes the respective method in the given webdav context

Parameters:

request -

response -

method -

resource -

Throws:

javax.servlet.ServletException

IOException

org.apache.jackrabbit.webdav.DavException

doHead

protected void doHead(org.apache.jackrabbit.webdav.WebdavRequest request,
          org.apache.jackrabbit.webdav.WebdavResponse response,
          org.apache.jackrabbit.webdav.DavResource resource)
               throws IOException

The HEAD method

Parameters:

request -

response -

resource -

Throws:

IOException

doGet

protected void doGet(org.apache.jackrabbit.webdav.WebdavRequest request,
         org.apache.jackrabbit.webdav.WebdavResponse response,
         org.apache.jackrabbit.webdav.DavResource resource)
              throws IOException

The GET method

Parameters:

request -

response -

resource -

Throws:

IOException

doPropFind

protected void doPropFind(org.apache.jackrabbit.webdav.WebdavRequest request,
              org.apache.jackrabbit.webdav.WebdavResponse response,
              org.apache.jackrabbit.webdav.DavResource resource)
                   throws IOException,
                          org.apache.jackrabbit.webdav.DavException

The PROPFIND method

Parameters:

request -

response -

resource -

Throws:

IOException

org.apache.jackrabbit.webdav.DavException

doPropPatch

protected void doPropPatch(org.apache.jackrabbit.webdav.WebdavRequest request,
               org.apache.jackrabbit.webdav.WebdavResponse response,
               org.apache.jackrabbit.webdav.DavResource resource)
                    throws IOException,
                           org.apache.jackrabbit.webdav.DavException

The PROPPATCH method

Parameters:

request -

response -

resource -

Throws:

IOException

org.apache.jackrabbit.webdav.DavException

doPost

protected void doPost(org.apache.jackrabbit.webdav.WebdavRequest request,
          org.apache.jackrabbit.webdav.WebdavResponse response,
          org.apache.jackrabbit.webdav.DavResource resource)
               throws IOException,
                      org.apache.jackrabbit.webdav.DavException

The POST method. Delegate to PUT

Parameters:

request -

response -

resource -

Throws:

IOException

org.apache.jackrabbit.webdav.DavException

doPut

protected void doPut(org.apache.jackrabbit.webdav.WebdavRequest request,
         org.apache.jackrabbit.webdav.WebdavResponse response,
         org.apache.jackrabbit.webdav.DavResource resource)
              throws IOException,
                     org.apache.jackrabbit.webdav.DavException

The PUT method

Parameters:

request -

response -

resource -

Throws:

IOException

org.apache.jackrabbit.webdav.DavException

doMkCol

protected void doMkCol(org.apache.jackrabbit.webdav.WebdavRequest request,
           org.apache.jackrabbit.webdav.WebdavResponse response,
           org.apache.jackrabbit.webdav.DavResource resource)
                throws IOException,
                       org.apache.jackrabbit.webdav.DavException

The MKCOL method

Parameters:

request -

response -

resource -

Throws:

IOException

org.apache.jackrabbit.webdav.DavException

doDelete

protected void doDelete(org.apache.jackrabbit.webdav.WebdavRequest request,
            org.apache.jackrabbit.webdav.WebdavResponse response,
            org.apache.jackrabbit.webdav.DavResource resource)
                 throws IOException,
                        org.apache.jackrabbit.webdav.DavException

The DELETE method

Parameters:

request -

response -

resource -

Throws:

IOException

org.apache.jackrabbit.webdav.DavException

doCopy

protected void doCopy(org.apache.jackrabbit.webdav.WebdavRequest request,
          org.apache.jackrabbit.webdav.WebdavResponse response,
          org.apache.jackrabbit.webdav.DavResource resource)
               throws IOException,
                      org.apache.jackrabbit.webdav.DavException

The COPY method

Parameters:

request -

response -

resource -

Throws:

IOException

org.apache.jackrabbit.webdav.DavException

doMove

protected void doMove(org.apache.jackrabbit.webdav.WebdavRequest request,
          org.apache.jackrabbit.webdav.WebdavResponse response,
          org.apache.jackrabbit.webdav.DavResource resource)
               throws IOException,
                      org.apache.jackrabbit.webdav.DavException

The MOVE method

Parameters:

request -

response -

resource -

Throws:

IOException

org.apache.jackrabbit.webdav.DavException

doOptions

protected void doOptions(org.apache.jackrabbit.webdav.WebdavRequest request,
             org.apache.jackrabbit.webdav.WebdavResponse response,
             org.apache.jackrabbit.webdav.DavResource resource)
                  throws IOException,
                         org.apache.jackrabbit.webdav.DavException

The OPTION method

Parameters:

request -

response -

resource -

Throws:

IOException

org.apache.jackrabbit.webdav.DavException

doVersionControl

protected void doVersionControl(org.apache.jackrabbit.webdav.WebdavRequest request,
                    org.apache.jackrabbit.webdav.WebdavResponse response,
                    org.apache.jackrabbit.webdav.DavResource resource)
                         throws org.apache.jackrabbit.webdav.DavException,
                                IOException

Throws:

org.apache.jackrabbit.webdav.DavException

IOException

doLock

protected void doLock(org.apache.jackrabbit.webdav.WebdavRequest request,
          org.apache.jackrabbit.webdav.WebdavResponse response,
          org.apache.jackrabbit.webdav.DavResource resource)
               throws IOException,
                      org.apache.jackrabbit.webdav.DavException

Throws:

IOException

org.apache.jackrabbit.webdav.DavException

doUnlock

protected void doUnlock(org.apache.jackrabbit.webdav.WebdavRequest request,
            org.apache.jackrabbit.webdav.WebdavResponse response,
            org.apache.jackrabbit.webdav.DavResource resource)
                 throws org.apache.jackrabbit.webdav.DavException

The UNLOCK method

Parameters:

request -

response -

resource -

Throws:

org.apache.jackrabbit.webdav.DavException

doCheckout

protected void doCheckout(org.apache.jackrabbit.webdav.WebdavRequest request,
              org.apache.jackrabbit.webdav.WebdavResponse response,
              org.apache.jackrabbit.webdav.DavResource resource)
                   throws org.apache.jackrabbit.webdav.DavException,
                          IOException

The EVENT_CHECKEDOUT method

Parameters:

request -

response -

resource -

Throws:

org.apache.jackrabbit.webdav.DavException

IOException

doCheckin

protected void doCheckin(org.apache.jackrabbit.webdav.WebdavRequest request,
             org.apache.jackrabbit.webdav.WebdavResponse response,
             org.apache.jackrabbit.webdav.DavResource resource)
                  throws org.apache.jackrabbit.webdav.DavException,
                         IOException

The EVENT_CHECKEDIN method

Parameters:

request -

response -

resource -

Throws:

org.apache.jackrabbit.webdav.DavException

IOException

doReport

protected void doReport(org.apache.jackrabbit.webdav.WebdavRequest request,
            org.apache.jackrabbit.webdav.WebdavResponse response,
            org.apache.jackrabbit.webdav.DavResource resource)
                 throws org.apache.jackrabbit.webdav.DavException,
                        IOException

The REPORT method

Parameters:

request -

response -

resource -

Throws:

org.apache.jackrabbit.webdav.DavException

IOException

doUncheckout

protected void doUncheckout(org.apache.jackrabbit.webdav.WebdavRequest request,
                org.apache.jackrabbit.webdav.WebdavResponse response,
                org.apache.jackrabbit.webdav.DavResource resource)
                     throws org.apache.jackrabbit.webdav.DavException,
                            IOException

The EVENT_UNCHECKOUT method

Parameters:

request -

response -

resource -

Throws:

org.apache.jackrabbit.webdav.DavException

IOException

getInputContext

protected org.apache.jackrabbit.webdav.io.InputContext getInputContext(org.apache.jackrabbit.webdav.DavServletRequest request,
                                                           InputStream in)

Return a new InputContext used for adding resource members

Parameters:

request -

in -

Returns:

See Also:

spoolResource(WebdavRequest, WebdavResponse, DavResource, boolean)

getOutputContext

protected org.apache.jackrabbit.webdav.io.OutputContext getOutputContext(org.apache.jackrabbit.webdav.DavServletResponse response,
                                                             OutputStream out)

Return a new OutputContext used for spooling resource properties and the resource content

Parameters:

response -

out -

Returns:

See Also:

doPut(WebdavRequest, WebdavResponse, DavResource), doPost(WebdavRequest, WebdavResponse, DavResource), doMkCol(WebdavRequest, WebdavResponse, DavResource)