Author: ngn
Date: Mon Feb 25 04:22:21 2008
New Revision: 630826

URL: http://svn.apache.org/viewvc?rev=630826&view=rev
Log:
Renamed interface and added some more JavaDoc. 

Added:
    
mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/ssl/DefaultSslConfiguration.java
      - copied, changed from r611437, 
mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/ssl/DefaultSsl.java
    
mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/ssl/SslConfiguration.java
      - copied, changed from r611437, 
mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/ssl/Ssl.java
Removed:
    
mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/ssl/DefaultSsl.java
    
mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/ssl/Ssl.java
Modified:
    
mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/DefaultDataConnectionConfig.java
    
mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/IODataConnectionFactory.java
    
mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/command/AUTH.java
    
mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/interfaces/DataConnectionConfig.java
    
mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/interfaces/SocketFactory.java
    
mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/listener/AbstractListener.java
    
mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/listener/Listener.java
    
mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/listener/mina/MinaListener.java
    
mina/sandbox/ftpserver/trunk/core/src/test/java/org/apache/ftpserver/ssl/SSLTestTemplate.java

Modified: 
mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/DefaultDataConnectionConfig.java
URL: 
http://svn.apache.org/viewvc/mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/DefaultDataConnectionConfig.java?rev=630826&r1=630825&r2=630826&view=diff
==============================================================================
--- 
mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/DefaultDataConnectionConfig.java
 (original)
+++ 
mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/DefaultDataConnectionConfig.java
 Mon Feb 25 04:22:21 2008
@@ -23,7 +23,7 @@
 import java.net.UnknownHostException;
 
 import org.apache.ftpserver.interfaces.DataConnectionConfig;
-import org.apache.ftpserver.ssl.Ssl;
+import org.apache.ftpserver.ssl.SslConfiguration;
 
 /**
  * Data connection configuration.
@@ -98,7 +98,7 @@
     
     private int maxIdleTimeMillis = 10000;
     
-    private Ssl ssl;
+    private SslConfiguration ssl;
     
     public void setIdleTime(int idleTime) {
         // get the maximum idle time in millis
@@ -116,7 +116,7 @@
         this.passive = passive;
     }
     
-    public void setSsl(Ssl ssl) {
+    public void setSsl(SslConfiguration ssl) {
         this.ssl = ssl;
     }
 
@@ -207,7 +207,7 @@
     /**
      * Get SSL component.
      */
-    public Ssl getSSL() {
+    public SslConfiguration getSSL() {
         return ssl;
     }
 }

Modified: 
mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/IODataConnectionFactory.java
URL: 
http://svn.apache.org/viewvc/mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/IODataConnectionFactory.java?rev=630826&r1=630825&r2=630826&view=diff
==============================================================================
--- 
mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/IODataConnectionFactory.java
 (original)
+++ 
mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/IODataConnectionFactory.java
 Mon Feb 25 04:22:21 2008
@@ -38,7 +38,7 @@
 import org.apache.ftpserver.interfaces.FtpIoSession;
 import org.apache.ftpserver.interfaces.FtpServerContext;
 import org.apache.ftpserver.ssl.ClientAuth;
-import org.apache.ftpserver.ssl.Ssl;
+import org.apache.ftpserver.ssl.SslConfiguration;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -158,7 +158,7 @@
             }
 
             if(secure) {
-                Ssl ssl = dataCfg.getSSL();
+                SslConfiguration ssl = dataCfg.getSSL();
                 if(ssl == null) {
                     throw new DataConnectionException("Data connection SSL 
required but not configured.");
                 }
@@ -186,7 +186,7 @@
         }
     }
      
-    private ServerSocket createServerSocket(Ssl ssl, InetAddress address2, int 
passivePort) throws IOException, GeneralSecurityException {
+    private ServerSocket createServerSocket(SslConfiguration ssl, InetAddress 
address2, int passivePort) throws IOException, GeneralSecurityException {
         // get server socket factory
         SSLContext ctx = ssl.getSSLContext();
         SSLServerSocketFactory ssocketFactory = ctx.getServerSocketFactory();
@@ -247,7 +247,7 @@
             if(!passive) {
                 int localPort = dataConfig.getActiveLocalPort();
                 if(secure) {
-                    Ssl ssl = dataConfig.getSSL();
+                    SslConfiguration ssl = dataConfig.getSSL();
                     if(ssl == null) {
                         throw new FtpException("Data connection SSL not 
configured");
                     }
@@ -290,7 +290,7 @@
         return dataSoc;
     }
     
-    private Socket createSocket(Ssl ssl, InetAddress address2,
+    private Socket createSocket(SslConfiguration ssl, InetAddress address2,
             int port2, InetAddress localAddress, int localPort, boolean 
clientMode) throws IOException, GeneralSecurityException {
         
         // get socket factory

Modified: 
mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/command/AUTH.java
URL: 
http://svn.apache.org/viewvc/mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/command/AUTH.java?rev=630826&r1=630825&r2=630826&view=diff
==============================================================================
--- 
mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/command/AUTH.java
 (original)
+++ 
mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/command/AUTH.java
 Mon Feb 25 04:22:21 2008
@@ -28,7 +28,7 @@
 import org.apache.ftpserver.interfaces.FtpIoSession;
 import org.apache.ftpserver.interfaces.FtpServerContext;
 import org.apache.ftpserver.ssl.ClientAuth;
-import org.apache.ftpserver.ssl.Ssl;
+import org.apache.ftpserver.ssl.SslConfiguration;
 import org.apache.ftpserver.util.FtpReplyUtil;
 import org.apache.mina.filter.ssl.SslFilter;
 import org.slf4j.Logger;
@@ -94,7 +94,7 @@
     }
     
     private void secureSession(FtpIoSession session, String type) throws 
GeneralSecurityException, FtpException {
-        Ssl ssl = session.getListener().getSsl();
+        SslConfiguration ssl = session.getListener().getSsl();
         
         if(ssl != null) {
             session.setAttribute(SslFilter.DISABLE_ENCRYPTION_ONCE);

Modified: 
mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/interfaces/DataConnectionConfig.java
URL: 
http://svn.apache.org/viewvc/mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/interfaces/DataConnectionConfig.java?rev=630826&r1=630825&r2=630826&view=diff
==============================================================================
--- 
mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/interfaces/DataConnectionConfig.java
 (original)
+++ 
mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/interfaces/DataConnectionConfig.java
 Mon Feb 25 04:22:21 2008
@@ -21,7 +21,7 @@
 
 import java.net.InetAddress;
 
-import org.apache.ftpserver.ssl.Ssl;
+import org.apache.ftpserver.ssl.SslConfiguration;
 
 /**
  * Data connection configuration interface.
@@ -80,5 +80,5 @@
     /**
      * Get SSL component.
      */
-    Ssl getSSL();
+    SslConfiguration getSSL();
 }

Modified: 
mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/interfaces/SocketFactory.java
URL: 
http://svn.apache.org/viewvc/mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/interfaces/SocketFactory.java?rev=630826&r1=630825&r2=630826&view=diff
==============================================================================
--- 
mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/interfaces/SocketFactory.java
 (original)
+++ 
mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/interfaces/SocketFactory.java
 Mon Feb 25 04:22:21 2008
@@ -22,7 +22,7 @@
 import java.net.InetAddress;
 import java.net.ServerSocket;
 
-import org.apache.ftpserver.ssl.Ssl;
+import org.apache.ftpserver.ssl.SslConfiguration;
 
 
 /**
@@ -53,5 +53,5 @@
     /**
      * Get SSL component.
      */
-    Ssl getSSL();
+    SslConfiguration getSSL();
 }

Modified: 
mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/listener/AbstractListener.java
URL: 
http://svn.apache.org/viewvc/mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/listener/AbstractListener.java?rev=630826&r1=630825&r2=630826&view=diff
==============================================================================
--- 
mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/listener/AbstractListener.java
 (original)
+++ 
mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/listener/AbstractListener.java
 Mon Feb 25 04:22:21 2008
@@ -23,7 +23,7 @@
 
 import org.apache.ftpserver.DefaultDataConnectionConfig;
 import org.apache.ftpserver.interfaces.DataConnectionConfig;
-import org.apache.ftpserver.ssl.Ssl;
+import org.apache.ftpserver.ssl.SslConfiguration;
 
 
 /**
@@ -33,7 +33,7 @@
     
     private InetAddress serverAddress;
     private int port = 21;
-    private Ssl ssl;
+    private SslConfiguration ssl;
     private boolean implicitSsl = false;
     private DataConnectionConfig dataConnectionConfig = new 
DefaultDataConnectionConfig();
     
@@ -58,10 +58,10 @@
     public void setAddress(InetAddress serverAddress) {
         this.serverAddress = serverAddress;
     }
-    public Ssl getSsl() {
+    public SslConfiguration getSsl() {
         return ssl;
     }
-    public void setSsl(Ssl ssl) {
+    public void setSsl(SslConfiguration ssl) {
         this.ssl = ssl;
     }
     public DataConnectionConfig getDataConnectionConfig() {

Modified: 
mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/listener/Listener.java
URL: 
http://svn.apache.org/viewvc/mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/listener/Listener.java?rev=630826&r1=630825&r2=630826&view=diff
==============================================================================
--- 
mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/listener/Listener.java
 (original)
+++ 
mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/listener/Listener.java
 Mon Feb 25 04:22:21 2008
@@ -21,7 +21,7 @@
 
 import org.apache.ftpserver.interfaces.DataConnectionConfig;
 import org.apache.ftpserver.interfaces.FtpServerContext;
-import org.apache.ftpserver.ssl.Ssl;
+import org.apache.ftpserver.ssl.SslConfiguration;
 
 
 /**
@@ -31,7 +31,7 @@
  */
 public interface Listener {
     
-    Ssl getSsl();
+    SslConfiguration getSsl();
     
     DataConnectionConfig getDataConnectionConfig();
     

Modified: 
mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/listener/mina/MinaListener.java
URL: 
http://svn.apache.org/viewvc/mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/listener/mina/MinaListener.java?rev=630826&r1=630825&r2=630826&view=diff
==============================================================================
--- 
mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/listener/mina/MinaListener.java
 (original)
+++ 
mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/listener/mina/MinaListener.java
 Mon Feb 25 04:22:21 2008
@@ -30,7 +30,7 @@
 import org.apache.ftpserver.listener.AbstractListener;
 import org.apache.ftpserver.listener.Listener;
 import org.apache.ftpserver.ssl.ClientAuth;
-import org.apache.ftpserver.ssl.Ssl;
+import org.apache.ftpserver.ssl.SslConfiguration;
 import org.apache.mina.common.IdleStatus;
 import org.apache.mina.common.IoSessionLogger;
 import org.apache.mina.filter.codec.ProtocolCodecFilter;
@@ -92,7 +92,7 @@
 
         
         if(isImplicitSsl()) {
-            Ssl ssl = getSsl();
+            SslConfiguration ssl = getSsl();
             SslFilter sslFilter = new SslFilter( ssl.getSSLContext() );
             
             if(ssl.getClientAuth() == ClientAuth.NEED) {

Copied: 
mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/ssl/DefaultSslConfiguration.java
 (from r611437, 
mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/ssl/DefaultSsl.java)
URL: 
http://svn.apache.org/viewvc/mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/ssl/DefaultSslConfiguration.java?p2=mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/ssl/DefaultSslConfiguration.java&p1=mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/ssl/DefaultSsl.java&r1=611437&r2=630826&rev=630826&view=diff
==============================================================================
--- 
mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/ssl/DefaultSsl.java
 (original)
+++ 
mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/ssl/DefaultSslConfiguration.java
 Mon Feb 25 04:22:21 2008
@@ -43,9 +43,9 @@
  * Ssl implementation. This class encapsulates all 
  * the SSL functionalities.
  */
-public class DefaultSsl implements Ssl {
+public class DefaultSslConfiguration implements SslConfiguration {
     
-    private final Logger LOG = LoggerFactory.getLogger(DefaultSsl.class);
+    private final Logger LOG = 
LoggerFactory.getLogger(DefaultSslConfiguration.class);
     
     private File keystoreFile = new File("./res/.keystore");
     private String keystorePass;

Copied: 
mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/ssl/SslConfiguration.java
 (from r611437, 
mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/ssl/Ssl.java)
URL: 
http://svn.apache.org/viewvc/mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/ssl/SslConfiguration.java?p2=mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/ssl/SslConfiguration.java&p1=mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/ssl/Ssl.java&r1=611437&r2=630826&rev=630826&view=diff
==============================================================================
--- 
mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/ssl/Ssl.java
 (original)
+++ 
mina/sandbox/ftpserver/trunk/core/src/main/java/org/apache/ftpserver/ssl/SslConfiguration.java
 Mon Feb 25 04:22:21 2008
@@ -25,12 +25,23 @@
 
 
 /**
- * SSL interface.
+ * SSL configuration
  */
-public 
-interface Ssl {
+public interface SslConfiguration {
     
+       /**
+        * Return the SSL context for this configuration
+        * @return The [EMAIL PROTECTED] SSLContext}
+        * @throws GeneralSecurityException
+        */
     SSLContext getSSLContext() throws GeneralSecurityException;
+    
+       /**
+        * Return the SSL context for this configuration given the specified 
protocol
+     * @param protocol The protocol, SSL or TLS must be supported
+     * @return The [EMAIL PROTECTED] SSLContext}
+     * @throws GeneralSecurityException
+     */
     SSLContext getSSLContext(String protocol) throws GeneralSecurityException;
     
     /**
@@ -40,5 +51,12 @@
      * @return An array of cipher suites, or null.
      */
     String[] getEnabledCipherSuites();
+    
+    /**
+     * Return the required client authentication setting
+     * @return [EMAIL PROTECTED] ClientAuth#NEED} if client authentication is 
required, 
+     *                 [EMAIL PROTECTED] ClientAuth#WANT} is client 
authentication is wanted or
+     *                 [EMAIL PROTECTED] ClientAuth#NONE} if no client 
authentication is the be performed  
+     */
     ClientAuth getClientAuth();
 }

Modified: 
mina/sandbox/ftpserver/trunk/core/src/test/java/org/apache/ftpserver/ssl/SSLTestTemplate.java
URL: 
http://svn.apache.org/viewvc/mina/sandbox/ftpserver/trunk/core/src/test/java/org/apache/ftpserver/ssl/SSLTestTemplate.java?rev=630826&r1=630825&r2=630826&view=diff
==============================================================================
--- 
mina/sandbox/ftpserver/trunk/core/src/test/java/org/apache/ftpserver/ssl/SSLTestTemplate.java
 (original)
+++ 
mina/sandbox/ftpserver/trunk/core/src/test/java/org/apache/ftpserver/ssl/SSLTestTemplate.java
 Mon Feb 25 04:22:21 2008
@@ -88,7 +88,7 @@
         configProps.setProperty("config.listeners.default.port", Integer
                 .toString(port));
         configProps.setProperty("config.listeners.default.ssl.class",
-                DefaultSsl.class.getName());
+                DefaultSslConfiguration.class.getName());
         configProps.setProperty("config.listeners.default.ssl.keystore-file",
                 FTPSERVER_KEYSTORE.getAbsolutePath());
         
configProps.setProperty("config.listeners.default.ssl.keystore-password",
@@ -103,7 +103,7 @@
         
configProps.setProperty("config.listeners.default.data-connection.class",
                 DefaultDataConnectionConfig.class.getName());
         
configProps.setProperty("config.listeners.default.data-connection.ssl.class",
-                DefaultSsl.class.getName());
+                DefaultSslConfiguration.class.getName());
         
configProps.setProperty("config.listeners.default.data-connection.ssl.keystore-file",
                 FTPSERVER_KEYSTORE.getAbsolutePath());
         
configProps.setProperty("config.listeners.default.data-connection.ssl.keystore-password",


Reply via email to