Added UnlockConnector feature to core profile.

Author: TVolden

ocpp-test/src/main/java/eu/chargetime/ocpp/test/FakeCentralSystem.java

@@ -215,6 +215,11 @@ public void hasReceivedResetConfirmation(String status) {
         assertThat(getCallResultPayload().getString("status"), equalTo(status));
     }
 
+    public void hasReceivedUnlockConnectorConfirmation(String status) {
+        assertThat(getUniqueId(), equalTo("UnlockConnector"));
+        assertThat(getCallResultPayload().getString("status"), equalTo(status));
+    }
+
     public void sendGetConfigurationRequest(String... keys) {
         String payload = "\"key\":%s";
         sendRequest("GetConfiguration", String.format(payload, formatList(keys)));
@@ -256,6 +261,11 @@ public void sendResetRequest(String type) {
         sendRequest("Reset", String.format(payload, type));
     }
 
+    public void sendUnlockConnectorRequest(int connectorId) {
+        String payload = "\"connectorId\": %d";
+        sendRequest("UnlockConnector", String.format(payload, connectorId));
+    }
+
     public enum AvailabilityType {
         Inoperative, Operative
     }

ocpp-test/src/main/java/eu/chargetime/ocpp/test/FakeChargePoint.java

@@ -92,6 +92,12 @@ public ResetConfirmation handleResetRequest(ResetRequest request) {
                 receivedRequest = request;
                 return new ResetConfirmation("Accepted");
             }
+
+            @Override
+            public UnlockConnectorConfirmation handleUnlockConnectorRequest(UnlockConnectorRequest request) {
+                receivedRequest = request;
+                return new UnlockConnectorConfirmation("Unlocked");
+            }
         });
         client = new Client(new Session(new JSONCommunicator(new WebSocketTransmitter()), new Queue()));
         client.addFeatureProfile(core);
@@ -250,4 +256,8 @@ public void hasHandledRemoteStopTransactionRequest() {
     public void hasHandledResetRequest() {
         confirmRequest(ResetRequest.class);
     }
+
+    public void hasHandledUnlockConnectorRequest() {
+        confirmRequest(UnlockConnectorRequest.class);
+    }
 }

ocpp-v1_6/src/it/groovy/core_features/UnlockConnector.groovy

@@ -0,0 +1,39 @@
+package core_features
+
+import eu.chargetime.ocpp.test.FakeCentralSystem
+import eu.chargetime.ocpp.test.FakeChargePoint
+import spock.lang.Shared
+import spock.lang.Specification
+import spock.util.concurrent.PollingConditions
+
+class UnlockConnector extends Specification {
+    @Shared
+    FakeCentralSystem centralSystem = FakeCentralSystem.getInstance();
+    @Shared
+    FakeChargePoint chargePoint = new FakeChargePoint();
+
+    def setupSpec() {
+        // When a Central System is running
+        centralSystem.started();
+    }
+
+    def setup() {
+        chargePoint.connect();
+    }
+
+    def cleanup() {
+        chargePoint.disconnect();
+    }
+
+    def "Central System sends a UnlockConnector request and receives a response"() {
+        def conditions = new PollingConditions(timeout: 1)
+        when:
+        centralSystem.sendUnlockConnectorRequest(1);
+
+        then:
+        conditions.eventually {
+            chargePoint.hasHandledUnlockConnectorRequest();
+            centralSystem.hasReceivedUnlockConnectorConfirmation("Unlocked");
+        }
+    }
+}

ocpp-v1_6/src/main/java/eu/chargetime/ocpp/feature/UnlockConnectorFeature.java

@@ -0,0 +1,53 @@
+package eu.chargetime.ocpp.feature;
+
+import eu.chargetime.ocpp.feature.profile.Profile;
+import eu.chargetime.ocpp.model.Confirmation;
+import eu.chargetime.ocpp.model.Request;
+import eu.chargetime.ocpp.model.UnlockConnectorConfirmation;
+import eu.chargetime.ocpp.model.UnlockConnectorRequest;
+
+/**
+ * ChargeTime.eu - Java-OCA-OCPP
+ * <p>
+ * MIT License
+ * <p>
+ * Copyright (C) 2016 Thomas Volden <[email protected]>
+ * <p>
+ * 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:
+ * <p>
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ * <p>
+ * 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.
+ */
+public class UnlockConnectorFeature extends Feature {
+    public UnlockConnectorFeature(Profile ownerProfile) {
+        super(ownerProfile);
+    }
+
+    @Override
+    public Class<? extends Request> getRequestType() {
+        return UnlockConnectorRequest.class;
+    }
+
+    @Override
+    public Class<? extends Confirmation> getConfirmationType() {
+        return UnlockConnectorConfirmation.class;
+    }
+
+    @Override
+    public String getAction() {
+        return "UnlockConnector";
+    }
+}

ocpp-v1_6/src/main/java/eu/chargetime/ocpp/feature/profile/ClientCoreEventHandler.java

@@ -36,6 +36,7 @@ public interface ClientCoreEventHandler {
     DataTransferConfirmation handleDataTransferRequest(DataTransferRequest request);
     RemoteStartTransactionConfirmation handleRemoteStartTransactionRequest(RemoteStartTransactionRequest request);
     RemoteStopTransactionConfirmation handleRemoteStopTransactionRequest(RemoteStopTransactionRequest request);
-
     ResetConfirmation handleResetRequest(ResetRequest request);
+
+    UnlockConnectorConfirmation handleUnlockConnectorRequest(UnlockConnectorRequest request);
 }

ocpp-v1_6/src/main/java/eu/chargetime/ocpp/feature/profile/CoreProfile.java

@@ -57,6 +57,7 @@ public CoreProfile(ClientCoreEventHandler handler) {
         features.add(new StartTransactionFeature(this));
         features.add(new StatusNotificationFeature(this));
         features.add(new StopTransactionFeature(this));
+        features.add(new UnlockConnectorFeature(this));
     }
 
     public AuthorizeRequest createAuthorizeRequest(String idToken) throws PropertyConstraintException {
@@ -151,6 +152,8 @@ else if (request instanceof DataTransferRequest) {
             result = eventHandler.handleRemoteStopTransactionRequest((RemoteStopTransactionRequest) request);
         } else if (request instanceof ResetRequest) {
             result = eventHandler.handleResetRequest((ResetRequest) request);
+        } else if (request instanceof UnlockConnectorRequest) {
+            result = eventHandler.handleUnlockConnectorRequest((UnlockConnectorRequest) request);
         }
 
         return result;

ocpp-v1_6/src/main/java/eu/chargetime/ocpp/model/RemoteStopTransactionConfirmation.java

@@ -35,7 +35,11 @@ public RemoteStopTransactionConfirmation() {
     }
 
     public RemoteStopTransactionConfirmation(String status) {
-        this.status = status;
+        try {
+            setStatus(status);
+        } catch (PropertyConstraintException e) {
+            e.printStackTrace();
+        }
     }
 
     @Override

ocpp-v1_6/src/main/java/eu/chargetime/ocpp/model/ResetConfirmation.java

@@ -35,7 +35,11 @@ public ResetConfirmation() {
     }
 
     public ResetConfirmation(String status) {
-        this.status = status;
+        try {
+            setStatus(status);
+        } catch (PropertyConstraintException e) {
+            e.printStackTrace();
+        }
     }
 
     @Override

ocpp-v1_6/src/main/java/eu/chargetime/ocpp/model/UnlockConnectorConfirmation.java

@@ -0,0 +1,64 @@
+package eu.chargetime.ocpp.model;
+
+import eu.chargetime.ocpp.PropertyConstraintException;
+import eu.chargetime.ocpp.utilities.ModelUtil;
+
+/**
+ * ChargeTime.eu - Java-OCA-OCPP
+ * <p>
+ * MIT License
+ * <p>
+ * Copyright (C) 2016 Thomas Volden <[email protected]>
+ * <p>
+ * 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:
+ * <p>
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ * <p>
+ * 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.
+ */
+public class UnlockConnectorConfirmation implements Confirmation {
+    private String status;
+
+    public UnlockConnectorConfirmation() {
+    }
+
+    public UnlockConnectorConfirmation(String status) {
+        try {
+            setStatus(status);
+        } catch (PropertyConstraintException e) {
+            e.printStackTrace();
+        }
+    }
+
+    @Override
+    public boolean validate() {
+        return isValidStatus(status);
+    }
+
+    public void setStatus(String status) throws PropertyConstraintException {
+        if (!isValidStatus(status))
+            throw new PropertyConstraintException("status", status);
+
+        this.status = status;
+    }
+
+    private boolean isValidStatus(String status) {
+        return ModelUtil.isAmong(status, "Unlocked", "UnlockFailed", "NotSupported");
+    }
+
+    public String getStatus() {
+        return status;
+    }
+}

ocpp-v1_6/src/main/java/eu/chargetime/ocpp/model/UnlockConnectorRequest.java

@@ -0,0 +1,48 @@
+package eu.chargetime.ocpp.model;
+
+import eu.chargetime.ocpp.PropertyConstraintException;
+
+/**
+ * ChargeTime.eu - Java-OCA-OCPP
+ * <p>
+ * MIT License
+ * <p>
+ * Copyright (C) 2016 Thomas Volden <[email protected]>
+ * <p>
+ * 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:
+ * <p>
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ * <p>
+ * 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.
+ */
+public class UnlockConnectorRequest implements Request {
+    private Integer connectorId;
+
+    @Override
+    public boolean validate() {
+        return connectorId != null;
+    }
+
+    public void setConnectorId(Integer connectorId) throws PropertyConstraintException {
+        if (connectorId <= 0)
+            throw new PropertyConstraintException("connectorId", connectorId);
+
+        this.connectorId = connectorId;
+    }
+
+    public Integer getConnectorId() {
+        return connectorId;
+    }
+}