Merge pull request #1817 from steve-community/refactor-constructor-injection

Refactor constructor injection

Author: goekay

src/main/java/de/rwth/idsg/steve/config/OcppConfiguration.java

@@ -20,7 +20,9 @@
 
 import de.rwth.idsg.steve.ocpp.soap.LoggingFeatureProxy;
 import de.rwth.idsg.steve.ocpp.soap.MediatorInInterceptor;
+import de.rwth.idsg.steve.ocpp.soap.MessageHeaderInterceptor;
 import de.rwth.idsg.steve.ocpp.soap.MessageIdInterceptor;
+import lombok.RequiredArgsConstructor;
 import org.apache.cxf.Bus;
 import org.apache.cxf.bus.spring.SpringBus;
 import org.apache.cxf.common.logging.LogUtils;
@@ -29,9 +31,6 @@
 import org.apache.cxf.interceptor.Interceptor;
 import org.apache.cxf.jaxws.JaxWsServerFactoryBean;
 import org.apache.cxf.message.Message;
-import org.apache.cxf.phase.PhaseInterceptor;
-import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.beans.factory.annotation.Qualifier;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 
@@ -50,20 +49,18 @@
  * @author Sevket Goekay <[email protected]>
  * @since 18.11.2014
  */
+@RequiredArgsConstructor
 @Configuration
 public class OcppConfiguration {
 
     static {
         LogUtils.setLoggerClass(Slf4jLogger.class);
     }
 
-    @Autowired private ocpp.cs._2010._08.CentralSystemService ocpp12Server;
-    @Autowired private ocpp.cs._2012._06.CentralSystemService ocpp15Server;
-    @Autowired private ocpp.cs._2015._10.CentralSystemService ocpp16Server;
-
-    @Autowired
-    @Qualifier("MessageHeaderInterceptor")
-    private PhaseInterceptor<Message> messageHeaderInterceptor;
+    private final ocpp.cs._2010._08.CentralSystemService ocpp12Server;
+    private final ocpp.cs._2012._06.CentralSystemService ocpp15Server;
+    private final ocpp.cs._2015._10.CentralSystemService ocpp16Server;
+    private final MessageHeaderInterceptor messageHeaderInterceptor;
 
     @PostConstruct
     public void init() {

src/main/java/de/rwth/idsg/steve/config/WebSocketConfiguration.java

@@ -23,32 +23,31 @@
 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.service.ChargePointHelperService;
+import de.rwth.idsg.steve.service.ChargePointRegistrationService;
+import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
-import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.web.socket.config.annotation.EnableWebSocket;
 import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
 import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;
 import org.springframework.web.socket.server.support.DefaultHandshakeHandler;
 
 import java.time.Duration;
-import java.util.concurrent.TimeUnit;
 
 /**
  * @author Sevket Goekay <[email protected]>
  * @since 11.03.2015
  */
+@RequiredArgsConstructor
 @EnableWebSocket
 @Configuration
 @Slf4j
 public class WebSocketConfiguration implements WebSocketConfigurer {
 
-    @Autowired private ChargePointHelperService chargePointHelperService;
-
-    @Autowired private Ocpp12WebSocketEndpoint ocpp12WebSocketEndpoint;
-    @Autowired private Ocpp15WebSocketEndpoint ocpp15WebSocketEndpoint;
-    @Autowired private Ocpp16WebSocketEndpoint ocpp16WebSocketEndpoint;
+    private final ChargePointRegistrationService chargePointRegistrationService;
+    private final Ocpp12WebSocketEndpoint ocpp12WebSocketEndpoint;
+    private final Ocpp15WebSocketEndpoint ocpp15WebSocketEndpoint;
+    private final Ocpp16WebSocketEndpoint ocpp16WebSocketEndpoint;
 
     public static final String PATH_INFIX = "/websocket/CentralSystemService/";
     public static final Duration PING_INTERVAL = Duration.ofMinutes(15);
@@ -57,11 +56,10 @@ public class WebSocketConfiguration implements WebSocketConfigurer {
 
     @Override
     public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
-
         OcppWebSocketHandshakeHandler handshakeHandler = new OcppWebSocketHandshakeHandler(
             new DefaultHandshakeHandler(),
             Lists.newArrayList(ocpp16WebSocketEndpoint, ocpp15WebSocketEndpoint, ocpp12WebSocketEndpoint),
-            chargePointHelperService
+            chargePointRegistrationService
         );
 
         registry.addHandler(handshakeHandler.getDummyWebSocketHandler(), PATH_INFIX + "*")

src/main/java/de/rwth/idsg/steve/ocpp/soap/CentralSystemService12_SoapServer.java

@@ -24,6 +24,7 @@
 import de.rwth.idsg.steve.ocpp.converter.Server12to15Impl;
 import de.rwth.idsg.steve.ocpp.converter.Server15to16Impl;
 import de.rwth.idsg.steve.service.CentralSystemService16_Service;
+import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import ocpp.cs._2010._08.AuthorizeRequest;
 import ocpp.cs._2010._08.AuthorizeResponse;
@@ -44,7 +45,6 @@
 import ocpp.cs._2010._08.StatusNotificationResponse;
 import ocpp.cs._2010._08.StopTransactionRequest;
 import ocpp.cs._2010._08.StopTransactionResponse;
-import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Service;
 
 import jakarta.jws.WebService;
@@ -53,6 +53,7 @@
 import jakarta.xml.ws.Response;
 import jakarta.xml.ws.soap.Addressing;
 import jakarta.xml.ws.soap.SOAPBinding;
+
 import java.util.concurrent.Future;
 
 /**
@@ -61,6 +62,7 @@
  * @author Sevket Goekay <[email protected]>
  */
 @Slf4j
+@RequiredArgsConstructor
 @Service
 @Addressing(enabled = true, required = false)
 @BindingType(value = SOAPBinding.SOAP12HTTP_BINDING)
@@ -71,7 +73,7 @@
         endpointInterface = "ocpp.cs._2010._08.CentralSystemService")
 public class CentralSystemService12_SoapServer implements CentralSystemService {
 
-    @Autowired private CentralSystemService16_Service service;
+    private final CentralSystemService16_Service service;
 
     public BootNotificationResponse bootNotificationWithTransport(BootNotificationRequest parameters,
                                                                   String chargeBoxIdentity, OcppProtocol protocol) {

src/main/java/de/rwth/idsg/steve/ocpp/soap/CentralSystemService15_SoapServer.java

@@ -23,6 +23,7 @@
 import de.rwth.idsg.steve.ocpp.converter.Convert;
 import de.rwth.idsg.steve.ocpp.converter.Server15to16Impl;
 import de.rwth.idsg.steve.service.CentralSystemService16_Service;
+import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import ocpp.cs._2012._06.AuthorizeRequest;
 import ocpp.cs._2012._06.AuthorizeResponse;
@@ -45,7 +46,6 @@
 import ocpp.cs._2012._06.StatusNotificationResponse;
 import ocpp.cs._2012._06.StopTransactionRequest;
 import ocpp.cs._2012._06.StopTransactionResponse;
-import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Service;
 
 import jakarta.jws.WebService;
@@ -54,6 +54,7 @@
 import jakarta.xml.ws.Response;
 import jakarta.xml.ws.soap.Addressing;
 import jakarta.xml.ws.soap.SOAPBinding;
+
 import java.util.concurrent.Future;
 
 /**
@@ -62,6 +63,7 @@
  * @author Sevket Goekay <[email protected]>
  */
 @Slf4j
+@RequiredArgsConstructor
 @Service
 @Addressing(enabled = true, required = false)
 @BindingType(value = SOAPBinding.SOAP12HTTP_BINDING)
@@ -72,7 +74,7 @@
         endpointInterface = "ocpp.cs._2012._06.CentralSystemService")
 public class CentralSystemService15_SoapServer implements CentralSystemService {
 
-    @Autowired private CentralSystemService16_Service service;
+    private final CentralSystemService16_Service service;
 
     public BootNotificationResponse bootNotificationWithTransport(BootNotificationRequest parameters,
                                                                   String chargeBoxIdentity, OcppProtocol protocol) {

src/main/java/de/rwth/idsg/steve/ocpp/soap/CentralSystemService16_SoapServer.java

@@ -21,6 +21,7 @@
 import de.rwth.idsg.steve.ocpp.OcppProtocol;
 import de.rwth.idsg.steve.ocpp.OcppVersion;
 import de.rwth.idsg.steve.service.CentralSystemService16_Service;
+import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import ocpp.cs._2015._10.AuthorizeRequest;
 import ocpp.cs._2015._10.AuthorizeResponse;
@@ -43,7 +44,6 @@
 import ocpp.cs._2015._10.StatusNotificationResponse;
 import ocpp.cs._2015._10.StopTransactionRequest;
 import ocpp.cs._2015._10.StopTransactionResponse;
-import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Service;
 
 import jakarta.jws.WebService;
@@ -52,13 +52,15 @@
 import jakarta.xml.ws.Response;
 import jakarta.xml.ws.soap.Addressing;
 import jakarta.xml.ws.soap.SOAPBinding;
+
 import java.util.concurrent.Future;
 
 /**
  * @author Sevket Goekay <[email protected]>
  * @since 13.03.2018
  */
 @Slf4j
+@RequiredArgsConstructor
 @Service
 @Addressing(enabled = true, required = false)
 @BindingType(value = SOAPBinding.SOAP12HTTP_BINDING)
@@ -69,7 +71,7 @@
         endpointInterface = "ocpp.cs._2015._10.CentralSystemService")
 public class CentralSystemService16_SoapServer implements CentralSystemService {
 
-    @Autowired private CentralSystemService16_Service service;
+    private final CentralSystemService16_Service service;
 
     public BootNotificationResponse bootNotificationWithTransport(BootNotificationRequest parameters,
                                                                   String chargeBoxIdentity, OcppProtocol protocol) {

src/main/java/de/rwth/idsg/steve/ocpp/soap/ClientProvider.java

@@ -28,10 +28,10 @@
 import org.jetbrains.annotations.Nullable;
 import org.springframework.stereotype.Component;
 
-import jakarta.annotation.PostConstruct;
+import jakarta.xml.ws.soap.SOAPBinding;
+
 import javax.net.ssl.SSLContext;
 import javax.net.ssl.SSLSocketFactory;
-import jakarta.xml.ws.soap.SOAPBinding;
 
 import static de.rwth.idsg.steve.SteveConfiguration.CONFIG;
 
@@ -42,10 +42,9 @@
 @Component
 public class ClientProvider {
 
-    @Nullable private TLSClientParameters tlsClientParams;
+    @Nullable private final TLSClientParameters tlsClientParams;
 
-    @PostConstruct
-    private void init() {
+    public ClientProvider() {
         if (shouldInitSSL()) {
             tlsClientParams = new TLSClientParameters();
             tlsClientParams.setSSLSocketFactory(setupSSL());

src/main/java/de/rwth/idsg/steve/ocpp/soap/MessageHeaderInterceptor.java

@@ -22,7 +22,7 @@
 import de.rwth.idsg.steve.ocpp.OcppProtocol;
 import de.rwth.idsg.steve.repository.OcppServerRepository;
 import de.rwth.idsg.steve.repository.impl.ChargePointRepositoryImpl;
-import de.rwth.idsg.steve.service.ChargePointHelperService;
+import de.rwth.idsg.steve.service.ChargePointRegistrationService;
 import lombok.extern.slf4j.Slf4j;
 import ocpp.cs._2015._10.RegistrationStatus;
 import org.apache.cxf.binding.soap.Soap12;
@@ -37,7 +37,6 @@
 import org.apache.cxf.ws.addressing.AddressingProperties;
 import org.apache.cxf.ws.addressing.ContextUtils;
 import org.apache.cxf.ws.addressing.EndpointReferenceType;
-import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Component;
 
 import javax.xml.namespace.QName;
@@ -60,15 +59,20 @@
 @Component("MessageHeaderInterceptor")
 public class MessageHeaderInterceptor extends AbstractPhaseInterceptor<Message> {
 
-    @Autowired private OcppServerRepository ocppServerRepository;
-    @Autowired private ChargePointHelperService chargePointHelperService;
-    @Autowired private DelegatingTaskExecutor asyncTaskExecutor;
+    private final OcppServerRepository ocppServerRepository;
+    private final ChargePointRegistrationService chargePointRegistrationService;
+    private final DelegatingTaskExecutor asyncTaskExecutor;
 
     private static final String BOOT_OPERATION_NAME = "BootNotification";
     private static final String CHARGEBOX_ID_HEADER = "ChargeBoxIdentity";
 
-    public MessageHeaderInterceptor() {
+    public MessageHeaderInterceptor(OcppServerRepository ocppServerRepository,
+                                    ChargePointRegistrationService chargePointRegistrationService,
+                                    DelegatingTaskExecutor asyncTaskExecutor) {
         super(Phase.PRE_INVOKE);
+        this.ocppServerRepository = ocppServerRepository;
+        this.chargePointRegistrationService = chargePointRegistrationService;
+        this.asyncTaskExecutor = asyncTaskExecutor;
     }
 
     @Override
@@ -82,7 +86,7 @@ public void handleMessage(Message message) throws Fault {
         QName opName = message.getExchange().getBindingOperationInfo().getOperationInfo().getName();
 
         if (!BOOT_OPERATION_NAME.equals(opName.getLocalPart())) {
-            Optional<RegistrationStatus> status = chargePointHelperService.getRegistrationStatus(chargeBoxId);
+            Optional<RegistrationStatus> status = chargePointRegistrationService.getRegistrationStatus(chargeBoxId);
             boolean allow = status.isPresent() && status.get() != RegistrationStatus.REJECTED;
             if (!allow) {
                 throw createAuthFault(opName);

src/main/java/de/rwth/idsg/steve/ocpp/ws/AbstractWebSocketEndpoint.java

@@ -19,18 +19,21 @@
 package de.rwth.idsg.steve.ocpp.ws;
 
 import com.google.common.base.Strings;
-import de.rwth.idsg.steve.config.WebSocketConfiguration;
 import de.rwth.idsg.steve.config.DelegatingTaskScheduler;
+import de.rwth.idsg.steve.config.WebSocketConfiguration;
 import de.rwth.idsg.steve.ocpp.OcppTransport;
 import de.rwth.idsg.steve.ocpp.OcppVersion;
 import de.rwth.idsg.steve.ocpp.ws.data.CommunicationContext;
 import de.rwth.idsg.steve.ocpp.ws.data.SessionContext;
+import de.rwth.idsg.steve.ocpp.ws.pipeline.OcppCallHandler;
+import de.rwth.idsg.steve.ocpp.ws.pipeline.Deserializer;
 import de.rwth.idsg.steve.ocpp.ws.pipeline.IncomingPipeline;
 import de.rwth.idsg.steve.repository.OcppServerRepository;
 import de.rwth.idsg.steve.service.notification.OcppStationWebSocketConnected;
 import de.rwth.idsg.steve.service.notification.OcppStationWebSocketDisconnected;
 import org.joda.time.DateTime;
-import org.springframework.beans.factory.annotation.Autowired;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import org.springframework.context.ApplicationEventPublisher;
 import org.springframework.web.socket.BinaryMessage;
 import org.springframework.web.socket.CloseStatus;
@@ -53,31 +56,42 @@
  * @author Sevket Goekay <[email protected]>
  * @since 17.03.2015
  */
-public abstract class AbstractWebSocketEndpoint extends ConcurrentWebSocketHandler implements SubProtocolCapable {
-
-    @Autowired private DelegatingTaskScheduler asyncTaskScheduler;
-    @Autowired private OcppServerRepository ocppServerRepository;
-    @Autowired private FutureResponseContextStore futureResponseContextStore;
-    @Autowired private ApplicationEventPublisher applicationEventPublisher;
+public abstract class AbstractWebSocketEndpoint extends ConcurrentWebSocketHandler implements SubProtocolCapable, OcppCallHandler {
 
     public static final String CHARGEBOX_ID_KEY = "CHARGEBOX_ID_KEY";
 
+    private final DelegatingTaskScheduler asyncTaskScheduler;
+    private final OcppServerRepository ocppServerRepository;
+    private final FutureResponseContextStore futureResponseContextStore;
+    private final IncomingPipeline pipeline;
+
+    private final Logger log = LoggerFactory.getLogger(getClass());
     private final SessionContextStore sessionContextStore = new SessionContextStoreImpl();
     private final List<Consumer<String>> connectedCallbackList = new ArrayList<>();
     private final List<Consumer<String>> disconnectedCallbackList = new ArrayList<>();
     private final Object sessionContextLock = new Object();
 
-    private IncomingPipeline pipeline;
-
-    public abstract OcppVersion getVersion();
-
-    public void init(IncomingPipeline pipeline) {
-        this.pipeline = pipeline;
+    public AbstractWebSocketEndpoint(DelegatingTaskScheduler asyncTaskScheduler,
+                                     OcppServerRepository ocppServerRepository,
+                                     FutureResponseContextStore futureResponseContextStore,
+                                     ApplicationEventPublisher applicationEventPublisher,
+                                     AbstractTypeStore typeStore) {
+        this.asyncTaskScheduler = asyncTaskScheduler;
+        this.ocppServerRepository = ocppServerRepository;
+        this.futureResponseContextStore = futureResponseContextStore;
+        this.pipeline = new IncomingPipeline(new Deserializer(futureResponseContextStore, typeStore), this);
 
         connectedCallbackList.add((chargeBoxId) -> applicationEventPublisher.publishEvent(new OcppStationWebSocketConnected(chargeBoxId)));
         disconnectedCallbackList.add((chargeBoxId) -> applicationEventPublisher.publishEvent(new OcppStationWebSocketDisconnected(chargeBoxId)));
     }
 
+    public abstract OcppVersion getVersion();
+
+    @Override
+    public Logger getLogger() {
+        return log;
+    }
+
     @Override
     public List<String> getSubProtocols() {
         return Collections.singletonList(getVersion().getValue());