incubator-ftpserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From n..@apache.org
Subject svn commit: r499487 - /incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/
Date Wed, 24 Jan 2007 17:16:16 GMT
Author: ngn
Date: Wed Jan 24 09:16:12 2007
New Revision: 499487

URL: http://svn.apache.org/viewvc?view=rev&rev=499487
Log:
Clean up JavaDocs

Modified:
    incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/Authentication.java
    incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/AuthenticationFailedException.java
    incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/Component.java
    incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/Configuration.java
    incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/DataType.java
    incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/DefaultFtplet.java
    incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/FileObject.java
    incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/FileSystemManager.java
    incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/FileSystemView.java
    incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/FtpException.java
    incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/FtpReply.java
    incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/FtpReplyOutput.java
    incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/FtpStatistics.java
    incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/Ftplet.java
    incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/FtpletContext.java
    incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/FtpletEnum.java
    incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/Structure.java
    incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/User.java
    incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/UserManager.java

Modified: incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/Authentication.java
URL: http://svn.apache.org/viewvc/incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/Authentication.java?view=diff&rev=499487&r1=499486&r2=499487
==============================================================================
--- incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/Authentication.java
(original)
+++ incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/Authentication.java
Wed Jan 24 09:16:12 2007
@@ -19,6 +19,10 @@
 
 package org.apache.ftpserver.ftplet;
 
+/**
+ * Represents a type of authentication request, typically
+ * anonymous or a username and password combination
+ */
 public interface Authentication {
 
 }

Modified: incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/AuthenticationFailedException.java
URL: http://svn.apache.org/viewvc/incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/AuthenticationFailedException.java?view=diff&rev=499487&r1=499486&r2=499487
==============================================================================
--- incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/AuthenticationFailedException.java
(original)
+++ incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/AuthenticationFailedException.java
Wed Jan 24 09:16:12 2007
@@ -19,7 +19,9 @@
 
 package org.apache.ftpserver.ftplet;
 
-
+/**
+ * Thrown is an authentication request fails
+ */
 public class AuthenticationFailedException extends FtpException {
     private static final long serialVersionUID = -1328383839915898987L;
 
@@ -31,7 +33,7 @@
     }
 
     /**
-     * Constructs a <code>FtpException</code> object with a message.
+     * Constructs a <code>AuthenticationFailedException</code> object with a
message.
      * 
      * @param msg a description of the exception 
      */
@@ -40,7 +42,7 @@
     }
 
     /**
-     * Constructs a <code>FtpException</code> object with a 
+     * Constructs a <code>AuthenticationFailedException</code> object with a

      * <code>Throwable</code> cause.
      * 
      * @param th the original cause
@@ -50,7 +52,7 @@
     }
 
     /**
-     * Constructs a <code>BaseException</code> object with a 
+     * Constructs a <code>AuthenticationFailedException</code> object with a

      * <code>Throwable</code> cause.
      * 
      * @param th the original cause

Modified: incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/Component.java
URL: http://svn.apache.org/viewvc/incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/Component.java?view=diff&rev=499487&r1=499486&r2=499487
==============================================================================
--- incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/Component.java
(original)
+++ incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/Component.java
Wed Jan 24 09:16:12 2007
@@ -30,8 +30,6 @@
  *     <li>Other component specific methods will be called.</li>
  *     <li>Finnaly Component.dispose() method will be called.</li>
  * </ol>
- * 
- * @author <a href="mailto:rana_b@yahoo.com">Rana Bhattacharyya</a>
  */
 public 
 interface Component {

Modified: incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/Configuration.java
URL: http://svn.apache.org/viewvc/incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/Configuration.java?view=diff&rev=499487&r1=499486&r2=499487
==============================================================================
--- incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/Configuration.java
(original)
+++ incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/Configuration.java
Wed Jan 24 09:16:12 2007
@@ -24,8 +24,6 @@
 
 /**
  * Configuration interface. 
- * 
- * @author <a href="mailto:rana_b@yahoo.com">Rana Bhattacharyya</a>
  */
 public 
 interface Configuration {

Modified: incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/DataType.java
URL: http://svn.apache.org/viewvc/incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/DataType.java?view=diff&rev=499487&r1=499486&r2=499487
==============================================================================
--- incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/DataType.java
(original)
+++ incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/DataType.java
Wed Jan 24 09:16:12 2007
@@ -21,8 +21,6 @@
 
 /**
  * Type safe enum for describing the data type
- *
- * @author <a href="mailto:niklas@protocol7.com">Niklas Gustavsson</a>
  */
 public class DataType {
 

Modified: incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/DefaultFtplet.java
URL: http://svn.apache.org/viewvc/incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/DefaultFtplet.java?view=diff&rev=499487&r1=499486&r2=499487
==============================================================================
--- incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/DefaultFtplet.java
(original)
+++ incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/DefaultFtplet.java
Wed Jan 24 09:16:12 2007
@@ -25,8 +25,6 @@
  * Default ftplet implementation. All the callback method returns null. 
  * It is just an empty implementation. You can derive your ftplet implementation
  * from this class.
- * 
- * @author <a href="mailto:rana_b@yahoo.com">Rana Bhattacharyya</a>
  */
 public 
 class DefaultFtplet implements Ftplet {

Modified: incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/FileObject.java
URL: http://svn.apache.org/viewvc/incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/FileObject.java?view=diff&rev=499487&r1=499486&r2=499487
==============================================================================
--- incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/FileObject.java
(original)
+++ incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/FileObject.java
Wed Jan 24 09:16:12 2007
@@ -25,8 +25,6 @@
 
 /**
  * This is the file abstraction used by the server.
- * 
- * @author <a href="mailto:rana_b@yahoo.com">Rana Bhattacharyya</a>
  */
 public 
 interface FileObject {

Modified: incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/FileSystemManager.java
URL: http://svn.apache.org/viewvc/incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/FileSystemManager.java?view=diff&rev=499487&r1=499486&r2=499487
==============================================================================
--- incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/FileSystemManager.java
(original)
+++ incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/FileSystemManager.java
Wed Jan 24 09:16:12 2007
@@ -22,8 +22,6 @@
 /**
  * This is the file system manager - it returns the file system 
  * view for user.
- * 
- * @author <a href="mailto:rana_b@yahoo.com">Rana Bhattacharyya</a>
  */
 public 
 interface FileSystemManager extends Component {

Modified: incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/FileSystemView.java
URL: http://svn.apache.org/viewvc/incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/FileSystemView.java?view=diff&rev=499487&r1=499486&r2=499487
==============================================================================
--- incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/FileSystemView.java
(original)
+++ incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/FileSystemView.java
Wed Jan 24 09:16:12 2007
@@ -22,8 +22,6 @@
 
 /**
  * This is an abstraction over the user file system view.
- * 
- * @author <a href="mailto:rana_b@yahoo.com">Rana Bhattacharyya</a>
  */
 public
 interface FileSystemView {

Modified: incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/FtpException.java
URL: http://svn.apache.org/viewvc/incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/FtpException.java?view=diff&rev=499487&r1=499486&r2=499487
==============================================================================
--- incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/FtpException.java
(original)
+++ incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/FtpException.java
Wed Jan 24 09:16:12 2007
@@ -24,8 +24,6 @@
 
 /**
  * Ftplet exception class.
- * 
- * @author <a href="mailto:rana_b@yahoo.com">Rana Bhattacharyya</a>
  */
 public 
 class FtpException extends Exception {

Modified: incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/FtpReply.java
URL: http://svn.apache.org/viewvc/incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/FtpReply.java?view=diff&rev=499487&r1=499486&r2=499487
==============================================================================
--- incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/FtpReply.java
(original)
+++ incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/FtpReply.java
Wed Jan 24 09:16:12 2007
@@ -19,6 +19,9 @@
 
 package org.apache.ftpserver.ftplet;
 
+/**
+ * Interface for a reply to an FTP request.
+ */
 public interface FtpReply {
 
     /**
@@ -226,7 +229,22 @@
      */
     public static final int REPLY_553_REQUESTED_ACTION_NOT_TAKEN_FILE_NAME_NOT_ALLOWED =
553;
 
+    /**
+     * The reply code
+     * @return The reply code
+     */
     int getCode();
 
+    /**
+     * The reply message, might be multiple lines
+     * @return The reply message
+     */
     String getMessage();
+
+    /** 
+     * Must implement toString to format the reply as described in the RFC. 
+     * Most important is the handling of multi-line replies.
+     * @return The formated reply
+     */
+    String toString();
 }

Modified: incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/FtpReplyOutput.java
URL: http://svn.apache.org/viewvc/incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/FtpReplyOutput.java?view=diff&rev=499487&r1=499486&r2=499487
==============================================================================
--- incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/FtpReplyOutput.java
(original)
+++ incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/FtpReplyOutput.java
Wed Jan 24 09:16:12 2007
@@ -22,9 +22,7 @@
 import java.io.IOException;
 
 /**
- * Ftp response interface. Ftplets can use this to send custom messges to client. 
- * 
- * @author <a href="mailto:rana_b@yahoo.com">Rana Bhattacharyya</a>
+ * Ftp reply output. Ftplets can use this to send custom messages to client. 
  */
 public 
 interface FtpReplyOutput {

Modified: incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/FtpStatistics.java
URL: http://svn.apache.org/viewvc/incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/FtpStatistics.java?view=diff&rev=499487&r1=499486&r2=499487
==============================================================================
--- incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/FtpStatistics.java
(original)
+++ incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/FtpStatistics.java
Wed Jan 24 09:16:12 2007
@@ -24,8 +24,6 @@
 
 /**
  * This interface holds all the ftp server statistical information. 
- * 
- * @author <a href="mailto:rana_b@yahoo.com">Rana Bhattacharyya</a>
  */
 public 
 interface FtpStatistics {

Modified: incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/Ftplet.java
URL: http://svn.apache.org/viewvc/incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/Ftplet.java?view=diff&rev=499487&r1=499486&r2=499487
==============================================================================
--- incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/Ftplet.java
(original)
+++ incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/Ftplet.java
Wed Jan 24 09:16:12 2007
@@ -42,8 +42,6 @@
  * All the callback methods return FtpletEnum. If it returns null FtpletEnum.RET_DEFAULT
  * will be assumed. If any ftplet callback method throws exception, that particular connection

  * will be disconnected. 
- * 
- * @author <a href="mailto:rana_b@yahoo.com">Rana Bhattacharyya</a>
  */
 public 
 interface Ftplet {

Modified: incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/FtpletContext.java
URL: http://svn.apache.org/viewvc/incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/FtpletContext.java?view=diff&rev=499487&r1=499486&r2=499487
==============================================================================
--- incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/FtpletContext.java
(original)
+++ incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/FtpletContext.java
Wed Jan 24 09:16:12 2007
@@ -27,8 +27,6 @@
  * A ftplet configuration object used by a ftplet container used to pass 
  * information to a ftplet during initialization. The configuration information 
  * contains initialization parameters.
- * 
- * @author <a href="mailto:rana_b@yahoo.com">Rana Bhattacharyya</a>
  */
 public 
 interface FtpletContext {

Modified: incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/FtpletEnum.java
URL: http://svn.apache.org/viewvc/incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/FtpletEnum.java?view=diff&rev=499487&r1=499486&r2=499487
==============================================================================
--- incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/FtpletEnum.java
(original)
+++ incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/FtpletEnum.java
Wed Jan 24 09:16:12 2007
@@ -24,8 +24,6 @@
  * This class encapsulates the return values of the ftplet methods. 
  * 
  * RET_DEFAULT < RET_NO_FTPLET < RET_SKIP < RET_DISCONNECT
- * 
- * @author <a href="mailto:rana_b@yahoo.com">Rana Bhattacharyya</a>
  */
 public 
 final class FtpletEnum {

Modified: incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/Structure.java
URL: http://svn.apache.org/viewvc/incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/Structure.java?view=diff&rev=499487&r1=499486&r2=499487
==============================================================================
--- incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/Structure.java
(original)
+++ incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/Structure.java
Wed Jan 24 09:16:12 2007
@@ -21,8 +21,6 @@
 
 /**
  * Type safe enum for describing the structure
- *
- * @author <a href="mailto:niklas@protocol7.com">Niklas Gustavsson</a>
  */
 public class Structure {
 

Modified: incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/User.java
URL: http://svn.apache.org/viewvc/incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/User.java?view=diff&rev=499487&r1=499486&r2=499487
==============================================================================
--- incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/User.java (original)
+++ incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/User.java Wed
Jan 24 09:16:12 2007
@@ -21,8 +21,6 @@
 
 /**
  * Basic user interface.
- * 
- * @author <a href="mailto:rana_b@yahoo.com">Rana Bhattacharyya</a>
  */
 public 
 interface User {

Modified: incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/UserManager.java
URL: http://svn.apache.org/viewvc/incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/UserManager.java?view=diff&rev=499487&r1=499486&r2=499487
==============================================================================
--- incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/UserManager.java
(original)
+++ incubator/ftpserver/trunk/ftplet-api/src/java/org/apache/ftpserver/ftplet/UserManager.java
Wed Jan 24 09:16:12 2007
@@ -22,8 +22,6 @@
 
 /**
  * User manager interface.
- * 
- * @author <a href="mailto:rana_b@yahoo.com">Rana Bhattacharyya</a>
  */
 public 
 interface UserManager extends Component {



Mime
View raw message