svn commit: r934000 - /jackrabbit/trunk/jackrabbit-jcr-server/src/main/java/org/apache/jackrabbit/webdav/simple/SimpleWebdavServlet.java

[an...@apache.org]

Author: angela
Date: Wed Apr 14 16:07:12 2010
New Revision: 934000

URL: http://svn.apache.org/viewvc?rev=934000&view=rev
Log:
javadoc

Modified:
    jackrabbit/trunk/jackrabbit-jcr-server/src/main/java/org/apache/jackrabbit/webdav/simple/SimpleWebdavServlet.java

Modified: jackrabbit/trunk/jackrabbit-jcr-server/src/main/java/org/apache/jackrabbit/webdav/simple/SimpleWebdavServlet.java
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-jcr-server/src/main/java/org/apache/jackrabbit/webdav/simple/SimpleWebdavServlet.java?rev=934000&r1=933999&r2=934000&view=diff
==============================================================================
--- jackrabbit/trunk/jackrabbit-jcr-server/src/main/java/org/apache/jackrabbit/webdav/simple/SimpleWebdavServlet.java (original)
+++ jackrabbit/trunk/jackrabbit-jcr-server/src/main/java/org/apache/jackrabbit/webdav/simple/SimpleWebdavServlet.java Wed Apr 14 16:07:12 2010
@@ -43,7 +43,11 @@ import java.net.MalformedURLException;
 import java.net.URL;
 
 /**
- * WebdavServlet provides webdav support (level 1 and 2 complient) for
+ * WebdavServlet provides WebDAV support (level
+ * {@link org.apache.jackrabbit.webdav.DavCompliance#_1_ 1},
+ * {@link org.apache.jackrabbit.webdav.DavCompliance#_2_ 2},
+ * {@link org.apache.jackrabbit.webdav.DavCompliance#_3_ 3} and
+ * {@link org.apache.jackrabbit.webdav.DavCompliance#BIND bind} compliant) for
  * repository resources.
  * <p>
  * Implementations of this abstract class must implement the
@@ -231,6 +235,7 @@ public abstract class SimpleWebdavServle
     /**
      * Returns the configured path prefix
      *
+     * @param ctx The servlet context.
      * @return resourcePathPrefix
      * @see #INIT_PARAM_RESOURCE_PATH_PREFIX
      */
@@ -257,7 +262,7 @@ public abstract class SimpleWebdavServle
     /**
      * Sets the <code>DavLocatorFactory</code>.
      *
-     * @param locatorFactory
+     * @param locatorFactory The <code>DavLocatorFactory</code> to use.
      * @see AbstractWebdavServlet#setLocatorFactory(DavLocatorFactory)
      */
     @Override
@@ -282,7 +287,7 @@ public abstract class SimpleWebdavServle
     /**
      * Sets the <code>LockManager</code>.
      *
-     * @param lockManager
+     * @param lockManager The <code>LockManager</code> to be used.
      */
     public void setLockManager(LockManager lockManager) {
         this.lockManager = lockManager;
@@ -307,7 +312,7 @@ public abstract class SimpleWebdavServle
     /**
      * Sets the <code>DavResourceFactory</code>.
      *
-     * @param resourceFactory
+     * @param resourceFactory The <code>DavResourceFactory</code> to use.
      * @see AbstractWebdavServlet#setResourceFactory(org.apache.jackrabbit.webdav.DavResourceFactory)
      */
     @Override
@@ -318,7 +323,7 @@ public abstract class SimpleWebdavServle
     /**
      * Returns the <code>SessionProvider</code>. If no session provider has been
      * set or created a new instance of {@link SessionProviderImpl} that extracts
-     * credentials from the request's <code>Authorization</code> header is
+     * credentials from the <code>Authorization</code> request header is
      * returned.
      *
      * @return the session provider
@@ -337,7 +342,7 @@ public abstract class SimpleWebdavServle
      * but subclasses can override this method to add support for other
      * types of credentials.
      *
-     * @return the credentilas provider
+     * @return the credentials provider
      * @since 1.3
      */
     protected CredentialsProvider getCredentialsProvider() {
@@ -347,7 +352,7 @@ public abstract class SimpleWebdavServle
     /**
      * Sets the <code>SessionProvider</code>.
      *
-     * @param sessionProvider
+     * @param sessionProvider The <code>SessionProvider</code> to use.
      */
     public synchronized void setSessionProvider(SessionProvider sessionProvider) {
         this.sessionProvider = sessionProvider;
@@ -373,7 +378,7 @@ public abstract class SimpleWebdavServle
     /**
      * Sets the <code>DavSessionProvider</code>.
      *
-     * @param sessionProvider
+     * @param sessionProvider The <code>DavSessionProvider</code> to use.
      * @see AbstractWebdavServlet#setDavSessionProvider(org.apache.jackrabbit.webdav.DavSessionProvider)
      */
     @Override
@@ -407,7 +412,7 @@ public abstract class SimpleWebdavServle
     /**
      * Set the resource configuration
      *
-     * @param config
+     * @param config The resource configuration.
      */
     public void setResourceConfig(ResourceConfig config) {
         this.config = config;