org.opentripplanner.api.resource

Class PlannerResource

java.lang.Object

org.opentripplanner.api.common.RoutingResource

org.opentripplanner.api.resource.PlannerResource

@Path(value="routers/{routerId}/plan")
public class PlannerResource
extends RoutingResource

This is the primary entry point for the trip planning web service. All parameters are passed in the query string. These parameters are defined as fields in the abstract RoutingResource superclass, which also has methods for building routing requests from query parameters. This allows multiple web services to have the same set of query parameters. In order for inheritance to work, the REST resources are request-scoped (constructed at each request) rather than singleton-scoped (a single instance existing for the lifetime of the OTP server).

Field Summary

Fields inherited from class org.opentripplanner.api.common.RoutingResource

arriveBy, bannedAgencies, bannedRoutes, bannedStops, bannedStopsHard, bannedTrips, batch, bikeBoardCost, bikeSpeed, bikeSwitchCost, bikeSwitchTime, clampInitialWait, date, disableRemainingWeightHeuristic, fromPlace, ignoreRealtimeUpdates, intermediatePlaces, maxPreTransitTime, maxTransfers, maxWalkDistance, minTransferTime, modes, nonpreferredTransferPenalty, numItineraries, optimize, otherThanPreferredRoutesPenalty, otpServer, preferredAgencies, preferredRoutes, reverseOptimizeOnTheFly, routerId, showIntermediateStops, startTransitStopId, startTransitTripId, time, toPlace, transferPenalty, triangleSafetyFactor, triangleSlopeFactor, triangleTimeFactor, unpreferredAgencies, unpreferredRoutes, waitAtBeginningFactor, waitReluctance, walkBoardCost, walkReluctance, walkSpeed, wheelchair

Constructor Summary

Constructors

Constructor and Description
PlannerResource()

Method Summary

Modifier and Type	Method and Description
Response	plan(OTPServer otpServer, javax.ws.rs.core.UriInfo uriInfo)

Methods inherited from class org.opentripplanner.api.common.RoutingResource

buildRequest

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PlannerResource

public PlannerResource()

Method Detail

plan

@GET
 @Produces(value={"application/json","application/xml;qs=0.5","text/xml;qs=0.5"})
public Response plan(@Context
                                                                                                            OTPServer otpServer,
                                                                                                            @Context
                                                                                                            javax.ws.rs.core.UriInfo uriInfo)