Filter import of rental data by pickup type

application/src/ext-test/java/org/opentripplanner/ext/smoovebikerental/SmooveBikeRentalDataSourceTest.java

@@ -7,6 +7,7 @@
 import java.util.List;
 import org.junit.jupiter.api.Test;
 import org.opentripplanner.service.vehiclerental.model.VehicleRentalPlace;
+import org.opentripplanner.updater.vehicle_rental.datasources.params.RentalPickupType;
 import org.opentripplanner.updater.spi.HttpHeaders;
 
 class SmooveBikeRentalDataSourceTest {
@@ -18,7 +19,8 @@ void makeStation() {
         "file:src/ext-test/resources/smoovebikerental/smoove.json",
         null,
         true,
-        HttpHeaders.empty()
+        HttpHeaders.empty(),
+        RentalPickupType.ALL
       )
     );
     assertTrue(source.update());
@@ -84,7 +86,8 @@ void makeStationWithoutOverloading() {
         "file:src/ext-test/resources/smoovebikerental/smoove.json",
         null,
         false,
-        HttpHeaders.empty()
+        HttpHeaders.empty(),
+        RentalPickupType.ALL
       )
     );
     assertTrue(source.update());

application/src/ext/java/org/opentripplanner/ext/smoovebikerental/SmooveBikeRentalDataSourceParameters.java

@@ -1,6 +1,8 @@
 package org.opentripplanner.ext.smoovebikerental;
 
+import java.util.Set;
 import javax.annotation.Nullable;
+import org.opentripplanner.updater.vehicle_rental.datasources.params.RentalPickupType;
 import org.opentripplanner.updater.spi.HttpHeaders;
 import org.opentripplanner.updater.vehicle_rental.VehicleRentalSourceType;
 import org.opentripplanner.updater.vehicle_rental.datasources.params.VehicleRentalDataSourceParameters;
@@ -12,7 +14,8 @@ public record SmooveBikeRentalDataSourceParameters(
   String url,
   String network,
   boolean overloadingAllowed,
-  HttpHeaders httpHeaders
+  HttpHeaders httpHeaders,
+  Set<RentalPickupType> rentalPickupTypes
 )
   implements VehicleRentalDataSourceParameters {
   /**
@@ -29,4 +32,9 @@ public String getNetwork(String defaultValue) {
   public VehicleRentalSourceType sourceType() {
     return VehicleRentalSourceType.SMOOVE;
   }
+
+  @Override
+  public boolean allowRentalType(RentalPickupType rentalPickupType) {
+    return rentalPickupTypes.contains(rentalPickupType);
+  }
 }

application/src/ext/java/org/opentripplanner/ext/vehiclerentalservicedirectory/VehicleRentalServiceDirectoryFetcher.java

@@ -18,6 +18,7 @@
 import org.opentripplanner.updater.spi.GraphUpdater;
 import org.opentripplanner.updater.vehicle_rental.VehicleRentalUpdater;
 import org.opentripplanner.updater.vehicle_rental.datasources.VehicleRentalDataSourceFactory;
+import org.opentripplanner.updater.vehicle_rental.datasources.params.RentalPickupType;
 import org.opentripplanner.updater.vehicle_rental.datasources.params.GbfsVehicleRentalDataSourceParameters;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -110,7 +111,9 @@ private static List<GbfsVehicleRentalDataSourceParameters> buildListOfNetworksFr
               networkName,
               networkParams.geofencingZones(),
               // overloadingAllowed - not part of GBFS, not supported here
-              false
+              false,
+              // rentalPickupType not supported
+              RentalPickupType.ALL
             )
           );
         } else {

application/src/main/java/org/opentripplanner/standalone/config/routerconfig/updaters/sources/VehicleRentalSourceFactory.java

@@ -1,16 +1,20 @@
 package org.opentripplanner.standalone.config.routerconfig.updaters.sources;
 
+import static org.opentripplanner.standalone.config.framework.json.EnumMapper.docEnumValueList;
 import static org.opentripplanner.standalone.config.framework.json.OtpVersion.V1_5;
 import static org.opentripplanner.standalone.config.framework.json.OtpVersion.V2_1;
 import static org.opentripplanner.standalone.config.framework.json.OtpVersion.V2_2;
 import static org.opentripplanner.standalone.config.framework.json.OtpVersion.V2_3;
+import static org.opentripplanner.standalone.config.framework.json.OtpVersion.V2_7;
 
+import java.util.Set;
 import org.opentripplanner.ext.smoovebikerental.SmooveBikeRentalDataSourceParameters;
 import org.opentripplanner.standalone.config.framework.json.NodeAdapter;
 import org.opentripplanner.standalone.config.routerconfig.updaters.HttpHeadersConfig;
 import org.opentripplanner.updater.spi.HttpHeaders;
 import org.opentripplanner.updater.vehicle_rental.VehicleRentalSourceType;
 import org.opentripplanner.updater.vehicle_rental.datasources.params.GbfsVehicleRentalDataSourceParameters;
+import org.opentripplanner.updater.vehicle_rental.datasources.params.RentalPickupType;
 import org.opentripplanner.updater.vehicle_rental.datasources.params.VehicleRentalDataSourceParameters;
 
 /**
@@ -43,13 +47,15 @@ public VehicleRentalDataSourceParameters create() {
         headers(),
         network(),
         geofencingZones(),
-        overloadingAllowed()
+        overloadingAllowed(),
+        rentalPickupTypes()
       );
       case SMOOVE -> new SmooveBikeRentalDataSourceParameters(
         url(),
         network(),
         overloadingAllowed(),
-        headers()
+        headers(),
+        rentalPickupTypes()
       );
     };
   }
@@ -121,4 +127,13 @@ private boolean geofencingZones() {
       )
       .asBoolean(false);
   }
+
+  private Set<RentalPickupType> rentalPickupTypes() {
+    return c
+      .of("rentalPickupTypes")
+      .since(V2_7)
+      .summary(RentalPickupType.STATION.typeDescription())
+      .description(docEnumValueList(RentalPickupType.values()))
+      .asEnumSet(RentalPickupType.class, RentalPickupType.ALL);
+  }
 }

application/src/main/java/org/opentripplanner/updater/vehicle_rental/datasources/GbfsVehicleRentalDataSource.java

@@ -22,6 +22,7 @@
 import org.opentripplanner.service.vehiclerental.model.VehicleRentalPlace;
 import org.opentripplanner.service.vehiclerental.model.VehicleRentalSystem;
 import org.opentripplanner.updater.vehicle_rental.datasources.params.GbfsVehicleRentalDataSourceParameters;
+import org.opentripplanner.updater.vehicle_rental.datasources.params.RentalPickupType;
 import org.opentripplanner.utils.tostring.ToStringBuilder;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -75,43 +76,44 @@ public List<VehicleRentalPlace> getUpdates() {
     final Map<String, RentalVehicleType> vehicleTypes = getVehicleTypes(system);
 
     List<VehicleRentalPlace> stations = new LinkedList<>();
-
-    // Both station information and status are required for all systems using stations
-    GBFSStationInformation stationInformation = loader.getFeed(GBFSStationInformation.class);
-    GBFSStationStatus stationStatus = loader.getFeed(GBFSStationStatus.class);
-    if (stationInformation != null && stationStatus != null) {
-      // Index all the station status entries on their station ID.
-      Map<String, GBFSStation> statusLookup = stationStatus
-        .getData()
-        .getStations()
-        .stream()
-        .collect(Collectors.toMap(GBFSStation::getStationId, Function.identity()));
-      GbfsStationStatusMapper stationStatusMapper = new GbfsStationStatusMapper(
-        statusLookup,
-        vehicleTypes
-      );
-      GbfsStationInformationMapper stationInformationMapper = new GbfsStationInformationMapper(
-        system,
-        vehicleTypes,
-        params.allowKeepingRentedVehicleAtDestination(),
-        params.overloadingAllowed()
-      );
-
-      // Iterate over all known stations, and if we have any status information add it to those station objects.
-      stations.addAll(
-        stationInformation
+    if (params.allowRentalType(RentalPickupType.STATION)) {
+      // Both station information and status are required for all systems using stations
+      GBFSStationInformation stationInformation = loader.getFeed(GBFSStationInformation.class);
+      GBFSStationStatus stationStatus = loader.getFeed(GBFSStationStatus.class);
+      if (stationInformation != null && stationStatus != null) {
+        // Index all the station status entries on their station ID.
+        Map<String, GBFSStation> statusLookup = stationStatus
           .getData()
           .getStations()
           .stream()
-          .map(stationInformationMapper::mapStationInformation)
-          .filter(Objects::nonNull)
-          .peek(stationStatusMapper::fillStationStatus)
-          .toList()
-      );
+          .collect(Collectors.toMap(GBFSStation::getStationId, Function.identity()));
+        GbfsStationStatusMapper stationStatusMapper = new GbfsStationStatusMapper(
+          statusLookup,
+          vehicleTypes
+        );
+        GbfsStationInformationMapper stationInformationMapper = new GbfsStationInformationMapper(
+          system,
+          vehicleTypes,
+          params.allowKeepingRentedVehicleAtDestination(),
+          params.overloadingAllowed()
+        );
+
+        // Iterate over all known stations, and if we have any status information add it to those station objects.
+        stations.addAll(
+          stationInformation
+            .getData()
+            .getStations()
+            .stream()
+            .map(stationInformationMapper::mapStationInformation)
+            .filter(Objects::nonNull)
+            .peek(stationStatusMapper::fillStationStatus)
+            .toList()
+        );
+      }
     }
 
     // Append the floating bike stations.
-    if (OTPFeature.FloatingBike.isOn()) {
+    if (OTPFeature.FloatingBike.isOn() && params.allowRentalType(RentalPickupType.FREE_FLOATING)) {
       GBFSFreeBikeStatus freeBikeStatus = loader.getFeed(GBFSFreeBikeStatus.class);
       if (freeBikeStatus != null) {
         GbfsFreeVehicleStatusMapper freeVehicleStatusMapper = new GbfsFreeVehicleStatusMapper(

application/src/main/java/org/opentripplanner/updater/vehicle_rental/datasources/params/GbfsVehicleRentalDataSourceParameters.java

@@ -1,5 +1,7 @@
 package org.opentripplanner.updater.vehicle_rental.datasources.params;
 
+import java.util.Objects;
+import java.util.Set;
 import org.opentripplanner.updater.spi.HttpHeaders;
 import org.opentripplanner.updater.vehicle_rental.VehicleRentalSourceType;
 
@@ -10,11 +12,20 @@ public record GbfsVehicleRentalDataSourceParameters(
   HttpHeaders httpHeaders,
   String network,
   boolean geofencingZones,
-  boolean overloadingAllowed
+  boolean overloadingAllowed,
+  Set<RentalPickupType> rentalPickupTypes
 )
   implements VehicleRentalDataSourceParameters {
+  public GbfsVehicleRentalDataSourceParameters {
+    Objects.requireNonNull(rentalPickupTypes);
+  }
   @Override
   public VehicleRentalSourceType sourceType() {
     return VehicleRentalSourceType.GBFS;
   }
+
+  @Override
+  public boolean allowRentalType(RentalPickupType rentalPickupType) {
+    return rentalPickupTypes.contains(rentalPickupType);
+  }
 }

application/src/main/java/org/opentripplanner/updater/vehicle_rental/datasources/params/RentalPickupType.java

@@ -0,0 +1,38 @@
+package org.opentripplanner.updater.vehicle_rental.datasources.params;
+
+import java.util.Collections;
+import java.util.EnumSet;
+import java.util.Set;
+import org.opentripplanner.framework.doc.DocumentedEnum;
+
+/**
+ * This is temporary and will be removed in a future version of OTP.
+ *
+ * Enum to specify the type of rental data that is allowed to be read from the data source.
+ */
+public enum RentalPickupType implements DocumentedEnum<RentalPickupType> {
+  STATION("Stations are imported."),
+  FREE_FLOATING("Free-floating vehicles are imported.");
+
+  public static final Set<RentalPickupType> ALL = Collections.unmodifiableSet(
+    EnumSet.allOf(RentalPickupType.class)
+  );
+
+  private final String description;
+
+  RentalPickupType(String description) {
+    this.description = description.stripIndent().trim();
+  }
+
+  @Override
+  public String typeDescription() {
+    return (
+      "This is temporary and will be removed in a future version of OTP. Use this to specify the type of rental data that is allowed to be read from the data source."
+    );
+  }
+
+  @Override
+  public String enumValueDescription() {
+    return description;
+  }
+}

application/src/main/java/org/opentripplanner/updater/vehicle_rental/datasources/params/VehicleRentalDataSourceParameters.java

@@ -13,4 +13,6 @@ public interface VehicleRentalDataSourceParameters {
   VehicleRentalSourceType sourceType();
 
   HttpHeaders httpHeaders();
+
+  boolean allowRentalType(RentalPickupType rentalPickupType);
 }

application/src/test/java/org/opentripplanner/updater/vehicle_rental/VehicleRentalUpdaterTest.java

@@ -20,6 +20,7 @@
 import org.opentripplanner.updater.GraphWriterRunnable;
 import org.opentripplanner.updater.spi.HttpHeaders;
 import org.opentripplanner.updater.vehicle_rental.datasources.VehicleRentalDatasource;
+import org.opentripplanner.updater.vehicle_rental.datasources.params.RentalPickupType;
 import org.opentripplanner.updater.vehicle_rental.datasources.params.VehicleRentalDataSourceParameters;
 
 class VehicleRentalUpdaterTest {
@@ -103,5 +104,10 @@ public VehicleRentalSourceType sourceType() {
     public HttpHeaders httpHeaders() {
       return HttpHeaders.empty();
     }
+
+    @Override
+    public boolean allowRentalType(RentalPickupType rentalPickupType) {
+      return true;
+    }
   }
 }

application/src/test/java/org/opentripplanner/updater/vehicle_rental/datasources/GbfsVehicleRentalDataSourceTest.java

@@ -16,6 +16,7 @@
 import org.opentripplanner.service.vehiclerental.model.VehicleRentalPlace;
 import org.opentripplanner.updater.spi.HttpHeaders;
 import org.opentripplanner.updater.vehicle_rental.datasources.params.GbfsVehicleRentalDataSourceParameters;
+import org.opentripplanner.updater.vehicle_rental.datasources.params.RentalPickupType;
 
 /**
  * This tests the mapping between data coming from a {@link GbfsFeedLoader} to OTP station models.
@@ -32,7 +33,8 @@ void makeStationFromV22() {
         HttpHeaders.empty(),
         null,
         false,
-        false
+        false,
+        RentalPickupType.ALL
       ),
       new OtpHttpClientFactory()
     );
@@ -123,7 +125,8 @@ void geofencing() {
         HttpHeaders.empty(),
         null,
         true,
-        false
+        false,
+        RentalPickupType.ALL
       ),
       new OtpHttpClientFactory()
     );
@@ -165,7 +168,8 @@ void makeStationFromV10() {
         HttpHeaders.empty(),
         network,
         false,
-        true
+        true,
+        RentalPickupType.ALL
       ),
       new OtpHttpClientFactory()
     );