Added action to response calls. This is needed for SOAP implementation.

TVolden · TVolden · commit fb2b115d744f · 2017-01-22T23:27:27.000+01:00
Experimenting with a Web Service listener.
diff --git a/ocpp-common/src/main/java/eu/chargetime/ocpp/Communicator.java b/ocpp-common/src/main/java/eu/chargetime/ocpp/Communicator.java
@@ -70,10 +70,11 @@ public abstract class Communicator {
      * Create a call result envelope to transmit.
      *
      * @param   uniqueId    the id the receiver expects.
+     * @param   action      action name of the feature.
      * @param   payload     packed payload.
      * @return a fully packed message ready to send.
      */
-    protected abstract Object makeCallResult(String uniqueId, Object payload);
+    protected abstract Object makeCallResult(String uniqueId, String action, Object payload);
 
     /**
      * Create a call envelope to transmit to the server.
@@ -172,9 +173,9 @@ public void sendCall(String uniqueId, String action, Request request) {
      * @param   uniqueId                the id the receiver expects.
      * @param   confirmation            the outgoing {@link Confirmation}
      */
-    public void sendCallResult(String uniqueId, Confirmation confirmation) {
+    public void sendCallResult(String uniqueId, String action, Confirmation confirmation) {
         try {
-            radio.send(makeCallResult(uniqueId, packPayload(confirmation)));
+            radio.send(makeCallResult(uniqueId, action, packPayload(confirmation)));
         } catch (NotConnectedException e) {
             e.printStackTrace();
             events.onError(uniqueId, "Not connected", "The confirmation couldn't be send due to the lack of connection", confirmation);
diff --git a/ocpp-common/src/main/java/eu/chargetime/ocpp/FeatureHandler.java b/ocpp-common/src/main/java/eu/chargetime/ocpp/FeatureHandler.java
@@ -30,6 +30,7 @@ of this software and associated documentation files (the "Software"), to deal
 import eu.chargetime.ocpp.model.Request;
 
 import java.util.ArrayList;
+import java.util.Collections;
 import java.util.HashMap;
 import java.util.concurrent.CompletableFuture;
 
@@ -51,8 +52,7 @@ public abstract class FeatureHandler {
      */
     public void addFeatureProfile(Profile profile) {
         Feature[] features = profile.getFeatureList();
-        for (Feature feature : features)
-            featureList.add(feature);
+        Collections.addAll(featureList, features);
     }
 
     /**
diff --git a/ocpp-common/src/main/java/eu/chargetime/ocpp/Listener.java b/ocpp-common/src/main/java/eu/chargetime/ocpp/Listener.java
@@ -26,7 +26,7 @@ of this software and associated documentation files (the "Software"), to deal
  */
 
 public interface Listener {
-    void open(String hostname, int port, ListenerEvents listenerEvents);
+    void open(String hostname, int port, String path, ListenerEvents listenerEvents);
 
     void close();
 }
diff --git a/ocpp-common/src/main/java/eu/chargetime/ocpp/Server.java b/ocpp-common/src/main/java/eu/chargetime/ocpp/Server.java
@@ -60,7 +60,8 @@ public Server(Listener listener) {
      * @param serverEvents Callback handler for server specific events.
      */
     public void open(String hostname, int port, ServerEvents serverEvents) {
-        listener.open(hostname, port, session -> {
+
+        listener.open(hostname, port, null, session -> {
             session.accept(new SessionEvents() {
                 @Override
                 public Feature findFeatureByAction(String action) {
diff --git a/ocpp-common/src/main/java/eu/chargetime/ocpp/Session.java b/ocpp-common/src/main/java/eu/chargetime/ocpp/Session.java
@@ -74,8 +74,8 @@ public String sendRequest(String action, Request payload) {
      * @param uniqueId     the unique identification the receiver expects.
      * @param confirmation the {@link Confirmation} payload to send.
      */
-    public void sendConfirmation(String uniqueId, Confirmation confirmation) {
-        communicator.sendCallResult(uniqueId, confirmation);
+    public void sendConfirmation(String uniqueId, String action, Confirmation confirmation) {
+        communicator.sendCallResult(uniqueId, action, confirmation);
     }
 
 
@@ -144,7 +144,7 @@ public void onCall(String id, String action, String payload) {
                     Request request = communicator.unpackPayload(payload, feature.getRequestType());
                     if (request.validate()) {
                         CompletableFuture<Confirmation> promise = handleIncomingRequest(request);
-                        promise.whenComplete(new ConfirmationHandler(id, communicator));
+                        promise.whenComplete(new ConfirmationHandler(id, action, communicator));
                     } else {
                         communicator.sendCallError(id, "OccurenceConstraintViolation", "Payload for Action is syntactically correct but at least one of the fields violates occurence constraints");
                     }
@@ -193,11 +193,13 @@ private CompletableFuture<Confirmation> handleIncomingRequest(Request request) {
 class ConfirmationHandler implements BiConsumer<Confirmation, Throwable> {
 
     private String id;
+    private String action;
     private Communicator communicator;
 
-    public ConfirmationHandler(String id, Communicator communicator) {
+    public ConfirmationHandler(String id, String action, Communicator communicator) {
 
         this.id = id;
+        this.action = action;
         this.communicator = communicator;
     }
 
@@ -208,7 +210,7 @@ public void accept(Confirmation confirmation, Throwable throwable) {
         } else if (confirmation == null) {
             communicator.sendCallError(id, "NotSupported", "Requested Action is recognized but not supported by the receiver");
         } else {
-            communicator.sendCallResult(id, confirmation);
+            communicator.sendCallResult(id, action, confirmation);
         }
     }
 }
diff --git a/ocpp-common/src/test/java/eu/chargetime/ocpp/test/CommunicatorTest.java b/ocpp-common/src/test/java/eu/chargetime/ocpp/test/CommunicatorTest.java
@@ -68,7 +68,7 @@ public Object packPayload(Object payload) {
             }
 
             @Override
-            protected Object makeCallResult(String uniqueId, Object payload) {
+            protected Object makeCallResult(String uniqueId, String action, Object payload) {
                 return null;
             }
 
diff --git a/ocpp-common/src/test/java/eu/chargetime/ocpp/test/ServerTest.java b/ocpp-common/src/test/java/eu/chargetime/ocpp/test/ServerTest.java
@@ -66,7 +66,7 @@ public void setup() {
         doReturn(request.getClass()).when(feature).getRequestType();
         doReturn(TestConfirmation.class).when(feature).getConfirmationType();
         when(feature.getAction()).thenReturn(null);
-        doAnswer(invocation -> listenerEvents = invocation.getArgumentAt(2, ListenerEvents.class)).when(listener).open(anyString(), anyInt(), any());
+        doAnswer(invocation -> listenerEvents = invocation.getArgumentAt(3, ListenerEvents.class)).when(listener).open(anyString(), anyInt(), any(), any());
         doAnswer(invocation -> sessionEvents = invocation.getArgumentAt(0, SessionEvents.class)).when(session).accept(any());
 
         server = new Server(listener) {
diff --git a/ocpp-common/src/test/java/eu/chargetime/ocpp/test/SessionTest.java b/ocpp-common/src/test/java/eu/chargetime/ocpp/test/SessionTest.java
@@ -115,12 +115,13 @@ public void sendConfirmation_sendsConfirmationToCommunicator() {
         // Given
         Confirmation conf = () -> false;
         String someUniqueId = "Some id";
+        String action = "Some action";
 
         // When
-        session.sendConfirmation(someUniqueId, conf);
+        session.sendConfirmation(someUniqueId, action, conf);
 
         // Then
-        verify(communicator, times(1)).sendCallResult(eq(someUniqueId), eq(conf));
+        verify(communicator, times(1)).sendCallResult(eq(someUniqueId), eq(action), eq(conf));
     }
 
     @Test
@@ -168,7 +169,7 @@ public boolean validate() {
         try { Thread.sleep(10); } catch (Exception ex) {} // TODO make async invoker injectable
 
         // then
-        verify(communicator, times(1)).sendCallResult(anyString(), eq(aConfirmation));
+        verify(communicator, times(1)).sendCallResult(anyString(), anyString(), eq(aConfirmation));
     }
 
     @Test
diff --git a/ocpp-v1_6-test/src/main/java/eu/chargetime/ocpp/test/FakeCentralSystem.java b/ocpp-v1_6-test/src/main/java/eu/chargetime/ocpp/test/FakeCentralSystem.java
@@ -97,6 +97,7 @@ public BootNotificationConfirmation handleBootNotificationRequest(int sessionInd
                 try {
                     confirmation.setInterval(1);
                 } catch (Exception e) {
+                    e.printStackTrace();
                 }
                 confirmation.setCurrentTime(Calendar.getInstance());
                 confirmation.setStatus(RegistrationStatus.Accepted);
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
@@ -7,6 +7,8 @@
 import eu.chargetime.ocpp.model.Request;
 import eu.chargetime.ocpp.model.core.*;
 
+import java.net.MalformedURLException;
+import java.net.URL;
 import java.util.Calendar;
 
 /*
@@ -43,15 +45,15 @@ public class FakeChargePoint
     private ClientCoreProfile core;
     private Throwable receivedException;
 
-    public FakeChargePoint() {
+    public FakeChargePoint() throws MalformedURLException {
         this(clientType.JSON);
     }
 
     public enum clientType {
         JSON, SOAP
     }
 
-    public FakeChargePoint(clientType type) {
+    public FakeChargePoint(clientType type) throws MalformedURLException {
         core = new ClientCoreProfile(new ClientCoreEventHandler() {
             @Override
             public ChangeAvailabilityConfirmation handleChangeAvailabilityRequest(ChangeAvailabilityRequest request) {
@@ -119,7 +121,7 @@ public UnlockConnectorConfirmation handleUnlockConnectorRequest(UnlockConnectorR
                 client = new JSONClient(core);
                 break;
             case SOAP:
-                client = new SOAPClient("me", "http://localhost:8889", core);
+                client = new SOAPClient("me", new URL("http://localhost:8889"), core);
                 break;
         }
     }
diff --git a/ocpp-v1_6/src/main/java/eu/chargetime/ocpp/JSONCommunicator.java b/ocpp-v1_6/src/main/java/eu/chargetime/ocpp/JSONCommunicator.java
@@ -113,7 +113,7 @@ public Calendar deserialize(JsonElement json, Type typeOfT, JsonDeserializationC
     }
 
     @Override
-    protected Object makeCallResult(String uniqueId, Object payload) {
+    protected Object makeCallResult(String uniqueId, String action, Object payload) {
         return String.format(CALLRESULT_FORMAT, uniqueId, payload);
     }
 
diff --git a/ocpp-v1_6/src/main/java/eu/chargetime/ocpp/SOAPClient.java b/ocpp-v1_6/src/main/java/eu/chargetime/ocpp/SOAPClient.java
@@ -26,19 +26,21 @@ of this software and associated documentation files (the "Software"), to deal
 
 import eu.chargetime.ocpp.feature.profile.ClientCoreProfile;
 
+import java.net.URL;
+
 public class SOAPClient extends Client {
 
     private SOAPCommunicator communicator;
     /**
      * The core feature profile is required.
+     * The client will use the information taken from the callback parameter to open a HTTP based Web Service.
      *
      * @param chargeBoxIdentity required identity used in message header.
-     * @param callbackUrl       url that the server can send requests to.
+     * @param callback          call back info that the server can send requests to.
      * @param coreProfile       implementation of the core feature profile.
      */
-    public SOAPClient(String chargeBoxIdentity, String callbackUrl, ClientCoreProfile coreProfile) {
-        this(new SOAPCommunicator(chargeBoxIdentity, callbackUrl, new WebServiceTransmitter()));
-
+    public SOAPClient(String chargeBoxIdentity, URL callback, ClientCoreProfile coreProfile) {
+        this(new SOAPCommunicator(chargeBoxIdentity, callback.toString(), new WebServiceTransmitter()));
         addFeatureProfile(coreProfile);
     }
 
diff --git a/ocpp-v1_6/src/main/java/eu/chargetime/ocpp/SOAPCommunicator.java b/ocpp-v1_6/src/main/java/eu/chargetime/ocpp/SOAPCommunicator.java
@@ -49,13 +49,13 @@ public SOAPCommunicator(String chargeBoxIdentity, String fromUrl, Radio radio) {
         this.fromUrl = fromUrl;
     }
 
+    @SuppressWarnings("unchecked")
     @Override
     public <T> T unpackPayload(Object payload, Class<T> type) {
-        Document input = (Document) payload;
         T output = null;
-        Unmarshaller unmarshaller = null;
         try {
-            unmarshaller = JAXBContext.newInstance(type).createUnmarshaller();
+            Document input = (Document) payload;
+            Unmarshaller unmarshaller = JAXBContext.newInstance(type).createUnmarshaller();
             output = (T) unmarshaller.unmarshal(input);
         } catch (JAXBException e) {
             e.printStackTrace();
@@ -79,13 +79,18 @@ public Object packPayload(Object payload) {
     }
 
     @Override
-    protected Object makeCallResult(String uniqueId, Object payload) {
-        return null;
+    protected Object makeCallResult(String uniqueId, String action, Object payload) {
+        return createMessage(uniqueId, action, (Document) payload, true);
     }
 
     @Override
     protected Object makeCall(String uniqueId, String action, Object payload) {
+        return createMessage(uniqueId, action, (Document) payload, false);
+    }
+
+    private Object createMessage(String uniqueId, String action, Document payload, boolean isResponse) {
         SOAPMessage message = null;
+
         try {
             MessageFactory messageFactory = MessageFactory.newInstance();
             SOAPFactory soapFactory = SOAPFactory.newInstance();
@@ -113,11 +118,11 @@ protected Object makeCall(String uniqueId, String action, Object payload) {
             messageIDHeader.setMustUnderstand(true);
             messageIDHeader.setValue(uniqueId);
 
-            /*
             // Set RelatesTo
-            SOAPHeaderElement relatesToHeader = soapHeader.addHeaderElement(soapFactory.createName("RelatesTo", prefix, namespace));
-            relatesToHeader.setValue(uniqueId);
-            */
+            if (isResponse) {
+                SOAPHeaderElement relatesToHeader = soapHeader.addHeaderElement(soapFactory.createName("RelatesTo", prefix, namespace));
+                relatesToHeader.setValue(uniqueId);
+            }
 
             // Set From
             SOAPHeaderElement fromHeader = soapHeader.addHeaderElement(soapFactory.createName("From", prefix, namespace));
@@ -134,7 +139,7 @@ protected Object makeCall(String uniqueId, String action, Object payload) {
             toHeader.setMustUnderstand(true);
             toHeader.setValue(toUrl);
 
-            message.getSOAPBody().addDocument((Document) payload);
+            message.getSOAPBody().addDocument(payload);
         } catch (Exception e) {
             e.printStackTrace();
         }
diff --git a/ocpp-v1_6/src/main/java/eu/chargetime/ocpp/WebServiceListener.java b/ocpp-v1_6/src/main/java/eu/chargetime/ocpp/WebServiceListener.java
@@ -0,0 +1,70 @@
+package eu.chargetime.ocpp;
+/*
+    ChargeTime.eu - Java-OCA-OCPP
+    
+    MIT License
+
+    Copyright (C) 2016 Thomas Volden <tv@chargetime.eu>
+
+    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
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE.
+ */
+
+import com.sun.net.httpserver.HttpExchange;
+import com.sun.net.httpserver.HttpHandler;
+import com.sun.net.httpserver.HttpServer;
+
+import java.io.IOException;
+import java.io.OutputStream;
+import java.net.InetSocketAddress;
+
+public class WebServiceListener implements Listener {
+
+    class WSHandler implements HttpHandler {
+
+        @Override
+        public void handle(HttpExchange httpExchange) throws IOException {
+            String response = "This is the reponse.";
+            httpExchange.sendResponseHeaders(200, response.length());
+            OutputStream os = httpExchange.getResponseBody();
+            os.write(response.getBytes());
+            os.close();
+        }
+    }
+
+
+    @Override
+    public void open(String hostname, int port, String path, ListenerEvents listenerEvents) {
+        try {
+            HttpServer server = HttpServer.create(new InetSocketAddress(hostname, port), 0);
+            if (path.startsWith("/"))
+                server.createContext(path, new WSHandler());
+            else
+                server.createContext("/", new WSHandler());
+            server.setExecutor(null);
+            server.start();
+        } catch (IOException e) {
+            e.printStackTrace();
+        }
+    }
+
+    @Override
+    public void close() {
+
+    }
+}
diff --git a/ocpp-v1_6/src/main/java/eu/chargetime/ocpp/WebSocketListener.java b/ocpp-v1_6/src/main/java/eu/chargetime/ocpp/WebSocketListener.java
@@ -1,4 +1,5 @@
-package eu.chargetime.ocpp;/*
+package eu.chargetime.ocpp;
+/*
     ChargeTime.eu - Java-OCA-OCPP
     
     MIT License
@@ -38,11 +39,11 @@ public class WebSocketListener implements Listener {
     private HashMap<WebSocket, WebSocketReceiver> sockets;
 
     public WebSocketListener() {
-        sockets = new HashMap();
+        sockets = new HashMap<>();
     }
 
     @Override
-    public void open(String hostname, int port, ListenerEvents handler) {
+    public void open(String hostname, int port, String path, ListenerEvents handler) {
         server = new WebSocketServer(new InetSocketAddress(hostname, port)) {
             @Override
             public void onOpen(WebSocket webSocket, ClientHandshake clientHandshake) {
diff --git a/ocpp-v1_6/src/main/java/eu/chargetime/ocpp/model/core/ChargingProfileKindType.java b/ocpp-v1_6/src/main/java/eu/chargetime/ocpp/model/core/ChargingProfileKindType.java
@@ -27,7 +27,7 @@
  */
 
 /**
- * Acceped values used with {@link ChargingProfile}
+ * Accepted values used with {@link ChargingProfile}
  */
 public enum ChargingProfileKindType {
     Absolute, Recurring, Relative
diff --git a/ocpp-v1_6/src/test/java/eu/chargetime/ocpp/test/SOAPCommunicatorTest.java b/ocpp-v1_6/src/test/java/eu/chargetime/ocpp/test/SOAPCommunicatorTest.java

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ of this software and associated documentation files (the "Software"), to deal`
`26`	`26`	`*/`
`27`	`27`
`28`	`28`	`public interface Listener {`
`29`		`- void open(String hostname, int port, ListenerEvents listenerEvents);`
	`29`	`+ void open(String hostname, int port, String path, ListenerEvents listenerEvents);`
`30`	`30`
`31`	`31`	`void close();`
`32`	`32`	`}`
Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,7 @@ public Object packPayload(Object payload) {`
`68`	`68`	`}`
`69`	`69`
`70`	`70`	`@Override`
`71`		`- protected Object makeCallResult(String uniqueId, Object payload) {`
	`71`	`+ protected Object makeCallResult(String uniqueId, String action, Object payload) {`
`72`	`72`	`return null;`
`73`	`73`	`}`
`74`	`74`
Original file line number	Diff line number	Diff line change
`@@ -97,6 +97,7 @@ public BootNotificationConfirmation handleBootNotificationRequest(int sessionInd`
`97`	`97`	`try {`
`98`	`98`	`confirmation.setInterval(1);`
`99`	`99`	`} catch (Exception e) {`
	`100`	`+ e.printStackTrace();`
`100`	`101`	`}`
`101`	`102`	`confirmation.setCurrentTime(Calendar.getInstance());`
`102`	`103`	`confirmation.setStatus(RegistrationStatus.Accepted);`