org.opentripplanner.apis.APIEndpoints Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of application Show documentation
The newest version!
package org.opentripplanner.apis;

import static org.opentripplanner.framework.application.OTPFeature.APIBikeRental;
import static org.opentripplanner.framework.application.OTPFeature.APIServerInfo;
import static org.opentripplanner.framework.application.OTPFeature.APIUpdaterStatus;
import static org.opentripplanner.framework.application.OTPFeature.ActuatorAPI;
import static org.opentripplanner.framework.application.OTPFeature.DebugRasterTiles;
import static org.opentripplanner.framework.application.OTPFeature.DebugUi;
import static org.opentripplanner.framework.application.OTPFeature.GtfsGraphQlApi;
import static org.opentripplanner.framework.application.OTPFeature.LegacyRestApi;
import static org.opentripplanner.framework.application.OTPFeature.ReportApi;
import static org.opentripplanner.framework.application.OTPFeature.SandboxAPIGeocoder;
import static org.opentripplanner.framework.application.OTPFeature.SandboxAPIMapboxVectorTilesApi;
import static org.opentripplanner.framework.application.OTPFeature.SandboxAPIParkAndRideApi;
import static org.opentripplanner.framework.application.OTPFeature.TransmodelGraphQlApi;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import org.opentripplanner.api.resource.ServerInfo;
import org.opentripplanner.api.resource.UpdaterStatusResource;
import org.opentripplanner.apis.gtfs.GtfsGraphQLAPI;
import org.opentripplanner.apis.transmodel.TransmodelAPI;
import org.opentripplanner.apis.vectortiles.GraphInspectorVectorTileResource;
import org.opentripplanner.ext.actuator.ActuatorAPI;
import org.opentripplanner.ext.debugrastertiles.api.resource.DebugRasterTileResource;
import org.opentripplanner.ext.geocoder.GeocoderResource;
import org.opentripplanner.ext.parkAndRideApi.ParkAndRideResource;
import org.opentripplanner.ext.reportapi.resource.ReportResource;
import org.opentripplanner.ext.restapi.resources.BikeRental;
import org.opentripplanner.ext.restapi.resources.IndexAPI;
import org.opentripplanner.ext.restapi.resources.PlannerResource;
import org.opentripplanner.ext.restapi.resources.Routers;
import org.opentripplanner.ext.vectortiles.VectorTilesResource;
import org.opentripplanner.framework.application.OTPFeature;

/**
 * Configure API resource endpoints.
 */
public class APIEndpoints {

  private final List> resources = new ArrayList<>();

  private APIEndpoints() {
    // Add feature enabled APIs, these can be enabled by default, some is not.
    // See the OTPFeature enum for details.
    addIfEnabled(APIServerInfo, ServerInfo.class);
    addIfEnabled(APIUpdaterStatus, UpdaterStatusResource.class);
    addIfEnabled(DebugUi, GraphInspectorVectorTileResource.class);
    addIfEnabled(GtfsGraphQlApi, GtfsGraphQLAPI.class);
    // scheduled to be removed and only here for backwards compatibility
    addIfEnabled(GtfsGraphQlApi, GtfsGraphQLAPI.GtfsGraphQLAPIOldPath.class);
    addIfEnabled(TransmodelGraphQlApi, TransmodelAPI.class);
    // scheduled to be removed and only here for backwards compatibility
    addIfEnabled(TransmodelGraphQlApi, TransmodelAPI.TransmodelAPIOldPath.class);

    // Sandbox extension APIs
    addIfEnabled(ActuatorAPI, ActuatorAPI.class);
    addIfEnabled(DebugRasterTiles, DebugRasterTileResource.class);
    addIfEnabled(ReportApi, ReportResource.class);
    addIfEnabled(SandboxAPIMapboxVectorTilesApi, VectorTilesResource.class);
    addIfEnabled(SandboxAPIParkAndRideApi, ParkAndRideResource.class);
    addIfEnabled(SandboxAPIGeocoder, GeocoderResource.class);

    // scheduled to be removed
    addIfEnabled(APIBikeRental, BikeRental.class);
    addIfEnabled(LegacyRestApi, Routers.class);
    addIfEnabled(LegacyRestApi, PlannerResource.class);
    addIfEnabled(LegacyRestApi, IndexAPI.class);
  }

  /**
   * List all mandatory and feature enabled endpoints as Jersey resource classes: define web
   * services, i.e. an HTTP APIs.
   * 
   * Some of the endpoints can be turned on/off using {@link OTPFeature}s, this method check if an
   * endpoint is enabled before adding it to the list.
   *
   * @return all mandatory and feature enabled endpoints are returned.
   */
  public static Collection> listAPIEndpoints() {
    return Collections.unmodifiableCollection(new APIEndpoints().resources);
  }

  /**
   * Add feature to list of classes if the feature is enabled (turned on).
   *
   * @param apiFeature the feature to check.
   * @param resource   the resource to enable if feature is enabled.
   */
  private void addIfEnabled(OTPFeature apiFeature, Class resource) {
    if (apiFeature.isOn()) {
      add(resource);
    }
  }

  private void add(Class resource) {
    resources.add(resource);
  }
}