Author: markt
Date: Mon Jan 4 23:18:17 2016
New Revision: 1722984
URL: http://svn.apache.org/viewvc?rev=1722984&view=rev
Log:
Javadoc improvements
Modified:
tomcat/trunk/java/org/apache/tomcat/util/net/SSLHostConfig.java
tomcat/trunk/java/org/apache/tomcat/util/net/openssl/ciphers/OpenSSLCipherConfigurationParser.java
Modified: tomcat/trunk/java/org/apache/tomcat/util/net/SSLHostConfig.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/util/net/SSLHostConfig.java?rev=1722984&r1=1722983&r2=1722984&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/tomcat/util/net/SSLHostConfig.java (original)
+++ tomcat/trunk/java/org/apache/tomcat/util/net/SSLHostConfig.java Mon Jan 4
23:18:17 2016
@@ -244,6 +244,12 @@ public class SSLHostConfig {
}
+ /**
+ * Set the new cipher configuration. Note: Regardless of the format used to
+ * set the configuration, it is always stored in OpenSSL format.
+ *
+ * @param ciphersList The new cipher configuration in OpenSSL or JSSE
format
+ */
public void setCiphers(String ciphersList) {
// Ciphers is stored in OpenSSL format. Convert the provided value if
// necessary.
@@ -272,10 +278,12 @@ public class SSLHostConfig {
}
this.cipherList = null;
this.jsseCipherNames = null;
-
}
+ /**
+ * @return An OpenSSL cipher string for the current configuration.
+ */
public String getCiphers() {
return ciphers;
}
@@ -289,6 +297,13 @@ public class SSLHostConfig {
}
+ /**
+ * Obtain the list of JSSE cipher names for the current configuration.
+ * Ciphers included in the configuration but not supported by JSSE will be
+ * excluded from this list.
+ *
+ * @return A list of the JSSE cipher names
+ */
public List<String> getJsseCipherNames() {
if (jsseCipherNames == null) {
jsseCipherNames =
OpenSSLCipherConfigurationParser.convertForJSSE(getCipherList());
Modified:
tomcat/trunk/java/org/apache/tomcat/util/net/openssl/ciphers/OpenSSLCipherConfigurationParser.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/util/net/openssl/ciphers/OpenSSLCipherConfigurationParser.java?rev=1722984&r1=1722983&r2=1722984&view=diff
==============================================================================
---
tomcat/trunk/java/org/apache/tomcat/util/net/openssl/ciphers/OpenSSLCipherConfigurationParser.java
(original)
+++
tomcat/trunk/java/org/apache/tomcat/util/net/openssl/ciphers/OpenSSLCipherConfigurationParser.java
Mon Jan 4 23:18:17 2016
@@ -704,7 +704,8 @@ public class OpenSSLCipherConfigurationP
}
/**
- * Parse the specified expression according to the OpenSSL syntax and
returns a list of standard cipher names.
+ * Parse the specified expression according to the OpenSSL syntax and
+ * returns a list of standard JSSE cipher names.
*
* @param expression the openssl expression to define a list of cipher.
* @return the corresponding list of ciphers.
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org
