eliminate SpotBugs/PMD warnings

Author: stefanseifert

.gitignore

@@ -16,14 +16,19 @@ npm-debug.log
 .settings
 .externalToolBuilders
 .pmd
+.eclipse-pmd
 .checkstyle
 .idea
 .vagrant
 *.iml
 .DS_Store
+*.retry
 .rubygems
 .sass-cache
 .rubygems-gem-maven-plugin
 *.sublime-*
 *nbactions*.xml
 .temp/
+.vlt
+.vlt-sync*
+.brackets.json

conga-aem-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/handlebars/helper/AbstractFilter.java

@@ -51,6 +51,7 @@ protected final String getValue(Map<String, Object> map, String key) {
    * @param key Key
    * @return Value or null if not set
    */
+  @SuppressWarnings("PMD.PreserveStackTrace")
   protected final String getRegexValue(Map<String, Object> map, String key) {
     String value = getValue(map, key);
 

conga-aem-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/handlebars/helper/AbstractFilterHelper.java

@@ -33,6 +33,7 @@
 abstract class AbstractFilterHelper implements HelperPlugin<Object> {
 
   @Override
+  @SuppressWarnings("PMD.PreserveStackTrace")
   public final Object apply(Object context, Options options, HelperContext pluginContext) throws IOException {
     if (!(context instanceof Map)) {
       throw new IllegalArgumentException("Excpected map object for filter rule.");

conga-aem-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/handlebars/helper/AemDispatcherFilterHelper.java

@@ -45,9 +45,9 @@ public String getName() {
   protected String generateFilter(Map<String, Object> filterMap, Options options) {
     DispatcherFilter filter = new DispatcherFilter(filterMap);
 
-    StringBuilder sb = new StringBuilder();
-    sb.append("{ ");
-    sb.append("/type \"").append(filter.getType()).append("\" ");
+    StringBuilder sb = new StringBuilder()
+        .append("{ ")
+        .append("/type \"").append(filter.getType()).append("\" ");
 
     if (StringUtils.isNotEmpty(filter.getMethod())) {
       sb.append("/method '").append(filter.getMethod()).append("' ");

conga-aem-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/handlebars/helper/WebConsolePasswordHashHelper.java

@@ -103,25 +103,25 @@ private String hashPassword(String password, final String hashAlgorithm, final S
     try {
       bytePassword = password.getBytes(encoding);
     }
-    catch (UnsupportedEncodingException e) {
-      throw new IOException("Cannot hash the password: " + e);
+    catch (UnsupportedEncodingException ex) {
+      throw new IOException("Cannot hash the password.", ex);
     }
 
     // create password hash
     try {
       final MessageDigest md = MessageDigest.getInstance(hashAlgorithm);
       hashedPassword = md.digest(bytePassword);
     }
-    catch (NoSuchAlgorithmException e) {
-      throw new IOException("Cannot hash the password: " + e);
+    catch (NoSuchAlgorithmException ex) {
+      throw new IOException("Cannot hash the password.", ex);
     }
 
     // encode hashed password to utf8
     try {
       hashedPasswordBase64 = new String(Base64.getEncoder().encode(hashedPassword), encoding);
     }
-    catch (UnsupportedEncodingException e) {
-      throw new IOException("Invalid Encoding: " + e);
+    catch (UnsupportedEncodingException ex) {
+      throw new IOException("Invalid Encoding.", ex);
     }
 
     return String.format("{%s}%s", hashAlgorithm.toLowerCase(), hashedPasswordBase64);

conga-aem-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/postprocessor/ContentPackageOsgiConfigPostProcessor.java

@@ -90,7 +90,7 @@ public List<FileContext> apply(FileContext fileContext, PostProcessorContext con
 
       // create AEM content package with configurations
       File zipFile = new File(file.getParentFile(), FilenameUtils.getBaseName(file.getName()) + ".zip");
-      logger.info("Generate " + zipFile.getCanonicalPath());
+      logger.info("Generate {}", zipFile.getCanonicalPath());
 
       String rootPath = ContentPackageUtil.getMandatoryProp(options, PROPERTY_PACKAGE_ROOT_PATH);
 

conga-aem-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/postprocessor/ContentPackagePostProcessor.java

@@ -83,7 +83,7 @@ public List<FileContext> apply(FileContext fileContext, PostProcessorContext con
 
       // create AEM content package with configurations
       File zipFile = new File(file.getParentFile(), FilenameUtils.getBaseName(file.getName()) + ".zip");
-      logger.info("Generate " + zipFile.getCanonicalPath());
+      logger.info("Generate {}", zipFile.getCanonicalPath());
 
       String rootPath = ContentPackageUtil.getMandatoryProp(options, PROPERTY_PACKAGE_ROOT_PATH);
 

tooling/conga-aem-crypto-cli/src/main/java/io/wcm/devops/conga/plugins/aem/tooling/crypto/cli/AemCryptoCli.java

@@ -68,6 +68,7 @@ private AemCryptoCli() {
    * @throws Exception Exception
    */
   //CHECKSTYLE:OFF
+  @SuppressWarnings({ "PMD.SignatureDeclareThrowsException", "PMD.SystemPrintln" })
   public static void main(String[] args) throws Exception {
     //CHECKSTYLE:ON
     CommandLine commandLine = new DefaultParser().parse(CLI_OPTIONS, args, true);