Apache
/
commons-lang
mirror of https://github.com/apache/commons-lang.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Javadoc

This commit is contained in:
Gary Gregory 2024-08-22 15:50:24 -04:00
parent c4164c4e16
commit 5d3c269193
2 changed files with 26 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
src/main/java/org/apache/commons/lang3/RandomStringUtils.java
View File

@ -25,15 +25,17 @@ import java.util.function.Supplier;
/**
* Generates random {@link String}s.
* <p>
* Use {@link #secure()} to get the singleton instance based on {@link SecureRandom#SecureRandom()} which uses a secure random number generator (RNG)
* implementing the default random number algorithm.
* Use {@link #secure()} to get the singleton instance based on {@link SecureRandom#SecureRandom()} which uses a secure random number generator implementing the
* default random number algorithm.
* </p>
* <p>
* Use {@link #secureStrong()} to get the singleton instance based on {@link SecureRandom#getInstanceStrong()} which uses an algorithms/providers specified in
* the {@code securerandom.strongAlgorithms} {@link Security} property.
* Use {@link #secureStrong()} to get the singleton instance based on {@link SecureRandom#getInstanceStrong()} which uses an instance that was selected by using
* the algorithms/providers specified in the {@code securerandom.strongAlgorithms} {@link Security} property.
* </p>
* <p>
* Use {@link #insecure()} to get the singleton instance based on {@link ThreadLocalRandom#current()}; <b>which is not cryptographically secure</b>.
* Use {@link #insecure()} to get the singleton instance based on {@link ThreadLocalRandom#current()} <b>which is not cryptographically secure</b>. In addition,
* instances do not use a cryptographically random seed unless the {@linkplain System#getProperty system property} {@code java.util.secureRandomSeed} is set to
* {@code true}.
* </p>
* <p>
* Starting in version 3.17.0, the method {@link #secure()} uses {@link SecureRandom#SecureRandom()} instead of {@link SecureRandom#getInstanceStrong()}, and
@ -67,6 +69,12 @@ import java.util.function.Supplier;
* #ThreadSafe#
* </p>
*
* @see #secure()
* @see #secureStrong()
* @see #insecure()
* @see SecureRandom#SecureRandom()
* @see SecureRandom#getInstanceStrong()
* @see ThreadLocalRandom#current()
* @see RandomUtils
* @since 1.0
*/

18
src/main/java/org/apache/commons/lang3/RandomUtils.java
View File

@ -28,15 +28,17 @@ import org.apache.commons.lang3.exception.UncheckedException;
/**
* Supplements the standard {@link Random} class.
* <p>
* Use {@link #secure()} to get the singleton instance based on {@link SecureRandom#SecureRandom()} which uses a secure random number generator (RNG)
* implementing the default random number algorithm.
* Use {@link #secure()} to get the singleton instance based on {@link SecureRandom#SecureRandom()} which uses a secure random number generator implementing the
* default random number algorithm.
* </p>
* <p>
* Use {@link #secureStrong()} to get the singleton instance based on {@link SecureRandom#getInstanceStrong()} which uses an algorithms/providers specified in
* the {@code securerandom.strongAlgorithms} {@link Security} property.
* Use {@link #secureStrong()} to get the singleton instance based on {@link SecureRandom#getInstanceStrong()} which uses an instance that was selected by using
* the algorithms/providers specified in the {@code securerandom.strongAlgorithms} {@link Security} property.
* </p>
* <p>
* Use {@link #insecure()} to get the singleton instance based on {@link ThreadLocalRandom#current()}; <b>which is not cryptographically secure</b>.
* Use {@link #insecure()} to get the singleton instance based on {@link ThreadLocalRandom#current()} <b>which is not cryptographically secure</b>. In addition,
* instances do not use a cryptographically random seed unless the {@linkplain System#getProperty system property} {@code java.util.secureRandomSeed} is set to
* {@code true}.
* </p>
* <p>
* Starting in version 3.17.0, the method {@link #secure()} uses {@link SecureRandom#SecureRandom()} instead of {@link SecureRandom#getInstanceStrong()}, and
@ -57,6 +59,12 @@ import org.apache.commons.lang3.exception.UncheckedException;
* (performance and/or correctness).
* </p>
*
* @see #secure()
* @see #secureStrong()
* @see #insecure()
* @see SecureRandom#SecureRandom()
* @see SecureRandom#getInstanceStrong()
* @see ThreadLocalRandom#current()
* @see RandomStringUtils
* @since 3.3
*/