refactor: introduce ChargePointService

goekay · goekay · commit 097a9b25cedb · 2025-10-29T05:00:23.000+01:00
and encapsulate ChargePointRepository calls
diff --git a/src/main/java/de/rwth/idsg/steve/ocpp/soap/MessageHeaderInterceptor.java b/src/main/java/de/rwth/idsg/steve/ocpp/soap/MessageHeaderInterceptor.java
@@ -50,7 +50,7 @@
  * 2. Intercepts incoming OCPP messages to update the endpoint address ("From" field of the WS-A header) in DB.
  * And the absence of the field is not a deal breaker anymore. But, as a side effect, the user will not be able
  * to send commands to the charging station, since the DB call to list the charge points will filter it out. See
- * {@link ChargePointRepositoryImpl#getChargePointSelect(OcppProtocol, java.util.List)}.
+ * {@link ChargePointRepositoryImpl#getChargePointSelect(OcppProtocol, java.util.List, java.util.List)}.
  *
  * @author Sevket Goekay <sevketgokay@gmail.com>
  * @since 15.06.2015
diff --git a/src/main/java/de/rwth/idsg/steve/repository/ChargePointRepository.java b/src/main/java/de/rwth/idsg/steve/repository/ChargePointRepository.java
@@ -41,20 +41,12 @@ public interface ChargePointRepository {
 
     List<ChargePointSelect> getChargePointSelect(OcppProtocol protocol, List<String> inStatusFilter, List<String> chargeBoxIdFilter);
 
-    default List<ChargePointSelect> getChargePointSelect(OcppProtocol protocol, List<String> inStatusFilter) {
-        return getChargePointSelect(protocol, inStatusFilter, Collections.emptyList());
-    }
-
     List<String> getChargeBoxIds();
     Map<String, Integer> getChargeBoxIdPkPair(List<String> chargeBoxIdList);
 
     List<ChargePoint.Overview> getOverview(ChargePointQueryForm form);
     ChargePoint.Details getDetails(int chargeBoxPk);
 
-    default List<ConnectorStatus> getChargePointConnectorStatus() {
-        return getChargePointConnectorStatus(null);
-    }
-
     List<ConnectorStatus> getChargePointConnectorStatus(@Nullable ConnectorStatusForm form);
 
     List<Integer> getNonZeroConnectorIds(String chargeBoxId);
diff --git a/src/main/java/de/rwth/idsg/steve/service/ChargePointHelperService.java b/src/main/java/de/rwth/idsg/steve/service/ChargePointHelperService.java
@@ -26,7 +26,6 @@
 import de.rwth.idsg.steve.ocpp.ws.ocpp12.Ocpp12WebSocketEndpoint;
 import de.rwth.idsg.steve.ocpp.ws.ocpp15.Ocpp15WebSocketEndpoint;
 import de.rwth.idsg.steve.ocpp.ws.ocpp16.Ocpp16WebSocketEndpoint;
-import de.rwth.idsg.steve.repository.ChargePointRepository;
 import de.rwth.idsg.steve.repository.GenericRepository;
 import de.rwth.idsg.steve.repository.dto.ChargePointSelect;
 import de.rwth.idsg.steve.repository.dto.ConnectorStatus;
@@ -65,7 +64,7 @@ public class ChargePointHelperService {
     private final GenericRepository genericRepository;
 
     // SOAP-based charge points are stored in DB with an endpoint address
-    private final ChargePointRepository chargePointRepository;
+    private final ChargePointService chargePointService;
 
     // For WebSocket-based charge points, the active sessions are stored in memory
     private final Ocpp12WebSocketEndpoint ocpp12WebSocketEndpoint;
@@ -78,7 +77,7 @@ public Statistics getStats() {
         stats.setNumOcpp15JChargeBoxes(ocpp15WebSocketEndpoint.getNumberOfChargeBoxes());
         stats.setNumOcpp16JChargeBoxes(ocpp16WebSocketEndpoint.getNumberOfChargeBoxes());
 
-        List<ConnectorStatus> latestList = chargePointRepository.getChargePointConnectorStatus();
+        List<ConnectorStatus> latestList = chargePointService.getChargePointConnectorStatus();
         stats.setStatusCountMap(ConnectorStatusCountFilter.getStatusCountMap(latestList));
 
         return stats;
@@ -91,7 +90,7 @@ public List<ConnectorStatus> getChargePointConnectorStatus(ConnectorStatusForm p
 
         Set<String> connectedJsonChargeBoxIds = new HashSet<>(extractIds(Arrays.asList(ocpp12Map, ocpp15Map, ocpp16Map)));
 
-        List<ConnectorStatus> latestList = chargePointRepository.getChargePointConnectorStatus(params);
+        List<ConnectorStatus> latestList = chargePointService.getChargePointConnectorStatus(params);
 
         // iterate over JSON stations and mark disconnected ones
         // https://github.com/steve-community/steve/issues/355
@@ -112,7 +111,7 @@ public List<OcppJsonStatus> getOcppJsonStatus() {
         Map<String, Deque<SessionContext>> ocpp16Map = ocpp16WebSocketEndpoint.getACopy();
 
         List<String> idList = extractIds(Arrays.asList(ocpp12Map, ocpp15Map, ocpp16Map));
-        Map<String, Integer> primaryKeyLookup = chargePointRepository.getChargeBoxIdPkPair(idList);
+        Map<String, Integer> primaryKeyLookup = chargePointService.getChargeBoxIdPkPair(idList);
 
         DateTime now = DateTime.now();
         List<OcppJsonStatus> returnList = new ArrayList<>();
@@ -160,7 +159,7 @@ private List<ChargePointSelect> getChargePoints(OcppProtocol protocol, List<Regi
                                                   .map(RegistrationStatus::value)
                                                   .collect(Collectors.toList());
 
-        List<ChargePointSelect> returnList = chargePointRepository.getChargePointSelect(protocol, statusFilter, chargeBoxIdFilter);
+        List<ChargePointSelect> returnList = chargePointService.getChargePointSelect(protocol, statusFilter, chargeBoxIdFilter);
 
         // json stations
         //
diff --git a/src/main/java/de/rwth/idsg/steve/service/ChargePointRegistrationService.java b/src/main/java/de/rwth/idsg/steve/service/ChargePointRegistrationService.java
@@ -20,7 +20,6 @@
 
 import com.google.common.util.concurrent.Striped;
 import de.rwth.idsg.steve.config.SteveProperties;
-import de.rwth.idsg.steve.repository.ChargePointRepository;
 import de.rwth.idsg.steve.service.dto.UnidentifiedIncomingObject;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
@@ -45,7 +44,7 @@ public class ChargePointRegistrationService {
     private final SteveProperties steveProperties;
     private final Striped<Lock> isRegisteredLocks = Striped.lock(16);
 
-    private final ChargePointRepository chargePointRepository;
+    private final ChargePointService chargePointService;
 
     public List<UnidentifiedIncomingObject> getUnknownChargePoints() {
         return unknownChargePointService.getObjects();
@@ -71,7 +70,7 @@ public Optional<RegistrationStatus> getRegistrationStatus(String chargeBoxId) {
 
     private Optional<RegistrationStatus> getRegistrationStatusInternal(String chargeBoxId) {
         // 1. exit if already registered
-        Optional<String> status = chargePointRepository.getRegistrationStatus(chargeBoxId);
+        Optional<String> status = chargePointService.getRegistrationStatus(chargeBoxId);
         if (status.isPresent()) {
             try {
                 return Optional.ofNullable(RegistrationStatus.fromValue(status.get()));
@@ -89,7 +88,7 @@ private Optional<RegistrationStatus> getRegistrationStatusInternal(String charge
 
         // 3. chargeBoxId is unknown and auto-register is enabled. insert chargeBoxId
         try {
-            chargePointRepository.addChargePointList(Collections.singletonList(chargeBoxId));
+            chargePointService.addChargePointList(Collections.singletonList(chargeBoxId));
             log.warn("Auto-registered unknown chargebox '{}'", chargeBoxId);
             return Optional.of(RegistrationStatus.ACCEPTED); // default db value is accepted
         } catch (Exception e) {
diff --git a/src/main/java/de/rwth/idsg/steve/service/ChargePointService.java b/src/main/java/de/rwth/idsg/steve/service/ChargePointService.java
@@ -0,0 +1,101 @@
+/*
+ * SteVe - SteckdosenVerwaltung - https://github.com/steve-community/steve
+ * Copyright (C) 2013-2025 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.service;
+
+import de.rwth.idsg.steve.ocpp.OcppProtocol;
+import de.rwth.idsg.steve.repository.ChargePointRepository;
+import de.rwth.idsg.steve.repository.dto.ChargePoint;
+import de.rwth.idsg.steve.repository.dto.ChargePointSelect;
+import de.rwth.idsg.steve.repository.dto.ConnectorStatus;
+import de.rwth.idsg.steve.web.dto.ChargePointForm;
+import de.rwth.idsg.steve.web.dto.ChargePointQueryForm;
+import de.rwth.idsg.steve.web.dto.ConnectorStatusForm;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.jetbrains.annotations.Nullable;
+import org.springframework.stereotype.Service;
+
+import java.util.List;
+import java.util.Map;
+import java.util.Optional;
+
+/**
+ * @author Sevket Goekay <sevketgokay@gmail.com>
+ * @since 29.10.2025
+ */
+@Slf4j
+@Service
+@RequiredArgsConstructor
+public class ChargePointService {
+
+    private final ChargePointRepository chargePointRepository;
+
+    public Optional<String> getRegistrationStatus(String chargeBoxId) {
+        return chargePointRepository.getRegistrationStatus(chargeBoxId);
+    }
+
+    public List<ChargePointSelect> getChargePointSelect(OcppProtocol protocol, List<String> inStatusFilter, List<String> chargeBoxIdFilter) {
+        return chargePointRepository.getChargePointSelect(protocol, inStatusFilter, chargeBoxIdFilter);
+    }
+
+    public List<String> getChargeBoxIds() {
+        return chargePointRepository.getChargeBoxIds();
+    }
+
+    public Map<String, Integer> getChargeBoxIdPkPair(List<String> chargeBoxIdList) {
+        return chargePointRepository.getChargeBoxIdPkPair(chargeBoxIdList);
+    }
+
+    public List<ChargePoint.Overview> getOverview(ChargePointQueryForm form) {
+        return chargePointRepository.getOverview(form);
+    }
+
+    public ChargePoint.Details getDetails(int chargeBoxPk) {
+        return chargePointRepository.getDetails(chargeBoxPk);
+    }
+
+    public List<ConnectorStatus> getChargePointConnectorStatus() {
+        return getChargePointConnectorStatus(null);
+    }
+
+    public List<ConnectorStatus> getChargePointConnectorStatus(@Nullable ConnectorStatusForm form) {
+        return  chargePointRepository.getChargePointConnectorStatus(form);
+    }
+
+    public List<Integer> getNonZeroConnectorIds(String chargeBoxId) {
+        return chargePointRepository.getNonZeroConnectorIds(chargeBoxId);
+    }
+
+    public void addChargePointList(List<String> chargeBoxIdList) {
+        chargePointRepository.addChargePointList(chargeBoxIdList);
+    }
+
+    public int addChargePoint(ChargePointForm form) {
+        return chargePointRepository.addChargePoint(form);
+    }
+
+    public void updateChargePoint(ChargePointForm form) {
+        chargePointRepository.updateChargePoint(form);
+    }
+
+    public void deleteChargePoint(int chargeBoxPk) {
+        chargePointRepository.deleteChargePoint(chargeBoxPk);
+    }
+
+}
diff --git a/src/main/java/de/rwth/idsg/steve/web/controller/AjaxCallController.java b/src/main/java/de/rwth/idsg/steve/web/controller/AjaxCallController.java
@@ -21,8 +21,8 @@
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.ObjectMapper;
-import de.rwth.idsg.steve.repository.ChargePointRepository;
 import de.rwth.idsg.steve.repository.ReservationRepository;
+import de.rwth.idsg.steve.service.ChargePointService;
 import de.rwth.idsg.steve.service.TransactionService;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
@@ -34,7 +34,6 @@
 import org.springframework.web.bind.annotation.ResponseBody;
 
 import jakarta.servlet.http.HttpServletResponse;
-
 import java.io.IOException;
 import java.util.List;
 
@@ -54,7 +53,7 @@ public class AjaxCallController {
 
     private final ObjectMapper objectMapper = createMapper();
 
-    private final ChargePointRepository chargePointRepository;
+    private final ChargePointService chargePointService;
     private final TransactionService transactionService;
     private final ReservationRepository reservationRepository;
 
@@ -73,7 +72,7 @@ public class AjaxCallController {
     @RequestMapping(value = CONNECTOR_IDS_PATH)
     public void getConnectorIds(@PathVariable("chargeBoxId") String chargeBoxId,
                                 HttpServletResponse response) throws IOException {
-        String s = serializeArray(chargePointRepository.getNonZeroConnectorIds(chargeBoxId));
+        String s = serializeArray(chargePointService.getNonZeroConnectorIds(chargeBoxId));
         writeOutput(response, s);
     }
 
diff --git a/src/main/java/de/rwth/idsg/steve/web/controller/ChargePointsController.java b/src/main/java/de/rwth/idsg/steve/web/controller/ChargePointsController.java
@@ -19,9 +19,9 @@
 package de.rwth.idsg.steve.web.controller;
 
 import de.rwth.idsg.steve.ocpp.OcppProtocol;
-import de.rwth.idsg.steve.repository.ChargePointRepository;
 import de.rwth.idsg.steve.repository.dto.ChargePoint;
 import de.rwth.idsg.steve.service.ChargePointRegistrationService;
+import de.rwth.idsg.steve.service.ChargePointService;
 import de.rwth.idsg.steve.utils.ControllerHelper;
 import de.rwth.idsg.steve.utils.mapper.ChargePointDetailsMapper;
 import de.rwth.idsg.steve.web.dto.ChargePointBatchInsertForm;
@@ -38,7 +38,6 @@
 import org.springframework.web.bind.annotation.RequestMethod;
 
 import jakarta.validation.Valid;
-
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.List;
@@ -54,7 +53,7 @@
 @RequestMapping(value = "/manager/chargepoints")
 public class ChargePointsController {
 
-    protected final ChargePointRepository chargePointRepository;
+    protected final ChargePointService chargePointService;
     protected final ChargePointRegistrationService chargePointRegistrationService;
 
     protected static final String PARAMS = "params";
@@ -105,13 +104,13 @@ public String getQuery(@ModelAttribute(PARAMS) ChargePointQueryForm params, Mode
 
     private void initList(Model model, ChargePointQueryForm params) {
         model.addAttribute(PARAMS, params);
-        model.addAttribute("cpList", chargePointRepository.getOverview(params));
+        model.addAttribute("cpList", chargePointService.getOverview(params));
         model.addAttribute("unknownList", chargePointRegistrationService.getUnknownChargePoints());
     }
 
     @RequestMapping(value = DETAILS_PATH, method = RequestMethod.GET)
     public String getDetails(@PathVariable("chargeBoxPk") int chargeBoxPk, Model model) {
-        ChargePoint.Details cp = chargePointRepository.getDetails(chargeBoxPk);
+        ChargePoint.Details cp = chargePointService.getDetails(chargeBoxPk);
         ChargePointForm form = ChargePointDetailsMapper.mapToForm(cp);
 
         model.addAttribute("chargePointForm", form);
@@ -179,13 +178,13 @@ public String update(@Valid @ModelAttribute("chargePointForm") ChargePointForm c
             return "data-man/chargepointDetails";
         }
 
-        chargePointRepository.updateChargePoint(chargePointForm);
+        chargePointService.updateChargePoint(chargePointForm);
         return toOverview();
     }
 
     @RequestMapping(value = DELETE_PATH, method = RequestMethod.POST)
     public String delete(@PathVariable("chargeBoxPk") int chargeBoxPk) {
-        chargePointRepository.deleteChargePoint(chargeBoxPk);
+        chargePointService.deleteChargePoint(chargeBoxPk);
         return toOverview();
     }
 
@@ -235,12 +234,12 @@ private void setCommonAttributesForSingleAdd(Model model) {
     }
 
     private void add(ChargePointForm form) {
-        chargePointRepository.addChargePoint(form);
+        chargePointService.addChargePoint(form);
         chargePointRegistrationService.removeUnknown(Collections.singletonList(form.getChargeBoxId()));
     }
 
     private void add(List<String> idList) {
-        chargePointRepository.addChargePointList(idList);
+        chargePointService.addChargePointList(idList);
         chargePointRegistrationService.removeUnknown(idList);
     }
 }
diff --git a/src/main/java/de/rwth/idsg/steve/web/controller/ChargingProfilesController.java b/src/main/java/de/rwth/idsg/steve/web/controller/ChargingProfilesController.java
@@ -18,9 +18,9 @@
  */
 package de.rwth.idsg.steve.web.controller;
 
-import de.rwth.idsg.steve.repository.ChargePointRepository;
 import de.rwth.idsg.steve.repository.ChargingProfileRepository;
 import de.rwth.idsg.steve.repository.dto.ChargingProfile;
+import de.rwth.idsg.steve.service.ChargePointService;
 import de.rwth.idsg.steve.utils.mapper.ChargingProfileDetailsMapper;
 import de.rwth.idsg.steve.web.dto.ChargingProfileAssignmentQueryForm;
 import de.rwth.idsg.steve.web.dto.ChargingProfileForm;
@@ -45,7 +45,7 @@
 @RequestMapping(value = "/manager/chargingProfiles")
 public class ChargingProfilesController {
 
-    private final ChargePointRepository chargePointRepository;
+    private final ChargePointService chargePointService;
     private final ChargingProfileRepository repository;
 
     private static final String PARAMS = "params";
@@ -138,7 +138,7 @@ public String getDetails(@PathVariable("chargingProfilePk") int chargingProfileP
     public String getAssignments(@ModelAttribute(PARAMS) ChargingProfileAssignmentQueryForm form, Model model) {
         model.addAttribute(PARAMS, form);
         model.addAttribute("profileList", repository.getBasicInfo());
-        model.addAttribute("cpList", chargePointRepository.getChargeBoxIds());
+        model.addAttribute("cpList", chargePointService.getChargeBoxIds());
         model.addAttribute("assignments", repository.getAssignments(form));
         return "data-man/chargingProfileAssignments";
     }
diff --git a/src/main/java/de/rwth/idsg/steve/web/controller/HomeController.java b/src/main/java/de/rwth/idsg/steve/web/controller/HomeController.java
@@ -18,9 +18,9 @@
  */
 package de.rwth.idsg.steve.web.controller;
 
-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.service.ChargePointService;
 import de.rwth.idsg.steve.utils.ConnectorStatusCountFilter;
 import de.rwth.idsg.steve.utils.ConnectorStatusFilter;
 import de.rwth.idsg.steve.web.dto.ConnectorStatusForm;
@@ -43,7 +43,7 @@
 @RequestMapping(value = "/manager", method = RequestMethod.GET)
 public class HomeController {
 
-    private final ChargePointRepository chargePointRepository;
+    private final ChargePointService chargePointService;
     private final ChargePointHelperService chargePointHelperService;
 
     private static final String PARAMS = "params";
@@ -74,7 +74,7 @@ public String getConnectorStatus(Model model) {
 
     @RequestMapping(value = CONNECTOR_STATUS_QUERY_PATH)
     public String getConnectorStatusQuery(@ModelAttribute(PARAMS) ConnectorStatusForm params, Model model) {
-        model.addAttribute("cpList", chargePointRepository.getChargeBoxIds());
+        model.addAttribute("cpList", chargePointService.getChargeBoxIds());
         model.addAttribute("statusValues", ConnectorStatusCountFilter.ALL_STATUS_VALUES);
         model.addAttribute(PARAMS, params);
 
diff --git a/src/main/java/de/rwth/idsg/steve/web/controller/TransactionsReservationsController.java b/src/main/java/de/rwth/idsg/steve/web/controller/TransactionsReservationsController.java
diff --git a/src/test/java/de/rwth/idsg/steve/utils/__DatabasePreparer__.java b/src/test/java/de/rwth/idsg/steve/utils/__DatabasePreparer__.java

Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@`
`50`	`50`	`* 2. Intercepts incoming OCPP messages to update the endpoint address ("From" field of the WS-A header) in DB.`
`51`	`51`	`* And the absence of the field is not a deal breaker anymore. But, as a side effect, the user will not be able`
`52`	`52`	`* to send commands to the charging station, since the DB call to list the charge points will filter it out. See`
`53`		`- * {@link ChargePointRepositoryImpl#getChargePointSelect(OcppProtocol, java.util.List)}.`
	`53`	`+ * {@link ChargePointRepositoryImpl#getChargePointSelect(OcppProtocol, java.util.List, java.util.List)}.`
`54`	`54`	`*`
`55`	`55`	`* @author Sevket Goekay <[email protected]>`
`56`	`56`	`* @since 15.06.2015`