commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From s...@apache.org
Subject commons-crypto git commit: Don't expose internal class names
Date Thu, 30 Jun 2016 17:11:24 GMT
Repository: commons-crypto
Updated Branches:
  refs/heads/master af77e868e -> 0c1f06550


Don't expose internal class names

Project: http://git-wip-us.apache.org/repos/asf/commons-crypto/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-crypto/commit/0c1f0655
Tree: http://git-wip-us.apache.org/repos/asf/commons-crypto/tree/0c1f0655
Diff: http://git-wip-us.apache.org/repos/asf/commons-crypto/diff/0c1f0655

Branch: refs/heads/master
Commit: 0c1f06550f1dea80276abe929744514a43f940ba
Parents: af77e86
Author: Sebb <sebb@apache.org>
Authored: Thu Jun 30 18:11:20 2016 +0100
Committer: Sebb <sebb@apache.org>
Committed: Thu Jun 30 18:11:20 2016 +0100

----------------------------------------------------------------------
 .../commons/crypto/conf/ConfigurationKeys.java  | 41 +++++++++++---------
 1 file changed, 22 insertions(+), 19 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/commons-crypto/blob/0c1f0655/src/main/java/org/apache/commons/crypto/conf/ConfigurationKeys.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/crypto/conf/ConfigurationKeys.java b/src/main/java/org/apache/commons/crypto/conf/ConfigurationKeys.java
index 7eddf20..b69b89f 100644
--- a/src/main/java/org/apache/commons/crypto/conf/ConfigurationKeys.java
+++ b/src/main/java/org/apache/commons/crypto/conf/ConfigurationKeys.java
@@ -34,15 +34,17 @@ public class ConfigurationKeys {
             + "properties";
 
     /**
-     * The configuration key of implementation class for crypto cipher. The
-     * values of CIPHER_CLASSES_KEY can be
-     * "org.apache.commons.crypto.cipher.JceCipher" or
-     * "org.apache.commons.crypto.cipher.OpenSslCipher". Or it can be a comma
-     * separated list. The "org.apache.commons.crypto.cipher.JceCipher" use jce
-     * provider to implement CryptoCipher and the
-     * "org.apache.commons.crypto.cipher.OpenSslCipher" use jni into OpenSSL to
-     * implement. Note that for each value,the first value which can be created
-     * without exception will be used (priority by order).
+     * The configuration key of the CryptoCipher implementation class.
+     * <p>
+     * The value of CIPHER_CLASSES_KEY needs to be the full name of a
+     * class that implements the 
+     * {@link org.apache.commons.crypto.cipher.CryptoCipher CryptoCipher} interface
+     * The internal classes are listed in the enum 
+     * {@link org.apache.commons.crypto.cipher.CryptoCipherFactory.CipherProvider CipherProvider}
+     * which can be used to obtain the full class name.
+     * <p>
+     * The value can also be a comma-separated list of class names in 
+     * order of descending priority.
      */
     public static final String CIPHER_CLASSES_KEY = CONF_PREFIX
             + "cipher.classes";
@@ -77,16 +79,17 @@ public class ConfigurationKeys {
     public static final String SECURE_RANDOM_JAVA_ALGORITHM_DEFAULT = "SHA1PRNG";
 
     /**
-     * The configuration key of the implementation class for secure random. The
-     * values of SECURE_RANDOM_CLASSES_KEY can be
-     * "org.apache.commons.crypto.random.JavaCryptoRandom" or
-     * "org.apache.commons.crypto.random.OpenSslCryptoRandom". Or it takes a
-     * comma separated list. The
-     * "org.apache.commons.crypto.random.JavaCryptoRandom" use java to implement
-     * {@link org.apache.commons.crypto.random.CryptoRandom} and the
-     * "org.apache.commons.crypto.random.OpenSslCryptoRandom" use jni into
-     * OpenSSL to implement. Note that for each value,the first value which can
-     * be created without exception will be used (priority by order).
+     * The configuration key of the CryptoRandom implementation class.
+     * <p> 
+     * The value of SECURE_RANDOM_CLASSES_KEY needs to be the full name of a
+     * class that implements the 
+     * {@link org.apache.commons.crypto.random.CryptoRandom CryptoRandom} interface
+     * The internal classes are listed in the enum 
+     * {@link org.apache.commons.crypto.random.CryptoRandomFactory.RandomProvider RandomProvider}
+     * which can be used to obtain the full class name.
+     * <p>
+     * The value can also be a comma-separated list of class names in 
+     * order of descending priority.
      */
     public static final String SECURE_RANDOM_CLASSES_KEY = CONF_PREFIX
             + "secure.random.classes";


Mime
View raw message