svn commit: r926764 - /commons/proper/net/branches/NET_2_0/src/main/java/org/apache/commons/net/ftp/FTPSServerSocketFactory.java

[sebb]

Author: sebb
Date: Tue Mar 23 20:14:46 2010
New Revision: 926764

URL: http://svn.apache.org/viewvc?rev=926764&view=rev
Log:
Javadoc

Modified:
    
commons/proper/net/branches/NET_2_0/src/main/java/org/apache/commons/net/ftp/FTPSServerSocketFactory.java

Modified: 
commons/proper/net/branches/NET_2_0/src/main/java/org/apache/commons/net/ftp/FTPSServerSocketFactory.java
URL: 
http://svn.apache.org/viewvc/commons/proper/net/branches/NET_2_0/src/main/java/org/apache/commons/net/ftp/FTPSServerSocketFactory.java?rev=926764&r1=926763&r2=926764&view=diff
==============================================================================
--- 
commons/proper/net/branches/NET_2_0/src/main/java/org/apache/commons/net/ftp/FTPSServerSocketFactory.java
 (original)
+++ 
commons/proper/net/branches/NET_2_0/src/main/java/org/apache/commons/net/ftp/FTPSServerSocketFactory.java
 Tue Mar 23 20:14:46 2010
@@ -52,6 +52,13 @@ public class FTPSServerSocketFactory ext
         return 
init(this.context.getServerSocketFactory().createServerSocket(port, backlog, 
ifAddress));
     }
 
+    /**
+     * Sets the socket so newly accepted connections will use SSL client mode.
+     * 
+     * @param socket the SSLServerSocket to initialise
+     * @return the socket
+     * @throws ClassCastException if socket is not an instance of 
SSLServerSocket
+     */
     public ServerSocket init(ServerSocket socket) {
         ((SSLServerSocket) socket).setUseClientMode(true);
         return socket;