WebApi of remote start, remote stop and connector status

src/main/java/de/rwth/idsg/steve/ocpp/CommunicationTask.java

@@ -73,6 +73,10 @@ public CommunicationTask(OcppVersion ocppVersion, S params) {
         this(ocppVersion, params, TaskOrigin.INTERNAL, "SteVe");
     }
 
+    public CommunicationTask(OcppVersion ocppVersion, S params, String caller) {
+        this(ocppVersion, params, TaskOrigin.EXTERNAL, caller);
+    }
+
     /**
      * Do not expose the constructor, make it package-private
      */

src/main/java/de/rwth/idsg/steve/ocpp/task/RemoteStartTransactionTask.java

@@ -35,6 +35,10 @@ public RemoteStartTransactionTask(OcppVersion ocppVersion, RemoteStartTransactio
         super(ocppVersion, params);
     }
 
+    public RemoteStartTransactionTask(OcppVersion ocppVersion, RemoteStartTransactionParams params, String caller) {
+        super(ocppVersion, params, caller);
+    }
+
     @Override
     public OcppCallback<String> defaultCallback() {
         return new StringOcppCallback();

src/main/java/de/rwth/idsg/steve/ocpp/task/RemoteStopTransactionTask.java

@@ -35,6 +35,10 @@ public RemoteStopTransactionTask(OcppVersion ocppVersion, RemoteStopTransactionP
         super(ocppVersion, params);
     }
 
+    public RemoteStopTransactionTask(OcppVersion ocppVersion, RemoteStopTransactionParams params, String caller) {
+        super(ocppVersion, params, caller);
+    }
+
     @Override
     public OcppCallback<String> defaultCallback() {
         return new StringOcppCallback();

src/main/java/de/rwth/idsg/steve/ocpp/task/UnlockConnectorTask.java

@@ -35,6 +35,10 @@ public UnlockConnectorTask(OcppVersion ocppVersion, UnlockConnectorParams params
         super(ocppVersion, params);
     }
 
+    public UnlockConnectorTask(OcppVersion ocppVersion, UnlockConnectorParams params, String caller) {
+        super(ocppVersion, params, caller);
+    }
+
     @Override
     public OcppCallback<String> defaultCallback() {
         return new StringOcppCallback();

src/main/java/de/rwth/idsg/steve/repository/ChargePointRepository.java

@@ -45,6 +45,8 @@ default List<ChargePointSelect> getChargePointSelect(OcppProtocol protocol, List
         return getChargePointSelect(protocol, inStatusFilter, Collections.emptyList());
     }
 
+    List<ChargePointSelect> getChargePointSelect(String chageBoxID);
+
     List<String> getChargeBoxIds();
     Map<String, Integer> getChargeBoxIdPkPair(List<String> chargeBoxIdList);
 

src/main/java/de/rwth/idsg/steve/repository/TransactionRepository.java

@@ -30,11 +30,14 @@
  * @since 19.08.2014
  */
 public interface TransactionRepository {
+    Transaction getTransaction(int transactionPk);
+
     List<Transaction> getTransactions(TransactionQueryForm form);
 
     void writeTransactionsCSV(TransactionQueryForm form, Writer writer);
 
     List<Integer> getActiveTransactionIds(String chargeBoxId);
+    Integer getActiveTransactionId(String chargeBoxId, Integer connectorId);
 
     TransactionDetails getDetails(int transactionPk);
 }

src/main/java/de/rwth/idsg/steve/repository/dto/ConnectorStatus.java

@@ -18,7 +18,9 @@
  */
 package de.rwth.idsg.steve.repository.dto;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import de.rwth.idsg.steve.ocpp.OcppProtocol;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Builder;
 import lombok.Getter;
 import lombok.Setter;
@@ -32,17 +34,32 @@
 @Getter
 @Builder
 public final class ConnectorStatus {
-    private final String chargeBoxId, timeStamp, status, errorCode;
-    private final int chargeBoxPk, connectorId;
+    @JsonIgnore
+    @ApiModelProperty(value = "Charge Box DB key", hidden = true)
+    private final int chargeBoxPk;
+    @ApiModelProperty(value = "Charge Box ID")
+    private final String chargeBoxId;
+    @ApiModelProperty(value = "Connector ID")
+    private final int connectorId;
 
+    @ApiModelProperty(value = "Status")
+    private final String status;
+    @ApiModelProperty(value = "Error code")
+    private final String errorCode;
+
+    @ApiModelProperty(value = "Timestamp")
+    private final String timeStamp;
     // For additional internal processing. Not related to the humanized
     // String version above, which is for representation on frontend
+    @ApiModelProperty(value = "Timestamp of the status")
     private final DateTime statusTimestamp;
 
+    @ApiModelProperty(value = "OCPP version")
     private final OcppProtocol ocppProtocol;
 
     // This is true, if the chargeBox this connector belongs to is a WS/JSON station
     // and it is disconnected at the moment of building this DTO.
+    @ApiModelProperty(value = "Json and Disconnected")
     @Setter
     @Builder.Default
     private boolean jsonAndDisconnected = false;

src/main/java/de/rwth/idsg/steve/repository/dto/TaskOverview.java

@@ -19,6 +19,7 @@
 package de.rwth.idsg.steve.repository.dto;
 
 import de.rwth.idsg.steve.ocpp.TaskOrigin;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Builder;
 import lombok.EqualsAndHashCode;
 import lombok.Getter;
@@ -32,8 +33,17 @@
 @EqualsAndHashCode
 @Builder
 public final class TaskOverview implements Comparable<TaskOverview> {
-    private final int taskId, responseCount, requestCount;
-    private final DateTime start, end;
+    @ApiModelProperty(value = "Task ID")
+    private final int taskId;
+    @ApiModelProperty(value = "Response count")
+    private final int responseCount;
+    @ApiModelProperty(value = "Request count")
+    private final int requestCount;
+    @ApiModelProperty(value = "Starttime")
+    private final DateTime start;
+    @ApiModelProperty(value = "Endtime")
+    private final DateTime end;
+    @ApiModelProperty(value = "Task triggered internal or external")
     private final TaskOrigin origin;
 
     /**

src/main/java/de/rwth/idsg/steve/repository/impl/ChargePointRepositoryImpl.java

@@ -103,6 +103,16 @@ public List<ChargePointSelect> getChargePointSelect(OcppProtocol protocol, List<
                   .map(r -> new ChargePointSelect(protocol.getTransport(), r.value1(), r.value2()));
     }
 
+    @Override  // returns List of zero or one ChargeBox
+    public List<ChargePointSelect> getChargePointSelect(String chageBoxID) {
+        return ctx.select(CHARGE_BOX.CHARGE_BOX_ID, CHARGE_BOX.ENDPOINT_ADDRESS, CHARGE_BOX.OCPP_PROTOCOL)
+                .from(CHARGE_BOX)
+                .where(CHARGE_BOX.CHARGE_BOX_ID.eq(chageBoxID))
+                .fetch()
+                .map(r -> new ChargePointSelect(OcppProtocol.fromCompositeValue(r.value3()).getTransport(),
+                        r.value1(), r.value2()));
+    }
+
     @Override
     public List<String> getChargeBoxIds() {
         return ctx.select(CHARGE_BOX.CHARGE_BOX_ID)

src/main/java/de/rwth/idsg/steve/repository/impl/TransactionRepositoryImpl.java

@@ -66,6 +66,15 @@ public TransactionRepositoryImpl(DSLContext ctx) {
         this.ctx = ctx;
     }
 
+    @Override
+    public Transaction getTransaction(int transactionPk) {
+        TransactionQueryForm form = new TransactionQueryForm();
+        form.setTransactionPk(transactionPk);
+        form.setReturnCSV(false);
+        form.setType(TransactionQueryForm.QueryType.ALL);
+        return getInternal(form).fetchAny(new TransactionMapper());
+    }
+
     @Override
     public List<Transaction> getTransactions(TransactionQueryForm form) {
         return getInternal(form).fetch()
@@ -89,6 +98,19 @@ public List<Integer> getActiveTransactionIds(String chargeBoxId) {
                   .fetch(TRANSACTION.TRANSACTION_PK);
     }
 
+    @Override
+    public Integer getActiveTransactionId(String chargeBoxId, Integer connectorId) {
+        return ctx.select(TRANSACTION.TRANSACTION_PK)
+                  .from(TRANSACTION)
+                  .join(CONNECTOR)
+                    .on(TRANSACTION.CONNECTOR_PK.equal(CONNECTOR.CONNECTOR_PK))
+                    .and(CONNECTOR.CHARGE_BOX_ID.equal(chargeBoxId))
+                  .where(TRANSACTION.STOP_TIMESTAMP.isNull())
+                    .and(CONNECTOR.CONNECTOR_ID.equal(connectorId))
+                  .orderBy(TRANSACTION.TRANSACTION_PK.desc()) // to avoid fetching ghost transactions, fetch the latest
+                  .fetchAny(TRANSACTION.TRANSACTION_PK);
+    }
+
     @Override
     public TransactionDetails getDetails(int transactionPk) {
 

src/main/java/de/rwth/idsg/steve/service/ChargePointService12_Client.java

@@ -138,17 +138,33 @@ public int updateFirmware(UpdateFirmwareParams params) {
 
     public int remoteStartTransaction(RemoteStartTransactionParams params) {
         RemoteStartTransactionTask task = new RemoteStartTransactionTask(getVersion(), params);
+        return addRemoteStartTask(task);
+    }
+
+    public int remoteStartTransaction(RemoteStartTransactionParams params, String caller) {
+        RemoteStartTransactionTask task = new RemoteStartTransactionTask(getVersion(), params, caller);
+        return addRemoteStartTask(task);
+    }
 
+     private int addRemoteStartTask(RemoteStartTransactionTask task) {
         BackgroundService.with(executorService)
                          .forFirst(task.getParams().getChargePointSelectList())
                          .execute(c -> getOcpp12Invoker().remoteStartTransaction(c, task));
 
         return taskStore.add(task);
     }
 
+    public int remoteStopTransaction(RemoteStopTransactionParams params, String caller) {
+        RemoteStopTransactionTask task = new RemoteStopTransactionTask(getVersion(), params, caller);
+        return addRemoteStopTask(task);
+    }
+
     public int remoteStopTransaction(RemoteStopTransactionParams params) {
         RemoteStopTransactionTask task = new RemoteStopTransactionTask(getVersion(), params);
+        return addRemoteStopTask(task);
+    }
 
+    private int addRemoteStopTask(RemoteStopTransactionTask task) {
         BackgroundService.with(executorService)
                          .forFirst(task.getParams().getChargePointSelectList())
                          .execute(c -> getOcpp12Invoker().remoteStopTransaction(c, task));
@@ -158,6 +174,15 @@ public int remoteStopTransaction(RemoteStopTransactionParams params) {
 
     public int unlockConnector(UnlockConnectorParams params) {
         UnlockConnectorTask task = new UnlockConnectorTask(getVersion(), params);
+        return addRemoteUnlockTask(task);
+    }
+
+    public int unlockConnector(UnlockConnectorParams params, String caller) {
+        UnlockConnectorTask task = new UnlockConnectorTask(getVersion(), params, caller);
+        return addRemoteUnlockTask(task);
+    }
+
+     private int addRemoteUnlockTask(UnlockConnectorTask task) {
 
         BackgroundService.with(executorService)
                          .forFirst(task.getParams().getChargePointSelectList())

src/main/java/de/rwth/idsg/steve/web/api/ConnectorRestController.java

@@ -0,0 +1,120 @@
+/*
+ * SteVe - SteckdosenVerwaltung - https://github.com/steve-community/steve
+ * Copyright (C) 2013-2024 SteVe Community Team
+ * All Rights Reserved.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+package de.rwth.idsg.steve.web.api;
+
+import de.rwth.idsg.steve.repository.ChargePointRepository;
+import de.rwth.idsg.steve.repository.dto.ConnectorStatus;
+import de.rwth.idsg.steve.service.ChargePointHelperService;
+import de.rwth.idsg.steve.utils.ConnectorStatusFilter;
+import de.rwth.idsg.steve.web.api.dto.ApiConnectorList;
+import de.rwth.idsg.steve.web.dto.ConnectorStatusForm;
+import de.rwth.idsg.steve.web.dto.OcppJsonStatus;
+import io.swagger.annotations.ApiResponse;
+import io.swagger.annotations.ApiResponses;
+import org.springframework.beans.factory.annotation.Autowired;
+
+import org.springframework.web.bind.annotation.RequestMapping;
+
+import java.util.List;
+import static java.util.Objects.isNull;
+import javax.validation.Valid;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.http.MediaType;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.ResponseBody;
+import org.springframework.web.bind.annotation.RestController;
+
+/**
+ *
+ * @author fnkbsi
+ * since 20.10.2023
+ *
+ */
+@Slf4j
+@RestController
+@RequestMapping(value = "/api/v1/connectors", produces = MediaType.APPLICATION_JSON_VALUE)
+@RequiredArgsConstructor
+public class ConnectorRestController {
+
+    @Autowired private ChargePointRepository chargePointRepository;
+    @Autowired private ChargePointHelperService chargePointHelperService;
+
+    // -------------------------------------------------------------------------
+    // HTTP methods
+    // -------------------------------------------------------------------------
+
+    @ApiResponses(value = {
+        @ApiResponse(code = 200, message = "OK"),
+        @ApiResponse(code = 400, message = "Bad Request", response = ApiControllerAdvice.ApiErrorResponse.class),
+        @ApiResponse(code = 401, message = "Unauthorized", response = ApiControllerAdvice.ApiErrorResponse.class),
+        @ApiResponse(code = 500, message = "Internal Server Error",
+                response = ApiControllerAdvice.ApiErrorResponse.class)}
+    )
+    @GetMapping(value = "")
+    @ResponseBody
+    public ApiConnectorList getConnectors(@Valid ConnectorStatusForm queryParams) {
+        ApiConnectorList conList = new ApiConnectorList();
+        conList.setChargeBoxList(chargePointRepository.getChargeBoxIds());
+
+        conList.setIsFiltered(isFilterd(queryParams));
+        List<ConnectorStatus> latestList = chargePointHelperService.getChargePointConnectorStatus(queryParams);
+        List<ConnectorStatus> sortedList;
+        if (queryParams.getStrategy() == ConnectorStatusForm.Strategy.PreferZero) {
+            sortedList = ConnectorStatusFilter.filterAndPreferZero(latestList);
+        } else {
+            sortedList = ConnectorStatusFilter.filterAndPreferOthersWithStatusOfZero(latestList);
+        }
+        conList.setConnectors(sortedList);
+        return conList;
+    }
+
+    @ApiResponses(value = {
+        @ApiResponse(code = 200, message = "OK"),
+        @ApiResponse(code = 400, message = "Bad Request", response = ApiControllerAdvice.ApiErrorResponse.class),
+        @ApiResponse(code = 401, message = "Unauthorized", response = ApiControllerAdvice.ApiErrorResponse.class),
+        @ApiResponse(code = 500, message = "Internal Server Error",
+                response = ApiControllerAdvice.ApiErrorResponse.class)}
+    )
+    @GetMapping(value = "OCPP_JSON_STATUS")
+    @ResponseBody
+    public List<OcppJsonStatus> getOcppJsonStatus() {
+        return chargePointHelperService.getOcppJsonStatus();
+    }
+
+    // -------------------------------------------------------------------------
+    // Helpers
+    // -------------------------------------------------------------------------
+
+    private Boolean isFilterd(ConnectorStatusForm queryParams) {
+        if (!isNull(queryParams)) {
+            if (!isNull(queryParams.getChargeBoxId())) {
+                if (!queryParams.getChargeBoxId().isBlank()) {
+                    return true;
+                }
+            }
+            if (!isNull(queryParams.getStatus())) {
+                if (!queryParams.getStatus().isBlank()) {
+                    return true;
+                }
+            }
+        }
+        return false;
+    }
+}