Move Battery Swapping to a dedicated function

Move the Battery Swapping messages to a dedicated function, in line with
the OCPP 2.1 specification which has a dedicated chapter for these.

Author: robert-s-ubi

ocpp-v2/src/main/java/eu/chargetime/ocpp/v21/feature/function/ClientBatterySwappingEventHandler.java

@@ -0,0 +1,38 @@
+/*
+   ChargeTime.eu - Java-OCA-OCPP
+
+   MIT License
+
+   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:
+
+   The above copyright notice and this permission notice shall be included in all
+   copies or substantial portions of the Software.
+
+   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.
+*/
+
+package eu.chargetime.ocpp.v21.feature.function;
+
+import eu.chargetime.ocpp.v21.model.messages.*;
+
+/** Call back handler for client events of the BatterySwapping functional block. */
+public interface ClientBatterySwappingEventHandler {
+  /**
+   * Handle a {@link RequestBatterySwapRequest} and return a {@link RequestBatterySwapResponse}.
+   *
+   * @param request incoming {@link RequestBatterySwapRequest} to handle.
+   * @return outgoing {@link RequestBatterySwapResponse} to reply with.
+   */
+  RequestBatterySwapResponse handleRequestBatterySwapRequest(RequestBatterySwapRequest request);
+}

ocpp-v2/src/main/java/eu/chargetime/ocpp/v21/feature/function/ClientBatterySwappingFunction.java

@@ -0,0 +1,81 @@
+/*
+   ChargeTime.eu - Java-OCA-OCPP
+
+   MIT License
+
+   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:
+
+   The above copyright notice and this permission notice shall be included in all
+   copies or substantial portions of the Software.
+
+   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.
+*/
+
+package eu.chargetime.ocpp.v21.feature.function;
+
+import eu.chargetime.ocpp.feature.FunctionFeature;
+import eu.chargetime.ocpp.feature.function.Function;
+import eu.chargetime.ocpp.model.Confirmation;
+import eu.chargetime.ocpp.model.Request;
+import eu.chargetime.ocpp.v21.feature.*;
+import eu.chargetime.ocpp.v21.model.messages.*;
+import eu.chargetime.ocpp.v21.model.types.*;
+import java.util.ArrayList;
+import java.util.UUID;
+
+/** Class with client request creators and handlers for the BatterySwapping functional block. */
+public class ClientBatterySwappingFunction implements Function {
+
+  private final ClientBatterySwappingEventHandler eventHandler;
+  private final ArrayList<FunctionFeature> features;
+
+  public ClientBatterySwappingFunction(ClientBatterySwappingEventHandler eventHandler) {
+    this.eventHandler = eventHandler;
+    features = new ArrayList<>();
+    features.add(new BatterySwapFeature(null));
+    features.add(new RequestBatterySwapFeature(this));
+  }
+
+  @Override
+  public FunctionFeature[] getFeatureList() {
+    return features.toArray(new FunctionFeature[0]);
+  }
+
+  @Override
+  public Confirmation handleRequest(UUID sessionIndex, Request request) {
+    if (request instanceof RequestBatterySwapRequest) {
+      return eventHandler.handleRequestBatterySwapRequest((RequestBatterySwapRequest) request);
+    }
+    return null;
+  }
+
+  /**
+   * Create a client {@link BatterySwapRequest} with all required fields.
+   *
+   * @param batteryData batteryData
+   * @param eventType Battery in/out
+   * @param idToken A case insensitive identifier to use for the authorization and the type of
+   *     authorization to support multiple forms of identifiers.
+   * @param requestId RequestId to correlate BatteryIn/Out events and optional
+   *     RequestBatterySwapRequest.
+   * @return an instance of {@link BatterySwapRequest}
+   */
+  public BatterySwapRequest createBatterySwapRequest(
+      BatteryData[] batteryData,
+      BatterySwapEventEnum eventType,
+      IdToken idToken,
+      Integer requestId) {
+    return new BatterySwapRequest(batteryData, eventType, idToken, requestId);
+  }
+}

ocpp-v2/src/main/java/eu/chargetime/ocpp/v21/feature/function/ClientTransactionsEventHandler.java

@@ -36,12 +36,4 @@ public interface ClientTransactionsEventHandler {
    */
   GetTransactionStatusResponse handleGetTransactionStatusRequest(
       GetTransactionStatusRequest request);
-
-  /**
-   * Handle a {@link RequestBatterySwapRequest} and return a {@link RequestBatterySwapResponse}.
-   *
-   * @param request incoming {@link RequestBatterySwapRequest} to handle.
-   * @return outgoing {@link RequestBatterySwapResponse} to reply with.
-   */
-  RequestBatterySwapResponse handleRequestBatterySwapRequest(RequestBatterySwapRequest request);
 }

ocpp-v2/src/main/java/eu/chargetime/ocpp/v21/feature/function/ClientTransactionsFunction.java

@@ -44,9 +44,7 @@ public class ClientTransactionsFunction implements Function {
   public ClientTransactionsFunction(ClientTransactionsEventHandler eventHandler) {
     this.eventHandler = eventHandler;
     features = new ArrayList<>();
-    features.add(new BatterySwapFeature(null));
     features.add(new GetTransactionStatusFeature(this));
-    features.add(new RequestBatterySwapFeature(this));
     features.add(new TransactionEventFeature(null));
   }
 
@@ -59,31 +57,10 @@ public FunctionFeature[] getFeatureList() {
   public Confirmation handleRequest(UUID sessionIndex, Request request) {
     if (request instanceof GetTransactionStatusRequest) {
       return eventHandler.handleGetTransactionStatusRequest((GetTransactionStatusRequest) request);
-    } else if (request instanceof RequestBatterySwapRequest) {
-      return eventHandler.handleRequestBatterySwapRequest((RequestBatterySwapRequest) request);
     }
     return null;
   }
 
-  /**
-   * Create a client {@link BatterySwapRequest} with all required fields.
-   *
-   * @param batteryData batteryData
-   * @param eventType Battery in/out
-   * @param idToken A case insensitive identifier to use for the authorization and the type of
-   *     authorization to support multiple forms of identifiers.
-   * @param requestId RequestId to correlate BatteryIn/Out events and optional
-   *     RequestBatterySwapRequest.
-   * @return an instance of {@link BatterySwapRequest}
-   */
-  public BatterySwapRequest createBatterySwapRequest(
-      BatteryData[] batteryData,
-      BatterySwapEventEnum eventType,
-      IdToken idToken,
-      Integer requestId) {
-    return new BatterySwapRequest(batteryData, eventType, idToken, requestId);
-  }
-
   /**
    * Create a client {@link TransactionEventRequest} with all required fields.
    *

ocpp-v2/src/main/java/eu/chargetime/ocpp/v21/feature/function/ServerBatterySwappingEventHandler.java

@@ -0,0 +1,40 @@
+/*
+   ChargeTime.eu - Java-OCA-OCPP
+
+   MIT License
+
+   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:
+
+   The above copyright notice and this permission notice shall be included in all
+   copies or substantial portions of the Software.
+
+   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.
+*/
+
+package eu.chargetime.ocpp.v21.feature.function;
+
+import eu.chargetime.ocpp.v21.model.messages.*;
+import java.util.UUID;
+
+/** Call back handler for server events of the BatterySwapping functional block. */
+public interface ServerBatterySwappingEventHandler {
+  /**
+   * Handle a {@link BatterySwapRequest} and return a {@link BatterySwapResponse}.
+   *
+   * @param sessionIndex identifier of the session on which the request was received.
+   * @param request incoming {@link BatterySwapRequest} to handle.
+   * @return outgoing {@link BatterySwapResponse} to reply with.
+   */
+  BatterySwapResponse handleBatterySwapRequest(UUID sessionIndex, BatterySwapRequest request);
+}

ocpp-v2/src/main/java/eu/chargetime/ocpp/v21/feature/function/ServerBatterySwappingFunction.java

@@ -0,0 +1,75 @@
+/*
+   ChargeTime.eu - Java-OCA-OCPP
+
+   MIT License
+
+   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:
+
+   The above copyright notice and this permission notice shall be included in all
+   copies or substantial portions of the Software.
+
+   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.
+*/
+
+package eu.chargetime.ocpp.v21.feature.function;
+
+import eu.chargetime.ocpp.feature.FunctionFeature;
+import eu.chargetime.ocpp.feature.function.Function;
+import eu.chargetime.ocpp.model.Confirmation;
+import eu.chargetime.ocpp.model.Request;
+import eu.chargetime.ocpp.v21.feature.*;
+import eu.chargetime.ocpp.v21.model.messages.*;
+import eu.chargetime.ocpp.v21.model.types.*;
+import java.util.ArrayList;
+import java.util.UUID;
+
+/** Class with server request creators and handlers for the BatterySwapping functional block. */
+public class ServerBatterySwappingFunction implements Function {
+
+  private final ServerBatterySwappingEventHandler eventHandler;
+  private final ArrayList<FunctionFeature> features;
+
+  public ServerBatterySwappingFunction(ServerBatterySwappingEventHandler eventHandler) {
+    this.eventHandler = eventHandler;
+    features = new ArrayList<>();
+    features.add(new BatterySwapFeature(this));
+    features.add(new RequestBatterySwapFeature(null));
+  }
+
+  @Override
+  public FunctionFeature[] getFeatureList() {
+    return features.toArray(new FunctionFeature[0]);
+  }
+
+  @Override
+  public Confirmation handleRequest(UUID sessionIndex, Request request) {
+    if (request instanceof BatterySwapRequest) {
+      return eventHandler.handleBatterySwapRequest(sessionIndex, (BatterySwapRequest) request);
+    }
+    return null;
+  }
+
+  /**
+   * Create a server {@link RequestBatterySwapRequest} with all required fields.
+   *
+   * @param idToken A case insensitive identifier to use for the authorization and the type of
+   *     authorization to support multiple forms of identifiers.
+   * @param requestId Request id to match with BatterySwapRequest.
+   * @return an instance of {@link RequestBatterySwapRequest}
+   */
+  public RequestBatterySwapRequest createRequestBatterySwapRequest(
+      IdToken idToken, Integer requestId) {
+    return new RequestBatterySwapRequest(idToken, requestId);
+  }
+}

ocpp-v2/src/main/java/eu/chargetime/ocpp/v21/feature/function/ServerTransactionsEventHandler.java

@@ -29,15 +29,6 @@ of this software and associated documentation files (the "Software"), to deal
 
 /** Call back handler for server events of the Transactions functional block. */
 public interface ServerTransactionsEventHandler {
-  /**
-   * Handle a {@link BatterySwapRequest} and return a {@link BatterySwapResponse}.
-   *
-   * @param sessionIndex identifier of the session on which the request was received.
-   * @param request incoming {@link BatterySwapRequest} to handle.
-   * @return outgoing {@link BatterySwapResponse} to reply with.
-   */
-  BatterySwapResponse handleBatterySwapRequest(UUID sessionIndex, BatterySwapRequest request);
-
   /**
    * Handle a {@link TransactionEventRequest} and return a {@link TransactionEventResponse}.
    *

ocpp-v2/src/main/java/eu/chargetime/ocpp/v21/feature/function/ServerTransactionsFunction.java

@@ -43,9 +43,7 @@ public class ServerTransactionsFunction implements Function {
   public ServerTransactionsFunction(ServerTransactionsEventHandler eventHandler) {
     this.eventHandler = eventHandler;
     features = new ArrayList<>();
-    features.add(new BatterySwapFeature(this));
     features.add(new GetTransactionStatusFeature(null));
-    features.add(new RequestBatterySwapFeature(null));
     features.add(new TransactionEventFeature(this));
   }
 
@@ -56,9 +54,7 @@ public FunctionFeature[] getFeatureList() {
 
   @Override
   public Confirmation handleRequest(UUID sessionIndex, Request request) {
-    if (request instanceof BatterySwapRequest) {
-      return eventHandler.handleBatterySwapRequest(sessionIndex, (BatterySwapRequest) request);
-    } else if (request instanceof TransactionEventRequest) {
+    if (request instanceof TransactionEventRequest) {
       return eventHandler.handleTransactionEventRequest(
           sessionIndex, (TransactionEventRequest) request);
     }
@@ -73,17 +69,4 @@ public Confirmation handleRequest(UUID sessionIndex, Request request) {
   public GetTransactionStatusRequest createGetTransactionStatusRequest() {
     return new GetTransactionStatusRequest();
   }
-
-  /**
-   * Create a server {@link RequestBatterySwapRequest} with all required fields.
-   *
-   * @param idToken A case insensitive identifier to use for the authorization and the type of
-   *     authorization to support multiple forms of identifiers.
-   * @param requestId Request id to match with BatterySwapRequest.
-   * @return an instance of {@link RequestBatterySwapRequest}
-   */
-  public RequestBatterySwapRequest createRequestBatterySwapRequest(
-      IdToken idToken, Integer requestId) {
-    return new RequestBatterySwapRequest(idToken, requestId);
-  }
 }