refactor: normalize log and exception messages

CHANGELOG.md

@@ -6,7 +6,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 ### Changed
-- Normalized logging using Keyple coding standards.
+- Normalized logging and error messages using Keyple coding standards.
 ### Upgraded
 - `keyple-plugin-java-api` from `2.3.1` to `2.3.2` (code source not impacted)
 - `keyple-distributed-remote-java-api` from `3.1.0` to `3.1.1` (code source not impacted)

src/main/java/org/eclipse/keyple/core/service/AbstractPluginAdapter.java

@@ -110,7 +110,7 @@ void unregister() {
         ((AbstractReaderAdapter) reader).unregister();
       } catch (Exception e) {
         logger.warn(
-            "[plugin={}] Failed to unregister reader [name={}, reason={}]",
+            "[plugin={}] Failed to unregister reader [reader={}, reason={}]",
             pluginName,
             reader.getName(),
             e.getMessage());

src/main/java/org/eclipse/keyple/core/service/ApduResponseAdapter.java

@@ -67,9 +67,8 @@ public int getStatusWord() {
   }
 
   /**
-   * Returns a string representation of the object.
+   * {@inheritDoc}
    *
-   * @return A string that represents the current state of the object.
    * @since 2.0.0
    */
   @Override

src/main/java/org/eclipse/keyple/core/service/AutonomousObservableLocalPluginAdapter.java

@@ -85,14 +85,17 @@ public void onReaderDisconnected(Set<String> readerNames) {
     for (String readerName : readerNames) {
       CardReader reader = this.getReader(readerName);
       if (reader == null) {
-        logger.warn("[plugin={}] Unable to remove unknown reader [name={}]", getName(), readerName);
+        logger.warn(
+            "[plugin={}] Unable to remove unknown reader [reader={}]", getName(), readerName);
       } else {
         // unregister and remove reader
         ((LocalReaderAdapter) reader).unregister();
         getReadersMap().remove(reader.getName());
-        logger.info(
-            "[plugin={}] Reader removed from readers list [name={}]", getName(), reader.getName());
         notifyReaders.add(readerName);
+        logger.info(
+            "[plugin={}] Reader removed from readers list [reader={}]",
+            getName(),
+            reader.getName());
       }
     }
 
@@ -110,6 +113,6 @@ private void addReader(ReaderSpi readerSpi) {
     reader.register();
     getReadersMap().put(reader.getName(), reader);
     logger.info(
-        "[plugin={}] Reader added to readers list [name={}]", getName(), readerSpi.getName());
+        "[plugin={}] Reader added to readers list [reader={}]", getName(), readerSpi.getName());
   }
 }

src/main/java/org/eclipse/keyple/core/service/BasicCardSelectorAdapter.java

@@ -65,9 +65,8 @@ public BasicCardSelector filterByPowerOnData(String powerOnDataRegex) {
   }
 
   /**
-   * Returns a string representation of the object.
+   * {@inheritDoc}
    *
-   * @return A string that represents the current state of the object.
    * @since 3.0.0
    */
   @Override

src/main/java/org/eclipse/keyple/core/service/CardInsertionActiveMonitoringJobAdapter.java

@@ -78,7 +78,7 @@ public void run() {
         try {
           if (logger.isTraceEnabled()) {
             logger.trace(
-                "[fsmJob={}, reader={}] Starting monitoring job polling process using 'isCardPresent()'",
+                "[fsmJob={}, reader={}] Starting monitoring job process [mode=Polling using 'isCardPresent()']",
                 JOB_ID,
                 reader.getName());
           }

src/main/java/org/eclipse/keyple/core/service/CardRemovalActiveMonitoringJobAdapter.java

@@ -81,7 +81,7 @@ public void run() {
         try {
           if (logger.isTraceEnabled()) {
             logger.trace(
-                "[fsmJob={}, reader={}] Starting monitoring job polling process using 'isCardPresentPing()'",
+                "[fsmJob={}, reader={}] Starting monitoring job process [mode=Polling using 'isCardPresentPing()']",
                 JOB_ID,
                 getReader().getName());
           }

src/main/java/org/eclipse/keyple/core/service/CardResponseAdapter.java

@@ -63,9 +63,8 @@ public boolean isLogicalChannelOpen() {
   }
 
   /**
-   * Returns a string representation of the object.
+   * {@inheritDoc}
    *
-   * @return A string that represents the current state of the object.
    * @since 2.0.0
    */
   @Override

src/main/java/org/eclipse/keyple/core/service/CardSelectionManagerAdapter.java

@@ -218,7 +218,7 @@ public int importCardSelectionScenario(String cardSelectionScenario) {
       } catch (ClassNotFoundException e) {
         // Default card selection
         logger.warn(
-            "Original CardSelection type '{}' is not found. Replaced by default type '{}' for deserialization",
+            "Original CardSelection type '{}' not found. Replaced by default type '{}' for deserialization",
             cardSelectionsTypes.get(i),
             CardSelectionAdapter.class.getName());
         cardSelection =

src/main/java/org/eclipse/keyple/core/service/CardSelectionResponseAdapter.java

@@ -95,9 +95,8 @@ public CardResponseApi getCardResponse() {
   }
 
   /**
-   * Returns a string representation of the object.
+   * {@inheritDoc}
    *
-   * @return A string that represents the current state of the object.
    * @since 2.0.0
    */
   @Override

src/main/java/org/eclipse/keyple/core/service/CardSelectionScenarioAdapter.java

@@ -114,9 +114,8 @@ ChannelControl getChannelControl() {
   }
 
   /**
-   * Returns a string representation of the object.
+   * {@inheritDoc}
    *
-   * @return A string that represents the current state of the object.
    * @since 2.0.0
    */
   @Override

src/main/java/org/eclipse/keyple/core/service/DistributedLocalServiceAdapter.java

@@ -100,7 +100,7 @@ public String executeLocally(String jsonData, String readerName) {
     if (readerName != null) {
       if (logger.isDebugEnabled()) {
         logger.debug(
-            "[localService={}] Processing locally data on reader [name={}, jsonData={}]",
+            "[localService={}] Processing data on local reader [reader={}, jsonData={}]",
             name,
             readerName,
             jsonData);
@@ -109,7 +109,7 @@ public String executeLocally(String jsonData, String readerName) {
     } else {
       if (logger.isDebugEnabled()) {
         logger.debug(
-            "[localService={}] Processing locally data on plugins [jsonData={}]", name, jsonData);
+            "[localService={}] Processing data on local plugins [jsonData={}]", name, jsonData);
       }
       return new LocalPluginExecutor(jsonData).execute();
     }
@@ -192,12 +192,12 @@ public void onReaderEvent(CardReaderEvent readerEvent) {
    */
   void register() {
     int distributedApiLevel = localServiceSpi.exchangeApiLevel(CORE_API_LEVEL);
+    isRegistered = true;
     logger.info(
-        "[localService={}] Registering distributed local service [coreApiLevel={}, localServiceApiLevel={}]",
+        "[localService={}] Distributed local service registered [coreApiLevel={}, localServiceApiLevel={}]",
         name,
         CORE_API_LEVEL,
         distributedApiLevel);
-    isRegistered = true;
   }
 
   /**

src/main/java/org/eclipse/keyple/core/service/IsoCardSelectorAdapter.java

@@ -144,9 +144,8 @@ public IsoCardSelector filterByPowerOnData(String powerOnDataRegex) {
   }
 
   /**
-   * Returns a string representation of the object.
+   * {@inheritDoc}
    *
-   * @return A string that represents the current state of the object.
    * @since 3.0.0
    */
   @Override

src/main/java/org/eclipse/keyple/core/service/LocalPoolPluginAdapter.java

@@ -59,7 +59,9 @@ void unregister() {
       poolPluginSpi.onUnregister();
     } catch (Exception e) {
       logger.warn(
-          "Failed to unregister plugin extension [name={}, reason={}]", getName(), e.getMessage());
+          "[plugin={}] Failed to unregister plugin extension [reason={}]",
+          getName(),
+          e.getMessage());
     }
     super.unregister();
   }
@@ -112,6 +114,10 @@ public CardReader allocateReader(String readerGroupReference) {
     LocalReaderAdapter localReaderAdapter = buildLocalReaderAdapter(readerSpi);
     getReadersMap().put(localReaderAdapter.getName(), localReaderAdapter);
     localReaderAdapter.register();
+
+    if (logger.isDebugEnabled()) {
+      logger.debug("[plugin={}] Reader allocated", getName());
+    }
     return localReaderAdapter;
   }
 
@@ -139,7 +145,7 @@ public void releaseReader(CardReader reader) {
     checkStatus();
     if (logger.isDebugEnabled()) {
       logger.debug(
-          "[plugin={}] Releasing reader [name={}]",
+          "[plugin={}] Releasing reader [reader={}]",
           getName(),
           reader != null ? reader.getName() : null);
     }
@@ -155,5 +161,9 @@ public void releaseReader(CardReader reader) {
       getReadersMap().remove(reader.getName());
       ((LocalReaderAdapter) reader).unregister();
     }
+
+    if (logger.isDebugEnabled()) {
+      logger.debug("[plugin={}] Reader released", getName());
+    }
   }
 }

src/main/java/org/eclipse/keyple/core/service/ObservableLocalPluginAdapter.java

@@ -64,7 +64,7 @@ boolean isMonitoring() {
   public void addObserver(PluginObserverSpi observer) {
     super.addObserver(observer);
     if (countObservers() == 1) {
-      logger.info("[plugin={}] Starting plugin monitoring", getName());
+      logger.info("[plugin={}] Starting reader monitoring", getName());
       thread = new EventThread(getName());
       thread.setName("PluginEventMonitoringThread");
       thread.setUncaughtExceptionHandler(
@@ -92,7 +92,7 @@ public void removeObserver(PluginObserverSpi observer) {
       if (countObservers() == 0) {
         if (thread != null) {
           thread.end();
-          logger.info("[plugin={}] Plugin monitoring stopped", getName());
+          logger.info("[plugin={}] Reader monitoring stopped", getName());
         }
       }
     }
@@ -108,7 +108,7 @@ public void clearObservers() {
     super.clearObservers();
     if (thread != null) {
       thread.end();
-      logger.info("[plugin={}] Plugin monitoring stopped", getName());
+      logger.info("[plugin={}] Reader monitoring stopped", getName());
     }
   }
 
@@ -149,7 +149,7 @@ private void addReader(String readerName) throws PluginIOException {
       reader.register();
       getReadersMap().put(reader.getName(), reader);
       logger.info(
-          "[plugin={}] Adding new plugged reader to readers list [name={}]",
+          "[plugin={}] New plugged reader added to readers list [reader={}]",
           pluginName,
           readerName);
     }
@@ -159,7 +159,7 @@ private void removeReader(CardReader reader) {
       ((LocalReaderAdapter) reader).unregister();
       getReadersMap().remove(reader.getName());
       logger.info(
-          "[plugin={}] Removing unplugged reader from readers list [name={}]",
+          "[plugin={}] Unplugged reader removed from readers list [reader={}]",
           pluginName,
           reader.getName());
     }
@@ -241,7 +241,7 @@ public void run() {
         }
       } catch (InterruptedException e) {
         logger.info(
-            "[plugin={}] Plugin monitoring stopped, possibly because there is no more registered observer",
+            "[plugin={}] Reader monitoring stopped, possibly because there is no more registered observer",
             getName());
         // Restore interrupted state...
         Thread.currentThread().interrupt();

src/main/java/org/eclipse/keyple/core/service/ObservableLocalReaderAdapter.java

@@ -458,7 +458,7 @@ final void unregister() {
       stateService.shutdown();
     } catch (Exception e) {
       logger.warn(
-          "[reader={}] Failed to stop card detection [reason={}]", getName(), e.getMessage());
+          "[reader={}] Failed to stop card monitoring [reason={}]", getName(), e.getMessage());
     }
     notifyObservers(
         new ReaderEventAdapter(getPluginName(), getName(), CardReaderEvent.Type.UNAVAILABLE, null));
@@ -541,7 +541,8 @@ public final void clearObservers() {
   public final void startCardDetection(DetectionMode detectionMode) {
     // RL-DET-REMCTRL.1
     checkStatus();
-    logger.info("[reader={}] Starting card detection [detectionMode={}]", getName(), detectionMode);
+    logger.info(
+        "[reader={}] Starting card monitoring [detectionMode={}]", getName(), detectionMode);
     Assert.getInstance().notNull(detectionMode, "detectionMode");
     this.detectionMode = detectionMode;
     stateService.onEvent(InternalEvent.START_DETECT);
@@ -555,7 +556,7 @@ public final void startCardDetection(DetectionMode detectionMode) {
   @Override
   public final void stopCardDetection() {
     // RL-DET-REMCTRL.1
-    logger.info("[reader={}] Stopping card detection", getName());
+    logger.info("[reader={}] Stopping card monitoring", getName());
     stateService.onEvent(InternalEvent.STOP_DETECT);
   }
 

src/main/java/org/eclipse/keyple/core/service/ObservableRemotePluginAdapter.java

@@ -145,7 +145,7 @@ public void addObserver(PluginObserverSpi observer) {
     observationManager.addObserver(observer);
     if (observationManager.countObservers() == 1) {
 
-      logger.info("[plugin={}] Starting plugin monitoring", getName());
+      logger.info("[plugin={}] Starting remote reader monitoring", getName());
 
       // Start the observation remotely.
       JsonObject input = new JsonObject();
@@ -164,6 +164,8 @@ public void addObserver(PluginObserverSpi observer) {
 
       // Notify the SPI.
       observableRemotePluginSpi.onStartObservation();
+
+      logger.info("[plugin={}] Remote reader monitoring started", getName());
     }
   }
 
@@ -197,7 +199,7 @@ public void clearObservers() {
   /** Stops the monitoring of the plugin. */
   private void stopPluginMonitoring() {
 
-    logger.info("[plugin={}] Stopping plugin monitoring", getName());
+    logger.info("[plugin={}] Stopping remote reader monitoring", getName());
 
     // Notify the SPI first.
     observableRemotePluginSpi.onStopObservation();
@@ -216,7 +218,7 @@ private void stopPluginMonitoring() {
     } catch (Exception e) {
       throwRuntimeException(e);
     }
-    logger.info("[plugin={}] Plugin monitoring stopped", getName());
+    logger.info("[plugin={}] Remote reader monitoring stopped", getName());
   }
 
   /**
@@ -249,12 +251,6 @@ public void setPluginObservationExceptionHandler(
   public void addRemoteReader(RemoteReaderSpi remoteReaderSpi, int clientCoreApiLevel) {
 
     checkStatus();
-    if (logger.isDebugEnabled()) {
-      logger.debug(
-          "[plugin={}] Registering remote reader [name={}]",
-          getName(),
-          remoteReaderSpi != null ? remoteReaderSpi.getName() : null);
-    }
     Assert.getInstance().notNull(remoteReaderSpi, "remoteReaderSpi");
 
     // Create the reader.
@@ -272,6 +268,11 @@ public void addRemoteReader(RemoteReaderSpi remoteReaderSpi, int clientCoreApiLe
     getReadersMap().put(remoteReaderAdapter.getName(), remoteReaderAdapter);
     remoteReaderAdapter.register();
 
+    if (logger.isDebugEnabled()) {
+      logger.debug(
+          "[plugin={}] Remote reader registered [reader={}]", getName(), remoteReaderSpi.getName());
+    }
+
     // Notify observers for a plugin event.
     notifyObservers(
         new PluginEventAdapter(
@@ -286,10 +287,6 @@ public void addRemoteReader(RemoteReaderSpi remoteReaderSpi, int clientCoreApiLe
   @Override
   public void removeRemoteReader(String remoteReaderName) {
 
-    if (logger.isDebugEnabled()) {
-      logger.debug(
-          "[plugin={}] Unregistering remote reader [name={}]", getName(), remoteReaderName);
-    }
     Assert.getInstance().notEmpty(remoteReaderName, "remoteReaderName");
 
     CardReader reader = getReader(remoteReaderName);
@@ -301,6 +298,11 @@ public void removeRemoteReader(String remoteReaderName) {
       throw new IllegalArgumentException(
           "Reader '" + remoteReaderName + "' is not found, not registered or not remote");
     }
+
+    if (logger.isDebugEnabled()) {
+      logger.debug(
+          "[plugin={}] Remote reader unregistered [reader={}]", getName(), remoteReaderName);
+    }
   }
 
   /**
@@ -313,7 +315,7 @@ public void onPluginEvent(String jsonData) {
 
     checkStatus();
     if (logger.isDebugEnabled()) {
-      logger.debug("[plugin={}] Receiving remote plugin event [jsonData={}]", getName(), jsonData);
+      logger.debug("[plugin={}] Remote plugin event received [jsonData={}]", getName(), jsonData);
     }
     Assert.getInstance().notEmpty(jsonData, "jsonData");