Quality fixes from SonarQube

Author: cardil

README.md

@@ -1,6 +1,6 @@
 # EID Runtime Exceptions and Utilities
 
-[![Build Status](https://travis-ci.org/wavesoftware/java-eid-exceptions.svg?branch=master)](https://travis-ci.org/wavesoftware/java-eid-exceptions) [![Coverage Status](https://coveralls.io/repos/wavesoftware/java-eid-exceptions/badge.svg?branch=master&service=github)](https://coveralls.io/github/wavesoftware/java-eid-exceptions?branch=master) [![Maven Central](https://img.shields.io/maven-central/v/pl.wavesoftware/eid-exceptions.svg)](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22pl.wavesoftware%22%20AND%20a%3A%22eid-exceptions%22)
+[![Build Status](https://travis-ci.org/wavesoftware/java-eid-exceptions.svg?branch=master)](https://travis-ci.org/wavesoftware/java-eid-exceptions) [![Coverage Status](https://coveralls.io/repos/wavesoftware/java-eid-exceptions/badge.svg?branch=master&service=github)](https://coveralls.io/github/wavesoftware/java-eid-exceptions?branch=master) [![SonarQube Tech Debt](https://img.shields.io/sonar/http/sonar-ro.wavesoftware.pl/pl.wavesoftware:eid-exceptions/tech_debt.svg)](http://sonar-ro.wavesoftware.pl/dashboard/index/2600) [![Maven Central](https://img.shields.io/maven-central/v/pl.wavesoftware/eid-exceptions.svg)](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22pl.wavesoftware%22%20AND%20a%3A%22eid-exceptions%22)
 
 This small library holds a set of Exceptions that implements idea of fast, reusable, error codes that can be simple thrown fast in case of unpredictable and unrecoverable application failure.
 

src/main/java/pl/wavesoftware/eid/exceptions/Eid.java

@@ -36,9 +36,19 @@ public class Eid implements Serializable {
 
     public static final String DEFAULT_REF_FORMAT = "[%s|%s]<%s>";
 
+    public static final String DEFAULT_MESSAGE_FORMAT = "%s => %s";
+
+    public static final UniqIdGenerator DEFAULT_UNIQ_ID_GENERATOR = new StdUniqIdGenerator();
+
     private static final long serialVersionUID = -9876432123423401L;
 
-    private static final Random RANDOM = new Random(System.currentTimeMillis());
+    private static final int FORMAT_NUM_SPEC = 2;
+
+    private static final int REF_FORMAT_NUM_SPEC = 3;
+
+    static String messageFormat = DEFAULT_MESSAGE_FORMAT;
+
+    private static UniqIdGenerator uniqIdGenerator = DEFAULT_UNIQ_ID_GENERATOR;
 
     private static String format = DEFAULT_FORMAT;
 
@@ -51,15 +61,70 @@ public class Eid implements Serializable {
     private final String uniq;
 
     /**
-     * Sets the actual format that will be used in {@link toString()} method. It will return previously used format.
+     * Constructor
      *
-     * @param format a format compliant with {@link String#format(String, Object...)} with 2 object arguments
-     * @return a previously used format
+     * @param id the exception id, must be unique developer insereted string, from date
+     * @param ref an optional reference
+     */
+    public Eid(String id, @Nullable String ref) {
+        uniq = uniqIdGenerator.generateUniqId();
+        this.id = id;
+        this.ref = ref == null ? "" : ref;
+    }
+
+    /**
+     * Constructor
+     *
+     * @param id the exception id, must be unique developer insereted string, from date
+     */
+    public Eid(String id) {
+        this(id, null);
+    }
+
+    /**
+     * Sets a format that will be used for all Eid exceptions when printing a detail message.
+     * <p>
+     * Format must be non-null and contain two format specifiers <tt>"%s"</tt>
+     *
+     * @param format a format that will be used, must be non-null and contain two format specifiers <tt>"%s"</tt>
+     * @return previously used format
      * @throws NullPointerException if given format was null
      * @throws IllegalArgumentException if given format hasn't got two format specifiers <tt>"%s"</tt>
      */
-    public static String setFormat(String format) throws NullPointerException, IllegalArgumentException {
+    public static String setMessageFormat(String format) {
         validateFormat(format, 2);
+        String oldFormat = Eid.messageFormat;
+        Eid.messageFormat = format;
+        return oldFormat;
+    }
+
+    /**
+     * Sets the actual unique ID generator that will be used to generate IDs for all Eid objects. It will return previously used
+     * generator.
+     *
+     * @param uniqIdGenerator new instance of unique ID generator
+     * @return a previously used unique ID generator
+     * @throws IllegalArgumentException if given generator was null
+     */
+    public static UniqIdGenerator setUniqIdGenerator(UniqIdGenerator uniqIdGenerator) {
+        if (uniqIdGenerator == null) {
+            throw new IllegalArgumentException(new NullPointerException("Unique ID generator can't be null, but given one"));
+        }
+        UniqIdGenerator previous = Eid.uniqIdGenerator;
+        Eid.uniqIdGenerator = uniqIdGenerator;
+        return previous;
+    }
+
+    /**
+     * Sets the actual format that will be used in {@link toString()} method. It will return previously used format.
+     *
+     * @param format a format compliant with {@link String#format(String, Object...)} with 2 object arguments
+     * @return a previously used format
+     * @throws IllegalArgumentException if given format hasn't got two format specifiers <tt>"%s"</tt>, or if given format was
+     * null
+     */
+    public static String setFormat(String format) {
+        validateFormat(format, FORMAT_NUM_SPEC);
         String prevoiusly = Eid.format;
         Eid.format = format;
         return prevoiusly;
@@ -71,36 +136,16 @@ public static String setFormat(String format) throws NullPointerException, Illeg
      * @param refFormat a format compliant with {@link String#format(String, Object...)} with 3 object arguments
      * @return a previously used format
      * @throws NullPointerException if given format was null
-     * @throws IllegalArgumentException if given format hasn't got tree format specifiers <tt>"%s"</tt>
+     * @throws IllegalArgumentException if given format hasn't got tree format specifiers <tt>"%s"</tt>, or if given format was
+     * null
      */
     public static String setRefFormat(String refFormat) {
-        validateFormat(refFormat, 3);
+        validateFormat(refFormat, REF_FORMAT_NUM_SPEC);
         String prevoiusly = Eid.refFormat;
         Eid.refFormat = refFormat;
         return prevoiusly;
     }
 
-    /**
-     * Constructor
-     *
-     * @param id the exception id, must be unique developer insereted string, from date
-     * @param ref an optional reference
-     */
-    public Eid(String id, @Nullable String ref) {
-        uniq = Integer.toString(abs(Long.valueOf(abs(RANDOM.nextLong()) + abs(RANDOM.nextInt())).intValue()), 36);
-        this.id = id;
-        this.ref = ref == null ? "" : ref;
-    }
-
-    /**
-     * Constructor
-     *
-     * @param id the exception id, must be unique developer insereted string, from date
-     */
-    public Eid(String id) {
-        this(id, null);
-    }
-
     @Override
     public String toString() {
         if ("".equals(ref)) {
@@ -138,11 +183,11 @@ public String getUniq() {
 
     static void validateFormat(String format, int numSpecifiers) throws NullPointerException, IllegalArgumentException {
         if (format == null) {
-            throw new NullPointerException("Format can't be null, but just recieved one");
+            throw new IllegalArgumentException(new NullPointerException("Format can't be null, but just recieved one"));
         }
         List<String> specifiers = new ArrayList<>();
         for (int i = 0; i < numSpecifiers; i++) {
-            specifiers.add(i + Integer.toString(abs(RANDOM.nextInt()), 36));
+            specifiers.add(i + "-test-id");
         }
         String formated = String.format(format, specifiers.toArray());
         for (String specifier : specifiers) {
@@ -153,4 +198,44 @@ static void validateFormat(String format, int numSpecifiers) throws NullPointerE
         }
     }
 
+    /**
+     * It is used to generate unique ID for each EID object. It's mustn't be secure becouse it just indicate EID object while
+     * logging.
+     */
+    public static interface UniqIdGenerator {
+
+        /**
+         * Generates a uniq string ID
+         *
+         * @return a generated unique ID
+         */
+        String generateUniqId();
+    }
+
+    private static class StdUniqIdGenerator implements UniqIdGenerator {
+
+        private static final int BASE36 = 36;
+
+        private final Random random;
+
+        public StdUniqIdGenerator() {
+            this.random = getUnsecureFastRandom();
+        }
+
+        @Override
+        public String generateUniqId() {
+            long first = abs(random.nextLong());
+            int second = abs(random.nextInt(Integer.MAX_VALUE));
+            int calc = (int) (first + second);
+            return Integer.toString(calc, BASE36);
+        }
+
+        private Random getUnsecureFastRandom() {
+            @SuppressWarnings("squid:S2245")
+            Random ret = new Random(System.currentTimeMillis());
+            return ret;
+        }
+
+    }
+
 }

src/main/java/pl/wavesoftware/eid/exceptions/EidRuntimeException.java

@@ -15,8 +15,6 @@
  */
 package pl.wavesoftware.eid.exceptions;
 
-import static pl.wavesoftware.eid.exceptions.Eid.validateFormat;
-
 /**
  * <strong>This class shouldn't be used in any public API or library.</strong> It is designed to be used for in-house development
  * of end user applications which will report Bugs in standarized error pages or post them to issue tracker.
@@ -37,10 +35,6 @@
  */
 public class EidRuntimeException extends RuntimeException implements EidContainer {
 
-    public static final String DEFAULT_MESSAGE_FORMAT = "%s => %s";
-
-    private static String messageFormat = DEFAULT_MESSAGE_FORMAT;
-
     private static final long serialVersionUID = -9876432123423587L;
 
     private final Eid eid;
@@ -102,7 +96,7 @@ public EidRuntimeException(Eid id) {
      * permitted, and indicates that the cause is nonexistent or unknown.)
      */
     public EidRuntimeException(Eid id, Throwable cause) {
-        super(String.format(messageFormat, id.toString(), message(cause)), cause);
+        super(String.format(Eid.messageFormat, id.toString(), message(cause)), cause);
         eid = id;
     }
 
@@ -111,23 +105,6 @@ public Eid getEid() {
         return eid;
     }
 
-    /**
-     * Sets a format that will be used for all Eid exceptions when printing a detail message.
-     * <p>
-     * Format must be non-null and contain two format specifiers <tt>"%s"</tt>
-     *
-     * @param format a format that will be used, must be non-null and contain two format specifiers <tt>"%s"</tt>
-     * @return previously used format
-     * @throws NullPointerException if given format was null
-     * @throws IllegalArgumentException if given format hasn't got two format specifiers <tt>"%s"</tt>
-     */
-    public static String setMessageFormat(String format) throws NullPointerException, IllegalArgumentException {
-        validateFormat(format, 2);
-        String oldFormat = EidRuntimeException.messageFormat;
-        EidRuntimeException.messageFormat = format;
-        return oldFormat;
-    }
-
     /**
      * Returns a standard JDK class that this ones is base on. It doesn't mean this class extends that class.
      *

src/main/java/pl/wavesoftware/eid/utils/EidPreconditions.java

@@ -282,7 +282,7 @@ public static <R> R tryToExecute(@Nonnull RiskyCode<R> code, @Nonnull String eid
         String checkedEid = checkNotNull(eid);
         try {
             return code.execute();
-        } catch (Exception throwable) { // NOSONAR
+        } catch (Exception throwable) {
             throw new EidRuntimeException(new Eid(checkedEid), throwable);
         }
     }
@@ -317,7 +317,7 @@ public static <R> R tryToExecute(@Nonnull RiskyCode<R> code, @Nonnull Eid eid) {
         Eid checkedEid = checkNotNull(eid);
         try {
             return code.execute();
-        } catch (Exception throwable) { // NOSONAR
+        } catch (Exception throwable) {
             throw new EidRuntimeException(checkedEid, throwable);
         }
     }
@@ -335,12 +335,16 @@ public interface RiskyCode<R> {
          * @return a object of client code
          * @throws Exception this exception sould be set to concrete one
          */
+        @SuppressWarnings({
+            "pmd:SignatureDeclareThrowsException",
+            "squid:S00112"
+        })
         R execute() throws Exception;
     }
 
     private static <T> T checkNotNull(@Nullable T reference) {
         if (reference == null) {
-            throw new NullPointerException("Pass not-null Eid to EidPreconditions first!");
+            throw new IllegalArgumentException(new NullPointerException("Pass not-null Eid to EidPreconditions first!"));
         }
         return reference;
     }