[CODEC-155] DigestUtils.getDigest(String) should throw IllegalArgumentException instead of RuntimeException.

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/codec/trunk@1380010 13f79535-47bb-0310-9956-ffa450edef68

Author: garydgregory

src/changes/changes.xml

@@ -51,6 +51,9 @@ The <action> type attribute can be add,update,fix,remove.
     </release>
     -->
     <release version="1.7" date="TBD" description="Feature and fix release.">
+      <action issue="CODEC-155" dev="ggregory" type="add" due-to="ggregory">
+        DigestUtils.getDigest(String) should throw IllegalArgumentException instead of RuntimeException.
+      </action>
       <action issue="CODEC-153" dev="ggregory" type="add" due-to="ggregory">
         Create a class MessageDigestAlgorithms to define standard algorithm names.
       </action>

src/main/java/org/apache/commons/codec/digest/DigestUtils.java

@@ -78,23 +78,25 @@ private static byte[] getBytesUtf8(String data) {
      *            names.
      * @return An MD5 digest instance.
      * @see MessageDigest#getInstance(String)
-     * @throws RuntimeException
-     *             when a {@link java.security.NoSuchAlgorithmException} is caught.
+     * @throws IllegalArgumentException
+     *             when a {@link NoSuchAlgorithmException} is caught.
      */
     public static MessageDigest getDigest(String algorithm) {
         try {
             return MessageDigest.getInstance(algorithm);
         } catch (NoSuchAlgorithmException e) {
-            throw new RuntimeException(e);
+            throw new IllegalArgumentException(e);
         }
     }
 
     /**
      * Returns an MD5 MessageDigest.
      *
      * @return An MD5 digest instance.
-     * @throws RuntimeException
-     *             when a {@link java.security.NoSuchAlgorithmException} is caught.
+     * @throws IllegalArgumentException
+     *             when a {@link NoSuchAlgorithmException} is caught, which should never happen because MD5 is a
+     *             built-in algorithm
+     * @see MessageDigestAlgorithms#MD5
      */
     public static MessageDigest getMd5Digest() {
         return getDigest(MessageDigestAlgorithms.MD5);
@@ -107,8 +109,10 @@ public static MessageDigest getMd5Digest() {
      * </p>
      *
      * @return An SHA-256 digest instance.
-     * @throws RuntimeException
-     *             when a {@link java.security.NoSuchAlgorithmException} is caught.
+     * @throws IllegalArgumentException
+     *             when a {@link NoSuchAlgorithmException} is caught, which should never happen because SHA-256 is a
+     *             built-in algorithm
+     * @see MessageDigestAlgorithms#SHA_256
      */
     public static MessageDigest getSha256Digest() {
         return getDigest(MessageDigestAlgorithms.SHA_256);
@@ -121,8 +125,10 @@ public static MessageDigest getSha256Digest() {
      * </p>
      *
      * @return An SHA-384 digest instance.
-     * @throws RuntimeException
-     *             when a {@link java.security.NoSuchAlgorithmException} is caught.
+     * @throws IllegalArgumentException
+     *             when a {@link NoSuchAlgorithmException} is caught, which should never happen because SHA-384 is a
+     *             built-in algorithm
+     * @see MessageDigestAlgorithms#SHA_384
      */
     public static MessageDigest getSha384Digest() {
         return getDigest(MessageDigestAlgorithms.SHA_384);
@@ -135,8 +141,10 @@ public static MessageDigest getSha384Digest() {
      * </p>
      *
      * @return An SHA-512 digest instance.
-     * @throws RuntimeException
-     *             when a {@link java.security.NoSuchAlgorithmException} is caught.
+     * @throws IllegalArgumentException
+     *             when a {@link NoSuchAlgorithmException} is caught, which should never happen because SHA-512 is a
+     *             built-in algorithm
+     * @see MessageDigestAlgorithms#SHA_512
      */
     public static MessageDigest getSha512Digest() {
         return getDigest(MessageDigestAlgorithms.SHA_512);
@@ -146,8 +154,8 @@ public static MessageDigest getSha512Digest() {
      * Returns an SHA-1 digest.
      *
      * @return An SHA-1 digest instance.
-     * @throws RuntimeException
-     *             when a {@link java.security.NoSuchAlgorithmException} is caught.
+     * @throws IllegalArgumentException
+     *             when a {@link NoSuchAlgorithmException} is caught
      */
     public static MessageDigest getShaDigest() {
         return getDigest("SHA");

src/main/java/org/apache/commons/codec/digest/Sha2Crypt.java

@@ -17,6 +17,7 @@
 package org.apache.commons.codec.digest;
 
 import java.security.MessageDigest;
+import java.security.NoSuchAlgorithmException;
 import java.util.Arrays;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
@@ -117,8 +118,9 @@ public static String sha256Crypt(byte[] keyBytes, String salt) {
      * @return complete hash value including prefix and salt
      * @throws IllegalArgumentException
      *             if the given salt is {@code null} or does not match the allowed pattern
-     * @throws RuntimeException
-     *             when a {@link java.security.NoSuchAlgorithmException} is caught.
+     * @throws IllegalArgumentException
+     *             when a {@link NoSuchAlgorithmException} is caught
+     * @see MessageDigestAlgorithms
      */
     private static String sha2Crypt(byte[] keyBytes, String salt, String saltPrefix, int blocksize, String algorithm) {