Merge pull request #14 from RWTH-i5-IDSG/master

merge

Author: JavaIsJavaScript

.travis.yml

@@ -17,7 +17,7 @@ before_script:
 # start the actual build
 script: 
         - mvn -Dmaven.javadoc.skip=true clean package -Ptest -B -V
-        - java -Djava.net.preferIPv4Stack=true -jar target/steve-*.jar &
+        - java -Djava.net.preferIPv4Stack=true -jar target/steve.jar &
         - sleep 30
         - 'grep -C 50 -e "Exception: " ~/logs/steve.log && exit 255 || true'
         - elinks -dump -no-references http://localhost:8080/steve/manager/signin

README.md

@@ -81,7 +81,7 @@ SteVe is designed to run standalone, a java servlet container / web server (e.g.
     To start the application run (please do not run SteVe as root):
 
     ```
-    # java -jar target/steve-X.X.X.jar
+    # java -jar target/steve.jar
     ```
 
 # First Steps

pom.xml

@@ -172,6 +172,7 @@
                             <goal>shade</goal>
                         </goals>
                         <configuration>
+                            <finalName>${project.artifactId}</finalName>
                             <minimizeJar>false</minimizeJar>
                             <createDependencyReducedPom>false</createDependencyReducedPom>
                             <transformers>

src/main/java/de/rwth/idsg/steve/SteveConfiguration.java

@@ -14,27 +14,27 @@ public enum SteveConfiguration {
     CONFIG;
 
     // Root mapping for Spring
-    private String springMapping = "/";
+    private final String springMapping = "/";
     // Web frontend
-    private String springManagerMapping = "/manager/*";
+    private final String springManagerMapping = "/manager/*";
     // Mapping for CXF SOAP services
-    private String cxfMapping = "/services/*";
+    private final String cxfMapping = "/services/*";
     // Dummy service path
-    private String routerEndpointPath = "/CentralSystemService";
+    private final String routerEndpointPath = "/CentralSystemService";
     // Time zone for the application and database connections
-    private String timeZoneId = "UTC";  // or ZoneId.systemDefault().getId();
+    private final String timeZoneId = "UTC";  // or ZoneId.systemDefault().getId();
 
     // -------------------------------------------------------------------------
     // main.properties
     // -------------------------------------------------------------------------
 
-    private String contextPath;
-    private String steveVersion;
-    private ApplicationProfile profile;
-    private Ocpp ocpp;
-    private Auth auth;
-    private DB db;
-    private Jetty jetty;
+    private final String contextPath;
+    private final String steveVersion;
+    private final ApplicationProfile profile;
+    private final Ocpp ocpp;
+    private final Auth auth;
+    private final DB db;
+    private final Jetty jetty;
 
     SteveConfiguration() {
         PropertiesFileLoader p = new PropertiesFileLoader("main.properties");
@@ -103,43 +103,43 @@ private void validate() {
     // Jetty configuration
     @Builder @Getter
     public static class Jetty {
-        private String serverHost;
-        private boolean gzipEnabled;
+        private final String serverHost;
+        private final boolean gzipEnabled;
 
         // HTTP
-        private boolean httpEnabled;
-        private int httpPort;
+        private final boolean httpEnabled;
+        private final int httpPort;
 
         // HTTPS
-        private boolean httpsEnabled;
-        private int httpsPort;
-        private String keyStorePath;
-        private String keyStorePassword;
+        private final boolean httpsEnabled;
+        private final int httpsPort;
+        private final String keyStorePath;
+        private final String keyStorePassword;
     }
 
     // Database configuration
     @Builder @Getter
     public static class DB {
-        private String ip;
-        private int port;
-        private String schema;
-        private String userName;
-        private String password;
-        private boolean sqlLogging;
+        private final String ip;
+        private final int port;
+        private final String schema;
+        private final String userName;
+        private final String password;
+        private final boolean sqlLogging;
     }
 
     // Credentials for Web interface access
     @Builder @Getter
     public static class Auth {
-        private String userName;
-        private String password;
+        private final String userName;
+        private final String password;
     }
 
     // OCPP-related configuration
     @Builder @Getter
     public static class Ocpp {
-        private boolean autoRegisterUnknownStations;
-        private WsSessionSelectStrategyEnum wsSessionSelectStrategy;
+        private final boolean autoRegisterUnknownStations;
+        private final WsSessionSelectStrategyEnum wsSessionSelectStrategy;
     }
 
 }

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

@@ -4,8 +4,6 @@
 import de.rwth.idsg.steve.repository.dto.ChargePointSelect;
 import de.rwth.idsg.steve.utils.StringUtils;
 import de.rwth.idsg.steve.web.dto.ocpp.ChargePointSelection;
-import de.rwth.idsg.steve.web.dto.task.RequestResult;
-import de.rwth.idsg.steve.web.dto.task.RequestTaskOrigin;
 import lombok.AccessLevel;
 import lombok.Getter;
 import org.joda.time.DateTime;
@@ -32,7 +30,7 @@ public abstract class CommunicationTask<S extends ChargePointSelection, RESPONSE
 
     private final OcppVersion ocppVersion;
     private final String operationName;
-    private final RequestTaskOrigin origin;
+    private final TaskOrigin origin;
     private final String caller;
     protected final S params;
 
@@ -52,13 +50,13 @@ public abstract class CommunicationTask<S extends ChargePointSelection, RESPONSE
     private ArrayList<OcppCallback<RESPONSE>> callbackList = new ArrayList<>(2);
 
     public CommunicationTask(OcppVersion ocppVersion, S params) {
-        this(ocppVersion, params, RequestTaskOrigin.INTERNAL, "SteVe");
+        this(ocppVersion, params, TaskOrigin.INTERNAL, "SteVe");
     }
 
     /**
      * Do not expose the constructor, make it package-private
      */
-    CommunicationTask(OcppVersion ocppVersion, S params, RequestTaskOrigin origin, String caller) {
+    CommunicationTask(OcppVersion ocppVersion, S params, TaskOrigin origin, String caller) {
         List<ChargePointSelect> cpsList = params.getChargePointSelectList();
 
         this.ocppVersion = ocppVersion;

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

@@ -15,7 +15,7 @@ public interface OcppCallback<T> {
 
     /**
      * Relevant to WebSocket/JSON transport: Even though we have an error, this object is still a valid response from
-     * charge point and RequestTask should treat it as such. {@link CommunicationTask#addNewError(String, String)}
+     * charge point and the implementation should treat it as such. {@link CommunicationTask#addNewError(String, String)}
      * should be used when the request could not be delivered and there is a Java exception.
      */
     void success(String chargeBoxId, OcppJsonError error);

src/main/java/de/rwth/idsg/steve/web/dto/task/RequestResult.java renamed to src/main/java/de/rwth/idsg/steve/ocpp/RequestResult.java

@@ -1,4 +1,4 @@
-package de.rwth.idsg.steve.web.dto.task;
+package de.rwth.idsg.steve.ocpp;
 
 import lombok.Getter;
 import lombok.Setter;

src/main/java/de/rwth/idsg/steve/web/dto/task/RequestTaskOrigin.java renamed to src/main/java/de/rwth/idsg/steve/ocpp/TaskOrigin.java

@@ -1,4 +1,4 @@
-package de.rwth.idsg.steve.web.dto.task;
+package de.rwth.idsg.steve.ocpp;
 
 import lombok.RequiredArgsConstructor;
 
@@ -7,7 +7,7 @@
  * @since 23.11.2015
  */
 @RequiredArgsConstructor
-public enum RequestTaskOrigin {
+public enum TaskOrigin {
 
     // When the action was triggered by SteVe internally (e.g. by the admin/user)
     INTERNAL,

src/main/java/de/rwth/idsg/steve/ocpp/converter/Server15to16Impl.java

@@ -229,10 +229,11 @@ public DataTransferResponse convertResponse(ocpp.cs._2015._10.DataTransferRespon
      * but something else might make more sense at this place
      */
     private static ChargePointStatus customMapStatus(ocpp.cs._2012._06.ChargePointStatus status) {
-        if (status.equals(ocpp.cs._2012._06.ChargePointStatus.OCCUPIED)) {
-            return ChargePointStatus.CHARGING;
-        } else {
-            return ChargePointStatus.fromValue(status.value());
+        switch (status) {
+            case OCCUPIED:
+                return ChargePointStatus.CHARGING;
+            default:
+                return ChargePointStatus.fromValue(status.value());
         }
     }
 
@@ -241,10 +242,27 @@ private static ChargePointStatus customMapStatus(ocpp.cs._2012._06.ChargePointSt
      * Update: According to the 1.6 specification, MODE_3_ERROR was simply renamed to EV_COMMUNICATION_ERROR
      */
     private static ChargePointErrorCode customMapErrorCode(ocpp.cs._2012._06.ChargePointErrorCode errorCode15) {
-        if (errorCode15.equals(ocpp.cs._2012._06.ChargePointErrorCode.MODE_3_ERROR)) {
-            return ChargePointErrorCode.EV_COMMUNICATION_ERROR;
-        } else {
-            return ChargePointErrorCode.fromValue(errorCode15.value());
+        switch (errorCode15) {
+            case MODE_3_ERROR:
+                return ChargePointErrorCode.EV_COMMUNICATION_ERROR;
+            default:
+                return ChargePointErrorCode.fromValue(errorCode15.value());
+        }
+    }
+
+    /**
+     * AMP and VOLT are shortened to A and V, respectively.
+     *
+     * https://github.com/RWTH-i5-IDSG/steve/issues/59
+     */
+    private static UnitOfMeasure convertUnit(ocpp.cs._2012._06.UnitOfMeasure unit) {
+        switch (unit) {
+            case AMP:
+                return UnitOfMeasure.A;
+            case VOLT:
+                return UnitOfMeasure.V;
+            default:
+                return UnitOfMeasure.fromValue(unit.value());
         }
     }
 
@@ -268,7 +286,7 @@ private static SampledValue toOcpp16SampledValue(ocpp.cs._2012._06.MeterValue.Va
                 .withFormat(f.isSetFormat() ? ValueFormat.fromValue(f.getFormat().value()) : null)
                 .withLocation(f.isSetLocation() ? Location.fromValue(f.getLocation().value()) : null)
                 .withMeasurand(f.isSetMeasurand() ? Measurand.fromValue(f.getMeasurand().value()) : null)
-                .withUnit(f.isSetUnit() ? UnitOfMeasure.fromValue(f.getUnit().value()) : null)
+                .withUnit(f.isSetUnit() ? convertUnit(f.getUnit()) : null)
                 .withValue(f.getValue());
     }
 
@@ -284,12 +302,9 @@ private static MeterValue toOcpp16MeterValue(ocpp.cs._2012._06.MeterValue e) {
     }
 
     private static List<MeterValue> toOcpp16TransactionData(List<TransactionData> transactionData) {
-        List<ocpp.cs._2012._06.MeterValue> combinedList = transactionData.stream()
-                                                                         .flatMap(data -> data.getValues().stream())
-                                                                         .collect(Collectors.toList());
-
-        return combinedList.stream()
-                           .map(Server15to16Impl::toOcpp16MeterValue)
-                           .collect(Collectors.toList());
+        return transactionData.stream()
+                              .flatMap(data -> data.getValues().stream())
+                              .map(Server15to16Impl::toOcpp16MeterValue)
+                              .collect(Collectors.toList());
     }
 }

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

@@ -82,7 +82,7 @@ private void handleTextMessage(WebSocketSession session, TextMessage webSocketMe
         String incomingString = webSocketMessage.getPayload();
         String chargeBoxId = getChargeBoxId(session);
 
-        log.info("[chargeBoxId={}, sessionId={}] Received message: {}", chargeBoxId, session.getId(), incomingString);
+        WebSocketLogger.receivedText(chargeBoxId, session, incomingString);
 
         CommunicationContext context = new CommunicationContext(session, chargeBoxId);
         context.setIncomingString(incomingString);
@@ -91,15 +91,17 @@ private void handleTextMessage(WebSocketSession session, TextMessage webSocketMe
     }
 
     private void handlePongMessage(WebSocketSession session) {
-        log.debug("[id={}] Received pong message", session.getId());
+        WebSocketLogger.receivedPong(getChargeBoxId(session), session);
 
         // TODO: Not sure about the following. Should update DB? Should call directly repo?
         ocppServerRepository.updateChargeboxHeartbeat(getChargeBoxId(session), DateTime.now());
     }
 
     @Override
     public void afterConnectionEstablished(WebSocketSession session) throws Exception {
-        log.info("New connection established: {}", session);
+        String chargeBoxId = getChargeBoxId(session);
+
+        WebSocketLogger.connected(chargeBoxId, session);
 
         // Just to keep the connection alive, such that the servers do not close
         // the connection because of a idle timeout, we ping-pong at fixed intervals.
@@ -109,8 +111,6 @@ public void afterConnectionEstablished(WebSocketSession session) throws Exceptio
                 WebSocketConfiguration.PING_INTERVAL,
                 TimeUnit.MINUTES);
 
-        String chargeBoxId = getChargeBoxId(session);
-
         futureResponseContextStore.addSession(session);
 
         int sizeBeforeAdd;
@@ -129,10 +129,10 @@ public void afterConnectionEstablished(WebSocketSession session) throws Exceptio
 
     @Override
     public void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) throws Exception {
-        log.warn("[id={}] Connection was closed, status: {}", session.getId(), closeStatus);
-
         String chargeBoxId = getChargeBoxId(session);
 
+        WebSocketLogger.closed(chargeBoxId, session, closeStatus);
+
         futureResponseContextStore.removeSession(session);
 
         int sizeAfterRemove;

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

@@ -26,11 +26,10 @@ public class FutureResponseContextStoreImpl implements FutureResponseContextStor
 
     @Override
     public void addSession(WebSocketSession session) {
-        Map<String, FutureResponseContext> contextMap = lookupTable.get(session);
-        if (contextMap == null) {
-            log.debug("Creating new store for sessionId '{}'", session.getId());
-            lookupTable.put(session, new ConcurrentHashMap<>());
-        }
+        lookupTable.computeIfAbsent(session, webSocketSession -> {
+            log.debug("Creating new store for sessionId '{}'", webSocketSession.getId());
+            return new ConcurrentHashMap<>();
+        });
     }
 
     @Override

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

@@ -15,9 +15,9 @@
 public interface SessionContextStore {
     void add(String chargeBoxId, WebSocketSession session, ScheduledFuture pingSchedule);
     void remove(String chargeBoxId, WebSocketSession session);
+    WebSocketSession getSession(String chargeBoxId);
     int getSize(String chargeBoxId);
+    int getNumberOfChargeBoxes();
     List<String> getChargeBoxIdList();
     Map<String, Deque<SessionContext>> getACopy();
-    int getNumberOfChargeBoxes();
-    WebSocketSession getSession(String chargeBoxId);
 }