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: Javadoc
Date Mon, 27 Jun 2016 23:34:44 GMT
Repository: commons-crypto
Updated Branches:
  refs/heads/master 896db5955 -> 0ef736052


Javadoc

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

Branch: refs/heads/master
Commit: 0ef736052aa8440243aa8c34a6da20d945e6bb3c
Parents: 896db59
Author: Sebb <sebb@apache.org>
Authored: Tue Jun 28 00:34:40 2016 +0100
Committer: Sebb <sebb@apache.org>
Committed: Tue Jun 28 00:34:40 2016 +0100

----------------------------------------------------------------------
 src/main/java/org/apache/commons/crypto/cipher/JceCipher.java    | 2 +-
 .../java/org/apache/commons/crypto/conf/ConfigurationKeys.java   | 4 ++--
 .../java/org/apache/commons/crypto/random/JavaCryptoRandom.java  | 3 +++
 .../org/apache/commons/crypto/random/OpensslCryptoRandom.java    | 3 ++-
 .../java/org/apache/commons/crypto/random/OsCryptoRandom.java    | 3 +++
 5 files changed, 11 insertions(+), 4 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/commons-crypto/blob/0ef73605/src/main/java/org/apache/commons/crypto/cipher/JceCipher.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/crypto/cipher/JceCipher.java b/src/main/java/org/apache/commons/crypto/cipher/JceCipher.java
index d418470..4205b48 100644
--- a/src/main/java/org/apache/commons/crypto/cipher/JceCipher.java
+++ b/src/main/java/org/apache/commons/crypto/cipher/JceCipher.java
@@ -42,7 +42,7 @@ class JceCipher implements CryptoCipher {
     /**
      * Constructs a {@link CryptoCipher} based on JCE Cipher {@link Cipher}.
      *
-     * @param props  properties for JCE cipher (only uses ConfigurationKeys.CIPHER_JCE_PROVIDER_KEY)
+     * @param props  properties for JCE cipher (only uses {@link ConfigurationKeys#CIPHER_JCE_PROVIDER_KEY})
      * @param transformation  transformation for JCE cipher (algorithm/mode/padding)
      * @throws GeneralSecurityException if JCE cipher initialize failed
      */

http://git-wip-us.apache.org/repos/asf/commons-crypto/blob/0ef73605/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 7a91e8c..c904cf1 100644
--- a/src/main/java/org/apache/commons/crypto/conf/ConfigurationKeys.java
+++ b/src/main/java/org/apache/commons/crypto/conf/ConfigurationKeys.java
@@ -61,7 +61,7 @@ public class ConfigurationKeys {
             + "secure.random.device.file.path";
 
     /**
-     * The default value of the file path for secure random device.
+     * The default value ({@value}) of the file path for secure random device.
      */
     public static final String SECURE_RANDOM_DEVICE_FILE_PATH_DEFAULT = "/dev/urandom";
 
@@ -72,7 +72,7 @@ public class ConfigurationKeys {
             + "secure.random.java.algorithm";
 
     /**
-     * The default value of the algorithm of secure random.
+     * The default value ({@value}) of the algorithm of secure random.
      */
     public static final String SECURE_RANDOM_JAVA_ALGORITHM_DEFAULT = "SHA1PRNG";
 

http://git-wip-us.apache.org/repos/asf/commons-crypto/blob/0ef73605/src/main/java/org/apache/commons/crypto/random/JavaCryptoRandom.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/crypto/random/JavaCryptoRandom.java b/src/main/java/org/apache/commons/crypto/random/JavaCryptoRandom.java
index 210c181..81720cb 100644
--- a/src/main/java/org/apache/commons/crypto/random/JavaCryptoRandom.java
+++ b/src/main/java/org/apache/commons/crypto/random/JavaCryptoRandom.java
@@ -34,6 +34,9 @@ public class JavaCryptoRandom implements CryptoRandom {
      * Constructs a {@link JavaCryptoRandom}.
      *
      * @param properties the configuration properties.
+     * Uses the key {@link ConfigurationKeys#SECURE_RANDOM_JAVA_ALGORITHM_KEY}
+     * to get the name of the algorithm, with a default of
+     * {@link ConfigurationKeys#SECURE_RANDOM_JAVA_ALGORITHM_DEFAULT}
      * @throws NoSuchAlgorithmException if no Provider supports a
      *         SecureRandomSpi implementation for the specified algorithm.
      */

http://git-wip-us.apache.org/repos/asf/commons-crypto/blob/0ef73605/src/main/java/org/apache/commons/crypto/random/OpensslCryptoRandom.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/crypto/random/OpensslCryptoRandom.java b/src/main/java/org/apache/commons/crypto/random/OpensslCryptoRandom.java
index 616c3b8..7401f03 100644
--- a/src/main/java/org/apache/commons/crypto/random/OpensslCryptoRandom.java
+++ b/src/main/java/org/apache/commons/crypto/random/OpensslCryptoRandom.java
@@ -73,7 +73,8 @@ class OpensslCryptoRandom extends Random implements CryptoRandom {
     /**
      * Constructs a {@link OpensslCryptoRandom}.
      *
-     * @param props the configuration properties.
+     * @param props the configuration properties
+     * Only used to construct the fallback {@link JavaCryptoRandom} instance
      * @throws NoSuchAlgorithmException if no Provider supports a
      *         SecureRandomSpi implementation for the specified algorithm.
      */

http://git-wip-us.apache.org/repos/asf/commons-crypto/blob/0ef73605/src/main/java/org/apache/commons/crypto/random/OsCryptoRandom.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/crypto/random/OsCryptoRandom.java b/src/main/java/org/apache/commons/crypto/random/OsCryptoRandom.java
index d828e99..be753e6 100644
--- a/src/main/java/org/apache/commons/crypto/random/OsCryptoRandom.java
+++ b/src/main/java/org/apache/commons/crypto/random/OsCryptoRandom.java
@@ -64,6 +64,9 @@ class OsCryptoRandom extends Random implements CryptoRandom {
      * Constructs a {@link OsCryptoRandom}.
      *
      * @param props the configuration properties.
+     * Uses {@link ConfigurationKeys#SECURE_RANDOM_DEVICE_FILE_PATH_KEY} to determine the
+     * path to the random device, default is
+     * {@link ConfigurationKeys#SECURE_RANDOM_DEVICE_FILE_PATH_DEFAULT}
      */
     public OsCryptoRandom(Properties props) {
         randomDevPath = getRandomDevPath(props);


Mime
View raw message