[mina-sshd] branch master updated: [SSHD-1193] Provide a more user-friendly text in case disconnecting due to timeout(s)

[lgoldstein]

This is an automated email from the ASF dual-hosted git repository.

lgoldstein pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/mina-sshd.git


The following commit(s) were added to refs/heads/master by this push:
     new bf4000c  [SSHD-1193] Provide a more user-friendly text in case 
disconnecting due to timeout(s)
bf4000c is described below

commit bf4000ce5b56ce8c5b893ad2620858e1309c1338
Author: Lyor Goldstein <lgoldst...@apache.org>
AuthorDate: Sun Jul 11 19:06:43 2021 +0300

    [SSHD-1193] Provide a more user-friendly text in case disconnecting due to 
timeout(s)
---
 CHANGES.md                                                        | 2 ++
 .../org/apache/sshd/common/session/helpers/TimeoutIndicator.java  | 8 ++++++--
 .../org/apache/sshd/common/session/helpers/SessionHelper.java     | 8 ++++++--
 3 files changed, 14 insertions(+), 4 deletions(-)

diff --git a/CHANGES.md b/CHANGES.md
index b5dc316..d95c290 100644
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -20,6 +20,8 @@
 
 ## Minor code helpers
 
+* [SSHD-1193](https://issues.apache.org/jira/browse/SSHD-1193) Provide a more 
user-friendly text in case disconnecting due to timeout(s).
+
 ## Behavioral changes and enhancements
 
 * [SSHD-1161](https://issues.apache.org/jira/browse/SSHD-1161) Support OpenSSH 
client certificates for publickey authentication
diff --git 
a/sshd-common/src/main/java/org/apache/sshd/common/session/helpers/TimeoutIndicator.java
 
b/sshd-common/src/main/java/org/apache/sshd/common/session/helpers/TimeoutIndicator.java
index 18ac2d5..356a044 100644
--- 
a/sshd-common/src/main/java/org/apache/sshd/common/session/helpers/TimeoutIndicator.java
+++ 
b/sshd-common/src/main/java/org/apache/sshd/common/session/helpers/TimeoutIndicator.java
@@ -69,8 +69,12 @@ public class TimeoutIndicator {
     public String toString() {
         return getClass().getSimpleName()
                + "[status=" + getStatus()
-               + ", threshold=" + getThresholdValue()
-               + ", expired=" + getExpiredValue()
+               + ", threshold=" + toDisplayDurationValue(getThresholdValue())
+               + ", expired=" + toDisplayDurationValue(getExpiredValue())
                + "]";
     }
+
+    public static String toDisplayDurationValue(Duration d) {
+        return (d == null) ? null : Long.toString(d.toMillis());
+    }
 }
diff --git 
a/sshd-core/src/main/java/org/apache/sshd/common/session/helpers/SessionHelper.java
 
b/sshd-core/src/main/java/org/apache/sshd/common/session/helpers/SessionHelper.java
index 09a7a47..a08d37e 100644
--- 
a/sshd-core/src/main/java/org/apache/sshd/common/session/helpers/SessionHelper.java
+++ 
b/sshd-core/src/main/java/org/apache/sshd/common/session/helpers/SessionHelper.java
@@ -298,8 +298,12 @@ public abstract class SessionHelper extends 
AbstractKexFactoryManager implements
         timeoutStatus.set(result);
 
         disconnect(SshConstants.SSH2_DISCONNECT_PROTOCOL_ERROR,
-                "Detected " + status + " after " + result.getExpiredValue()
-                                                                + "/" + 
result.getThresholdValue() + " ms.");
+                "Detected " + status + " after "
+                                                                + 
TimeoutIndicator
+                                                                        
.toDisplayDurationValue(result.getExpiredValue())
+                                                                + "/" + 
TimeoutIndicator.toDisplayDurationValue(
+                                                                        
result.getThresholdValue())
+                                                                + " ms.");
         return result;
     }