cxf-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From gma...@apache.org
Subject svn commit: r640844 - in /incubator/cxf/trunk/api/src/main/java/org/apache/cxf/configuration: Configurable.java Configurer.java jsse/TLSClientParameters.java jsse/TLSParameterBase.java jsse/TLSServerParameters.java
Date Tue, 25 Mar 2008 15:02:55 GMT
Author: gmazza
Date: Tue Mar 25 08:02:51 2008
New Revision: 640844

URL: http://svn.apache.org/viewvc?rev=640844&view=rev
Log:
JavaDoc info added -- fixed the comments for the getters (were frequently using the same ones
attached to the setters).

Modified:
    incubator/cxf/trunk/api/src/main/java/org/apache/cxf/configuration/Configurable.java
    incubator/cxf/trunk/api/src/main/java/org/apache/cxf/configuration/Configurer.java
    incubator/cxf/trunk/api/src/main/java/org/apache/cxf/configuration/jsse/TLSClientParameters.java
    incubator/cxf/trunk/api/src/main/java/org/apache/cxf/configuration/jsse/TLSParameterBase.java
    incubator/cxf/trunk/api/src/main/java/org/apache/cxf/configuration/jsse/TLSServerParameters.java

Modified: incubator/cxf/trunk/api/src/main/java/org/apache/cxf/configuration/Configurable.java
URL: http://svn.apache.org/viewvc/incubator/cxf/trunk/api/src/main/java/org/apache/cxf/configuration/Configurable.java?rev=640844&r1=640843&r2=640844&view=diff
==============================================================================
--- incubator/cxf/trunk/api/src/main/java/org/apache/cxf/configuration/Configurable.java (original)
+++ incubator/cxf/trunk/api/src/main/java/org/apache/cxf/configuration/Configurable.java Tue
Mar 25 08:02:51 2008
@@ -19,7 +19,7 @@
 
 package org.apache.cxf.configuration;
 /**
- * The configurable interface for get the bean's name
+ * A configurable interface for obtaining a bean's name
  * 
  * A class which implements this interface should return the 
  * unique bean name for configuration to use 

Modified: incubator/cxf/trunk/api/src/main/java/org/apache/cxf/configuration/Configurer.java
URL: http://svn.apache.org/viewvc/incubator/cxf/trunk/api/src/main/java/org/apache/cxf/configuration/Configurer.java?rev=640844&r1=640843&r2=640844&view=diff
==============================================================================
--- incubator/cxf/trunk/api/src/main/java/org/apache/cxf/configuration/Configurer.java (original)
+++ incubator/cxf/trunk/api/src/main/java/org/apache/cxf/configuration/Configurer.java Tue
Mar 25 08:02:51 2008
@@ -22,7 +22,7 @@
 /**
  * The configurer's interface
  * 
- * A class that implements this interface will perform the 
+ * A class that implements this interface will perform a 
  * bean's configuration work
  */
 public interface Configurer {    
@@ -34,15 +34,15 @@
     String USER_CFG_FILE_PROPERTY_URL = "cxf.config.file.url";
 
     /**
-     * set up the Bean's value by use Dependency Injection from the application context
-     * @param beanInstance the instance of bean which need to be configured
+     * set up the Bean's value by using Dependency Injection from the application context
+     * @param beanInstance the instance of the bean which needs to be configured
      */
     void configureBean(Object beanInstance);
     
     /**
-     * set up the Bean's value by use Dependency Injection from the application context
+     * set up the Bean's value by using Dependency Injection from the application context
      * with a proper name. You can use * as the prefix of wildcard name.
-     * @param name the name of the bean which need to be configured
+     * @param name the name of the bean which needs to be configured
      * @param beanInstance the instance of bean which need to be configured
      */
     void configureBean(String name, Object beanInstance);

Modified: incubator/cxf/trunk/api/src/main/java/org/apache/cxf/configuration/jsse/TLSClientParameters.java
URL: http://svn.apache.org/viewvc/incubator/cxf/trunk/api/src/main/java/org/apache/cxf/configuration/jsse/TLSClientParameters.java?rev=640844&r1=640843&r2=640844&view=diff
==============================================================================
--- incubator/cxf/trunk/api/src/main/java/org/apache/cxf/configuration/jsse/TLSClientParameters.java
(original)
+++ incubator/cxf/trunk/api/src/main/java/org/apache/cxf/configuration/jsse/TLSClientParameters.java
Tue Mar 25 08:02:51 2008
@@ -18,6 +18,11 @@
  */
 package org.apache.cxf.configuration.jsse;
 
+/**
+ * This class extends {@link TLSParameterBase} with client-specific
+ * SSL/TLS parameters.
+ * 
+ */
 public class TLSClientParameters extends TLSParameterBase {
     
 }

Modified: incubator/cxf/trunk/api/src/main/java/org/apache/cxf/configuration/jsse/TLSParameterBase.java
URL: http://svn.apache.org/viewvc/incubator/cxf/trunk/api/src/main/java/org/apache/cxf/configuration/jsse/TLSParameterBase.java?rev=640844&r1=640843&r2=640844&view=diff
==============================================================================
--- incubator/cxf/trunk/api/src/main/java/org/apache/cxf/configuration/jsse/TLSParameterBase.java
(original)
+++ incubator/cxf/trunk/api/src/main/java/org/apache/cxf/configuration/jsse/TLSParameterBase.java
Tue Mar 25 08:02:51 2008
@@ -26,8 +26,9 @@
 import javax.net.ssl.TrustManager;
 
 import org.apache.cxf.configuration.security.FiltersType;
+
 /**
- * This class is the base class for TLS parameters that are common
+ * This class is the base class for SSL/TLS parameters that are common
  * to both client and server sides.
  */
 public class TLSParameterBase {
@@ -40,15 +41,22 @@
     private String          protocol;
     
     /**
-     * This parameter configures the JSSE provider. If not set, it
-     * uses system default.
+     * Set the JSSE provider. If not set,
+     * it uses system default.
      */
     public final void setJsseProvider(String prov) {
         provider = prov;
+    }   
+
+    /**
+     * Return the JSSE provider.  
+     */
+    public String getJsseProvider() {
+        return provider;
     }
-    
+
     /**
-     * This parameter configures to use the following KeyManagers.
+     * Sets the KeyManagers for this endpoint.
      * This parameter may be set to null for system default behavior.
      */
     public final void setKeyManagers(KeyManager[] keyMgrs) {
@@ -56,7 +64,14 @@
     }
 
     /**
-     * This parameter configures to use the following TrustManagers.
+     * Returns the key managers for the endpoint.
+     */
+    public KeyManager[] getKeyManagers() {
+        return keyManagers;
+    }
+
+    /**
+     * Sets the TrustManagers associated with this endpoint.
      * This parameter may be set to null for system default behavior.
      */
     public final void setTrustManagers(TrustManager[] trustMgrs) {
@@ -64,6 +79,13 @@
     }
     
     /**
+     * Returns the TrustManagers associated with the endpoint.
+     */
+    public TrustManager[] getTrustManagers() {
+        return trustManagers;
+    }
+
+    /**
      * This parameter sets the cipher suites list to use. If left unset
      * it uses system defaults.
      */
@@ -72,6 +94,16 @@
     }
     
     /**
+     * Returns the CipherSuites associated with this endpoint.
+     */
+    public List<String> getCipherSuites() {
+        if (ciphersuites == null) {
+            ciphersuites = new ArrayList<String>();
+        }
+        return ciphersuites;
+    }
+
+    /**
      * This parameter sets the filter to include and/or exclude the 
      * cipher suites to use from the set list or system defaults.
      */
@@ -80,11 +112,10 @@
     }
     
     /**
-     * This sets the protocol to use. The system default is usually
-     * "TLS".
+     * Returns the cipher suites filter 
      */
-    public final void setSecureSocketProtocol(String proto) {
-        protocol = proto;
+    public FiltersType getCipherSuitesFilter() {
+        return cipherSuiteFilters;
     }
 
     /**
@@ -96,61 +127,25 @@
     }
 
     /**
-     * This sets the secure random alogorithm. If left unset or set
-     * to null, it uses the system default.
+     * Returns the secure random alogorithm.
      */
     public SecureRandom getSecureRandom() {
         return secureRandom;
     }
 
+
     /**
      * This sets the protocol to use. The system default is usually
      * "TLS".
      */
-    public String getSecureSocketProtocol() {
-        return protocol;
-    }
-
-    /**
-     * This parameter configures the JSSE provider. If not set, it
-     * uses system default.
-     */
-    public String getJsseProvider() {
-        return provider;
-    }
-
-    /**
-     * This parameter configures to use the following KeyManagers.
-     * This parameter may be set to null for system default behavior.
-     */
-    public KeyManager[] getKeyManagers() {
-        return keyManagers;
-    }
-
-    /**
-     * This parameter configures to use the following TrustManagers.
-     * This parameter may be set to null for system default behavior.
-     */
-    public TrustManager[] getTrustManagers() {
-        return trustManagers;
-    }
-
-    /**
-     * This parameter sets the cipher suites list to use. If left unset
-     * it uses system defaults.
-     */
-    public List<String> getCipherSuites() {
-        if (ciphersuites == null) {
-            ciphersuites = new ArrayList<String>();
-        }
-        return ciphersuites;
+    public final void setSecureSocketProtocol(String proto) {
+        protocol = proto;
     }
 
     /**
-     * This parameter sets the filter to include and/or exclude the 
-     * cipher suites to use from the set list or system defaults.
+     * Returns the secure socket protocol in use.
      */
-    public FiltersType getCipherSuitesFilter() {
-        return cipherSuiteFilters;
+    public String getSecureSocketProtocol() {
+        return protocol;
     }
 }

Modified: incubator/cxf/trunk/api/src/main/java/org/apache/cxf/configuration/jsse/TLSServerParameters.java
URL: http://svn.apache.org/viewvc/incubator/cxf/trunk/api/src/main/java/org/apache/cxf/configuration/jsse/TLSServerParameters.java?rev=640844&r1=640843&r2=640844&view=diff
==============================================================================
--- incubator/cxf/trunk/api/src/main/java/org/apache/cxf/configuration/jsse/TLSServerParameters.java
(original)
+++ incubator/cxf/trunk/api/src/main/java/org/apache/cxf/configuration/jsse/TLSServerParameters.java
Tue Mar 25 08:02:51 2008
@@ -22,6 +22,11 @@
 
 import org.apache.cxf.configuration.security.ClientAuthentication;
 
+/**
+ * This class extends {@link TLSParameterBase} with service-specific
+ * SSL/TLS parameters.
+ * 
+ */
 public class TLSServerParameters extends TLSParameterBase {
 
     ClientAuthentication clientAuthentication;
@@ -36,8 +41,7 @@
     }
 
     /**
-     * This parameter configures the server side to request and/or
-     * require client authentication.
+     * This parameter retrieves the client authentication settings.
      */
     public ClientAuthentication getClientAuthentication() {
         return clientAuthentication;



Mime
View raw message