Propagate code and reason from disconnect from server on client

emilm · emilm · commit 99802997c045 · 2022-09-22T15:10:18.000+02:00
diff --git a/OCPP-J/src/main/java/eu/chargetime/ocpp/WebSocketReceiver.java b/OCPP-J/src/main/java/eu/chargetime/ocpp/WebSocketReceiver.java
@@ -5,7 +5,7 @@
    MIT License
 
    Copyright (C) 2016-2018 Thomas Volden <tv@chargetime.eu>
-
+   Copyright (C) 2022 Emil Melar <emil@iconsultable.no>
    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to deal
    in the Software without restriction, including without limitation the rights
@@ -37,7 +37,7 @@ public WebSocketReceiver(WebSocketReceiverEvents handler) {
   @Override
   public void disconnect() {
     receiverEvents.close();
-    handler.disconnected();
+    handler.disconnected(0, "disconnect() method called");
   }
 
   void relay(String message) {
diff --git a/OCPP-J/src/main/java/eu/chargetime/ocpp/WebSocketTransmitter.java b/OCPP-J/src/main/java/eu/chargetime/ocpp/WebSocketTransmitter.java
@@ -6,6 +6,7 @@
  MIT License
 
  Copyright (C) 2016-2018 Thomas Volden
+ Copyright (C) 2022 Emil Melar <emil@iconsultable.no>
 
  Permission is hereby granted, free of charge, to any person obtaining a copy
  of this software and associated documentation files (the "Software"), to deal
@@ -105,7 +106,7 @@ public void onClose(int code, String reason, boolean remote) {
             logger.debug(
                 "On connection close (code: {}, reason: {}, remote: {})", code, reason, remote);
 
-            events.disconnected();
+            events.disconnected(code, reason);
           }
 
           @Override
diff --git a/ocpp-common/src/main/java/eu/chargetime/ocpp/Client.java b/ocpp-common/src/main/java/eu/chargetime/ocpp/Client.java
@@ -6,6 +6,7 @@
 MIT License
 
 Copyright (C) 2016-2018 Thomas Volden
+Copyright (C) 2022 Emil Melar <emil@iconsultable.no>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -113,8 +114,8 @@ public void handleError(
           }
 
           @Override
-          public void handleConnectionClosed() {
-            if (events != null) events.connectionClosed();
+          public void handleConnectionClosed(int code, String reason) {
+            if (events != null) events.connectionClosed(code, reason);
           }
 
           @Override
diff --git a/ocpp-common/src/main/java/eu/chargetime/ocpp/ClientEvents.java b/ocpp-common/src/main/java/eu/chargetime/ocpp/ClientEvents.java
@@ -6,7 +6,7 @@
 
 MIT License
 
-Copyright (C) 2017 Emil Christopher Solli Melar
+Copyright (C) 2022 Emil Melar <emil@iconsultable.no>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -30,5 +30,5 @@ of this software and associated documentation files (the "Software"), to deal
 public interface ClientEvents {
   void connectionOpened();
 
-  void connectionClosed();
+  void connectionClosed(int code, String reason);
 }
diff --git a/ocpp-common/src/main/java/eu/chargetime/ocpp/Communicator.java b/ocpp-common/src/main/java/eu/chargetime/ocpp/Communicator.java
@@ -6,6 +6,7 @@
 MIT License
 
 Copyright (C) 2016-2018 Thomas Volden
+Copyright (C) 2022 Emil Melar <emil@iconsultable.no>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -292,8 +293,8 @@ public void receivedMessage(Object input) {
     }
 
     @Override
-    public void disconnected() {
-      events.onDisconnected();
+    public void disconnected(int code, String reason) {
+      events.onDisconnected(code, reason);
     }
   }
 
diff --git a/ocpp-common/src/main/java/eu/chargetime/ocpp/CommunicatorEvents.java b/ocpp-common/src/main/java/eu/chargetime/ocpp/CommunicatorEvents.java
@@ -7,6 +7,7 @@
 MIT License
 
 Copyright (C) 2016-2018 Thomas Volden
+Copyright (C) 2022 Emil Melar <emil@iconsultable.no>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -66,8 +67,10 @@ public interface CommunicatorEvents {
    */
   void onError(String id, String errorCode, String errorDescription, Object payload);
 
-  /** The connection was disconnected. */
-  void onDisconnected();
+  /** The connection was disconnected.
+   * @param code
+   * @param reason*/
+  void onDisconnected(int code, String reason);
 
   /** A connection was established. */
   void onConnected();
diff --git a/ocpp-common/src/main/java/eu/chargetime/ocpp/RadioEvents.java b/ocpp-common/src/main/java/eu/chargetime/ocpp/RadioEvents.java
@@ -7,6 +7,7 @@
 MIT License
 
 Copyright (C) 2016-2018 Thomas Volden
+Copyright (C) 2022 Emil Melar <emil@iconsultable.no>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -39,6 +40,8 @@ public interface RadioEvents {
    */
   void receivedMessage(Object message);
 
-  /** Disconnected from node. */
-  void disconnected();
+  /** Disconnected from node.
+   * @param code
+   * @param reason*/
+  void disconnected(int code, String reason);
 }
diff --git a/ocpp-common/src/main/java/eu/chargetime/ocpp/Server.java b/ocpp-common/src/main/java/eu/chargetime/ocpp/Server.java
@@ -5,6 +5,7 @@
    MIT License
 
    Copyright (C) 2016-2018 Thomas Volden <tv@chargetime.eu>
+   Copyright (C) 2022 Emil Melar <emil@iconsultable.no>
 
    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to deal
@@ -143,7 +144,7 @@ public void handleError(
                   }
 
                   @Override
-                  public void handleConnectionClosed() {
+                  public void handleConnectionClosed(int code, String reason) {
                     Optional<UUID> sessionIdOptional = getSessionID(session);
                     if (sessionIdOptional.isPresent()) {
                       serverEvents.lostSession(sessionIdOptional.get());
diff --git a/ocpp-common/src/main/java/eu/chargetime/ocpp/Session.java b/ocpp-common/src/main/java/eu/chargetime/ocpp/Session.java
@@ -6,6 +6,7 @@
 MIT License
 
 Copyright (C) 2016-2018 Thomas Volden
+Copyright (C) 2022 Emil Melar <emil@iconsultable.no>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -221,8 +222,8 @@ public void onError(String id, String errorCode, String errorDescription, Object
     }
 
     @Override
-    public void onDisconnected() {
-      events.handleConnectionClosed();
+    public void onDisconnected(int code, String reason) {
+      events.handleConnectionClosed(code, reason);
     }
 
     @Override
diff --git a/ocpp-common/src/main/java/eu/chargetime/ocpp/SessionEvents.java b/ocpp-common/src/main/java/eu/chargetime/ocpp/SessionEvents.java
@@ -10,6 +10,7 @@
 MIT License
 
 Copyright (C) 2016-2018 Thomas Volden
+Copyright (C) 2022 Emil Melar <emil@iconsultable.no>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -59,8 +60,10 @@ public interface SessionEvents {
    */
   void handleError(String uniqueId, String errorCode, String errorDescription, Object payload);
 
-  /** Handle a closed connection. */
-  void handleConnectionClosed();
+  /** Handle a closed connection.
+   * @param code
+   * @param reason*/
+  void handleConnectionClosed(int code, String reason);
 
   /** Handle a opened connection. */
   void handleConnectionOpened();
diff --git a/ocpp-common/src/test/java/eu/chargetime/ocpp/test/ClientTest.java b/ocpp-common/src/test/java/eu/chargetime/ocpp/test/ClientTest.java
@@ -6,6 +6,7 @@
 MIT License
 
 Copyright (C) 2016-2018 Thomas Volden
+Copyright (C) 2022 Emil Melar <emil@iconsultable.no>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -89,7 +90,7 @@ public void connect_connectionOpenedEvent() {
 
     // Then
     verify(events, times(1)).connectionOpened();
-    verify(events, never()).connectionClosed();
+    verify(events, never()).connectionClosed(0, null);
   }
 
   @Test
@@ -98,10 +99,10 @@ public void connect_connectionClosedEvent() {
     client.connect(null, events);
 
     // When
-    this.eventHandler.handleConnectionClosed();
+    this.eventHandler.handleConnectionClosed(0, null);
 
     // Then
-    verify(events, times(1)).connectionClosed();
+    verify(events, times(1)).connectionClosed(0, null);
     verify(events, never()).connectionOpened();
   }
 
diff --git a/ocpp-v1_6-test/src/main/java/eu/chargetime/ocpp/test/FakeChargePoint.java b/ocpp-v1_6-test/src/main/java/eu/chargetime/ocpp/test/FakeChargePoint.java
@@ -9,6 +9,7 @@
 Copyright (C) 2016-2018 Thomas Volden
 Copyright (C) 2019 Kevin Raddatz <kevin.raddatz@valtech-mobility.com>
 Copyright (C) 2022 Mathias Oben <mathias.oben@enervalis.com>
+Copyright (C) 2022 Emil Melar <emil@iconsultable.no>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -307,7 +308,7 @@ public void connect() {
             public void connectionOpened() {}
 
             @Override
-            public void connectionClosed() {}
+            public void connectionClosed(int code, String reason) {}
           });
     } catch (Exception ex) {
       ex.printStackTrace();
diff --git a/ocpp-v1_6/src/main/java/eu/chargetime/ocpp/TimeoutSessionDecorator.java b/ocpp-v1_6/src/main/java/eu/chargetime/ocpp/TimeoutSessionDecorator.java
@@ -5,6 +5,7 @@
    MIT License
 
    Copyright (C) 2016-2018 Thomas Volden <tv@chargetime.eu>
+   Copyright (C) 2022 Emil Melar <emil@iconsultable.no>
 
    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to deal
@@ -123,8 +124,8 @@ public void handleError(
       }
 
       @Override
-      public void handleConnectionClosed() {
-        eventHandler.handleConnectionClosed();
+      public void handleConnectionClosed(int code, String reason) {
+        eventHandler.handleConnectionClosed(code, reason);
         stopTimer();
       }
 
diff --git a/ocpp-v1_6/src/main/java/eu/chargetime/ocpp/WebServiceReceiver.java b/ocpp-v1_6/src/main/java/eu/chargetime/ocpp/WebServiceReceiver.java
@@ -5,6 +5,7 @@
    MIT License
 
    Copyright (C) 2016-2018 Thomas Volden <tv@chargetime.eu>
+   Copyright (C) 2022 Emil Melar <emil@iconsultable.no>
 
    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to deal
@@ -57,7 +58,7 @@ public void disconnect() {
         logger.info("disconnect() failed", e);
       }
     }
-    events.disconnected();
+    events.disconnected(0, "disconnect() method called");
     receiverEvents.disconnect();
   }
 
diff --git a/ocpp-v1_6/src/main/java/eu/chargetime/ocpp/WebServiceTransmitter.java b/ocpp-v1_6/src/main/java/eu/chargetime/ocpp/WebServiceTransmitter.java
@@ -13,6 +13,7 @@
    MIT License
 
    Copyright (C) 2016-2018 Thomas Volden <tv@chargetime.eu>
+   Copyright (C) 2022 Emil Melar <emil@iconsultable.no>
 
    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to deal
@@ -55,7 +56,7 @@ public void disconnect() {
         logger.info("disconnect() failed", e);
       }
     }
-    events.disconnected();
+    events.disconnected(0, "disconnect() method called");
   }
 
   @Override
diff --git a/ocpp-v1_6/src/test/java/eu/chargetime/ocpp/test/TimeoutSessionTest.java b/ocpp-v1_6/src/test/java/eu/chargetime/ocpp/test/TimeoutSessionTest.java
@@ -19,6 +19,7 @@
    MIT License
 
    Copyright (C) 2016-2018 Thomas Volden <tv@chargetime.eu>
+   Copyright (C) 2022 Emil Melar <emil@iconsultable.no>
 
    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to deal
@@ -76,7 +77,7 @@ public void handleConnectionClosed_opened_endTimeout() throws Exception {
     session.open(null, sessionEvents);
 
     // When
-    sessionEvents.handleConnectionClosed();
+    sessionEvents.handleConnectionClosed(0, null);
 
     // Then
     verify(timeoutTimer, times(1)).end();
@@ -100,7 +101,7 @@ public void handleConnectionClosed_accepted_endTimeout() throws Exception {
     session.accept(sessionEvents);
 
     // When
-    sessionEvents.handleConnectionClosed();
+    sessionEvents.handleConnectionClosed(0, null);
 
     // Then
     verify(timeoutTimer, times(1)).end();
diff --git a/ocpp-v2_0-test/src/main/java/eu/chargetime/ocpp/test/FakeChargePoint.java b/ocpp-v2_0-test/src/main/java/eu/chargetime/ocpp/test/FakeChargePoint.java
@@ -5,6 +5,7 @@
    MIT License
 
    Copyright (C) 2018 Thomas Volden <tv@chargetime.eu>
+   Copyright (C) 2022 Emil Melar <emil@iconsultable.no>
 
    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to deal
@@ -49,7 +50,7 @@ public void connect() {
           public void connectionOpened() {}
 
           @Override
-          public void connectionClosed() {}
+          public void connectionClosed(int code, String reason) {}
         });
   }
 

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@`
`6`	`6`	`MIT License`
`7`	`7`
`8`	`8`	`Copyright (C) 2016-2018 Thomas Volden`
	`9`	`+Copyright (C) 2022 Emil Melar <[email protected]>`
`9`	`10`
`10`	`11`	`Permission is hereby granted, free of charge, to any person obtaining a copy`
`11`	`12`	`of this software and associated documentation files (the "Software"), to deal`
`@@ -113,8 +114,8 @@ public void handleError(`
`113`	`114`	`}`
`114`	`115`
`115`	`116`	`@Override`
`116`		`- public void handleConnectionClosed() {`
`117`		`- if (events != null) events.connectionClosed();`
	`117`	`+ public void handleConnectionClosed(int code, String reason) {`
	`118`	`+ if (events != null) events.connectionClosed(code, reason);`
`118`	`119`	`}`
`119`	`120`
`120`	`121`	`@Override`