slighltly better configuration watch list reporting

Signed-off-by: Ceki Gulcu <[email protected]>

Author: ceki

logback-classic/src/main/java/ch/qos/logback/classic/joran/ReconfigureOnChangeTask.java

@@ -183,8 +183,22 @@ public String toString() {
         return "ReconfigureOnChangeTask(born:" + birthdate + ")";
     }
 
-
+    /**
+     * Contains typo. Replaced by {@link #setScheduledFuture(ScheduledFuture)}.
+     * @param aScheduledFuture
+     * @deprecated
+     */
+    @Deprecated
     public void setScheduredFuture(ScheduledFuture<?> aScheduledFuture) {
+        setScheduledFuture(aScheduledFuture);
+    }
+
+    /**
+     * Replaces {@link #setScheduredFuture(ScheduledFuture)}
+     * @param aScheduledFuture
+     * @since 1.5.19
+     */
+    public void setScheduledFuture(ScheduledFuture<?> aScheduledFuture) {
         this.scheduledFuture = aScheduledFuture;
     }
 }

logback-classic/src/main/java/ch/qos/logback/classic/model/processor/ConfigurationModelHandlerFull.java

@@ -16,6 +16,7 @@
 import ch.qos.logback.classic.joran.ReconfigureOnChangeTask;
 import ch.qos.logback.classic.model.ConfigurationModel;
 import ch.qos.logback.core.Context;
+import ch.qos.logback.core.joran.spi.ConfigurationWatchList;
 import ch.qos.logback.core.joran.util.ConfigurationWatchListUtil;
 import ch.qos.logback.core.model.Model;
 import ch.qos.logback.core.model.processor.ModelHandlerBase;
@@ -25,7 +26,6 @@
 import ch.qos.logback.core.util.Duration;
 import ch.qos.logback.core.util.OptionHelper;
 
-import java.net.URL;
 import java.util.concurrent.ScheduledExecutorService;
 import java.util.concurrent.ScheduledFuture;
 import java.util.concurrent.TimeUnit;
@@ -58,6 +58,18 @@ public void postHandle(ModelInterpretationContext mic, Model model) throws Model
         // post handling of scan attribute works even we need to watch for included files because the main url is
         // set in GenericXMLConfigurator very early in the configuration process
         postProcessScanAttrib(mic, configurationModel);
+
+        ConfigurationWatchList cwl = ConfigurationWatchListUtil.getConfigurationWatchList(getContext());
+        if (cwl != null) {
+            try {
+                addInfo("Main configuration file URL: " + cwl.getMainURL());
+                addInfo("FileWatchList= {" + cwl.getFileWatchListAsStr()+"}");
+                addInfo("URLWatchList= {" + cwl.getUrlWatchListAsStr()+"}");
+            } catch(NoSuchMethodError e) {
+                addWarn("It looks like the version of logback-classic is more recent than");
+                addWarn("the version of logback-core. Please align the two versions.");
+            }
+        }
     }
 
     protected void postProcessScanAttrib(ModelInterpretationContext mic, ConfigurationModel configurationModel) {
@@ -103,7 +115,7 @@ public void detachedPostProcess(String scanStr, String scanPeriodStr) {
 
             ScheduledFuture<?> scheduledFuture = scheduledExecutorService.scheduleAtFixedRate(rocTask, duration.getMilliseconds(), duration.getMilliseconds(),
                             TimeUnit.MILLISECONDS);
-            rocTask.setScheduredFuture(scheduledFuture);
+            rocTask.setScheduledFuture(scheduledFuture);
             context.addScheduledFuture(scheduledFuture);
         }
 

logback-core/src/main/java/ch/qos/logback/core/joran/spi/ConfigurationWatchList.java

@@ -18,7 +18,6 @@
 
 import java.io.File;
 import java.net.HttpURLConnection;
-import java.net.MalformedURLException;
 import java.net.URL;
 import java.net.URLDecoder;
 import java.security.NoSuchAlgorithmException;
@@ -30,6 +29,8 @@
 import static ch.qos.logback.core.CoreConstants.PROPERTIES_FILE_EXTENSION;
 
 /**
+ * This class manages the list of files and/or urls that are watched for changes.
+ *
  * @author Ceki Gülcü
  */
 public class ConfigurationWatchList extends ContextAwareBase {
@@ -130,18 +131,16 @@ private void addAsHTTP_or_HTTPS_URLToWatch(URL url) {
     }
 
     /**
-     * Add the url but only if it is file://.
-     * @param url should be a file
+     * Add the url but only if it is file:// or http(s)://
+     * @param url should be a file or http(s)
      */
-
     public void addToWatchList(URL url) {
+        // assume that the caller has checked that the protocol is one of {file, https, http}.
         String protocolStr = url.getProtocol();
         if (protocolStr.equals(FILE_PROTOCOL_STR)) {
             addAsFileToWatch(url);
         } else if (isHTTP_Or_HTTPS(protocolStr)) {
             addAsHTTP_or_HTTPS_URLToWatch(url);
-        } else {
-            addInfo("Cannot watch ["+url + "] as its protocol is not one of file, http or https.");
         }
     }
 
@@ -269,7 +268,7 @@ static public boolean isWatchableProtocol(URL url) {
             return false;
         }
         String protocolStr = url.getProtocol();
-        return Arrays.stream(WATCHABLE_PROTOCOLS).anyMatch(protocol -> protocol.equalsIgnoreCase(protocolStr));
+        return isWatchableProtocol(protocolStr);
     }
 
     /**
@@ -283,12 +282,23 @@ static public boolean isWatchableProtocol(String protocolStr) {
         return Arrays.stream(WATCHABLE_PROTOCOLS).anyMatch(protocol -> protocol.equalsIgnoreCase(protocolStr));
     }
 
-    @Override
-    public String toString() {
-
-        String fileWatchListStr = fileWatchList.stream().map(File::getPath).collect(Collectors.joining(", "));
+    /**
+     * Returns the urlWatchList field as a String
+     * @return the urlWatchList field as a String
+     * @since 1.5.19
+     */
+    public String getUrlWatchListAsStr() {
         String urlWatchListStr = urlWatchList.stream().map(URL::toString).collect(Collectors.joining(", "));
+        return urlWatchListStr;
+    }
 
-        return "ConfigurationWatchList(" + "mainURL=" + mainURL + ", fileWatchList={" + fileWatchListStr + "}, urlWatchList=[" + urlWatchListStr + "})";
+    /**
+     * Returns the fileWatchList field as a String
+     * @return the fileWatchList field as a String
+     * @since 1.5.19
+     */
+    public String getFileWatchListAsStr() {
+        return fileWatchList.stream().map(File::getPath).collect(Collectors.joining(", "));
     }
+
 }

logback-core/src/main/java/ch/qos/logback/core/joran/util/ConfigurationWatchListUtil.java

@@ -24,6 +24,8 @@
 import java.net.URL;
 
 /**
+ * A thin layer on top of {@link ConfigurationWatchList}.
+ *
  * @author Ceki Gülcü
  */
 public class ConfigurationWatchListUtil {
@@ -85,9 +87,14 @@ public static void addToWatchList(Context context, URL url, boolean createCWL) {
             }
         }
 
-        addInfo(context, "Adding [" + url + "] to configuration watch list.");
-        cwl.addToWatchList(url);
-
+        String protocol = url.getProtocol();
+        if(cwl.isWatchableProtocol(protocol)) {
+            addInfo(context, "Will add [" + url + "] to configuration watch list.");
+            cwl.addToWatchList(url);
+        } else {
+            addInfo(context, "Will not add configuration file ["+url + "] to watch list, because '"+protocol+"' protocol is not watchable.");
+            addInfo(context, "Only the protocols 'file', 'http' and 'https' are watchable.");
+        }
     }
 
     private static ConfigurationWatchList registerNewConfigurationWatchListWithContext(Context context) {