org.opentripplanner.api.resource

Class Routers

java.lang.Object

org.opentripplanner.api.resource.Routers

@Path(value="/routers")
 @PermitAll
public class Routers
extends Object

This REST API endpoint allows remotely loading, reloading, and evicting graphs on a running server. A GraphService maintains a mapping between routerIds and specific Graph objects. The HTTP verbs are used as follows to manipulate that mapping: GET - see the registered routerIds and Graphs, verify whether a particular routerId is registered PUT - create or replace a mapping from a routerId to a Graph loaded from the server filesystem POST - create or replace a mapping from a routerId to a serialized Graph sent in the request DELETE - de-register a routerId, releasing the reference to the associated graph The HTTP request URLs are of the form /ws/routers/{routerId}, where the routerId is optional. If a routerId is supplied in the URL, the verb will act upon the mapping for that specific routerId. If no routerId is given, the verb will act upon all routerIds currently registered. For example: GET http://localhost/otp-rest-servlet/ws/routers will retrieve a list of all registered routerId -> Graph mappings and their geographic bounds. GET http://localhost/otp-rest-servlet/ws/routers/london will return status code 200 and a brief description of the 'london' graph including geographic bounds, or 404 if the 'london' routerId is not registered. PUT http://localhost/otp-rest-servlet/ws/routers will reload the graphs for all currently registered routerIds from disk. PUT http://localhost/otp-rest-servlet/ws/routers/paris will load a Graph from a sub-directory called 'paris' and associate it with the routerId 'paris'. DELETE http://localhost/otp-rest-servlet/ws/routers/paris will release the Paris Graph and de-register the 'paris' routerId. DELETE http://localhost/otp-rest-servlet/ws/routers will de-register all currently registered routerIds. The GET methods are not secured, but all other methods are secured under ROLE_ROUTERS. See documentation for individual methods for additional parameters.

Constructor Summary

Constructors

Constructor and Description
Routers()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	buildGraphOverWire(String routerId, boolean preEvict, InputStream input) Build a graph from data in the ZIP file posted over the wire, associating it with the given router ID.
javax.ws.rs.core.Response	deleteAll() De-register all registered routerIds, evicting them from memory.
javax.ws.rs.core.Response	deleteGraphId(String routerId) De-register a specific routerId, evicting the associated graph from memory.
RouterInfo	getGraphId(String routerId) Returns the bounds for a specific routerId, or verifies whether it is registered.
RouterList	getRouterIds() Returns a list of routers and their bounds.
javax.ws.rs.core.Response	postGraphOverWire(String routerId, boolean preEvict, InputStream is) Deserialize a graph sent with the HTTP request as POST data, associating it with the given routerId.
javax.ws.rs.core.Response	putGraphId(String routerId, boolean preEvict) Load the graph for the specified routerId from disk.
javax.ws.rs.core.Response	reloadGraphs(String path, boolean preEvict, boolean force) Reload the graphs for all registered routerIds from disk.
javax.ws.rs.core.Response	saveGraphOverWire(String routerId, InputStream is) Save the graph data, but don't load it in memory.

Methods inherited from class java.lang.Object

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

Constructor Detail

Routers

public Routers()

Method Detail

getRouterIds

@GET
 @Produces(value={"application/json","application/xml;qs=0.5","text/xml;qs=0.5"})
public RouterList getRouterIds()

Returns a list of routers and their bounds.

Returns:

a representation of the graphs and their geographic bounds, in JSON or XML depending on the Accept header in the HTTP request.

getGraphId

@GET
 @Path(value="{routerId}")
 @Produces(value={"application/json","application/xml;qs=0.5","text/xml;qs=0.5"})
public RouterInfo getGraphId(@PathParam(value="routerId")
                                                                                                                                               String routerId)

Returns the bounds for a specific routerId, or verifies whether it is registered.

reloadGraphs

@RolesAllowed(value="ROUTERS")
 @PUT
 @Produces(value="application/json")
public javax.ws.rs.core.Response reloadGraphs(@QueryParam(value="path")
                                                                                                                        String path,
                                                                                                                        @QueryParam(value="preEvict") @DefaultValue(value="true")
                                                                                                                        boolean preEvict,
                                                                                                                        @QueryParam(value="force") @DefaultValue(value="true")
                                                                                                                        boolean force)

Reload the graphs for all registered routerIds from disk.

putGraphId

@RolesAllowed(value="ROUTERS")
 @PUT
 @Path(value="{routerId}")
 @Produces(value="text/plain")
public javax.ws.rs.core.Response putGraphId(@PathParam(value="routerId")
                                                                                                                                           String routerId,
                                                                                                                                           @QueryParam(value="preEvict") @DefaultValue(value="true")
                                                                                                                                           boolean preEvict)

Load the graph for the specified routerId from disk.

Parameters:

preEvict - before reloading each graph, evict the existing graph. This will prevent memory usage from increasing during the reload, but routing will be unavailable on this routerId for the duration of the operation.

postGraphOverWire

@RolesAllowed(value="ROUTERS")
 @POST
 @Path(value="{routerId}")
 @Produces(value="text/plain")
 @Consumes(value="application/octet-stream")
public javax.ws.rs.core.Response postGraphOverWire(@PathParam(value="routerId")
                                                                                                                                                                                                String routerId,
                                                                                                                                                                                                @QueryParam(value="preEvict") @DefaultValue(value="true")
                                                                                                                                                                                                boolean preEvict,
                                                                                                                                                                                                InputStream is)

Deserialize a graph sent with the HTTP request as POST data, associating it with the given routerId.

buildGraphOverWire

@RolesAllowed(value="ROUTERS")
 @POST
 @Path(value="{routerId}")
 @Consumes(value="application/zip")
 @Produces(value="text/plain")
public javax.ws.rs.core.Response buildGraphOverWire(@PathParam(value="routerId")
                                                                                                                                                                                        String routerId,
                                                                                                                                                                                        @QueryParam(value="preEvict") @DefaultValue(value="true")
                                                                                                                                                                                        boolean preEvict,
                                                                                                                                                                                        InputStream input)

Build a graph from data in the ZIP file posted over the wire, associating it with the given router ID. This method will be selected when the Content-Type is application/zip.

saveGraphOverWire

@RolesAllowed(value="ROUTERS")
 @POST
 @Path(value="/save")
 @Produces(value="text/plain")
 @Consumes(value="application/octet-stream")
public javax.ws.rs.core.Response saveGraphOverWire(@QueryParam(value="routerId")
                                                                                                                                                                                           String routerId,
                                                                                                                                                                                           InputStream is)

Save the graph data, but don't load it in memory. The file location is based on routerId. If the graph already exists, the graph will be overwritten.

deleteAll

@RolesAllowed(value="ROUTERS")
 @DELETE
 @Produces(value="text/plain")
public javax.ws.rs.core.Response deleteAll()

De-register all registered routerIds, evicting them from memory.

deleteGraphId

@RolesAllowed(value="ROUTERS")
 @DELETE
 @Path(value="{routerId}")
 @Produces(value="text/plain")
public javax.ws.rs.core.Response deleteGraphId(@PathParam(value="routerId")
                                                                                                                                                 String routerId)

De-register a specific routerId, evicting the associated graph from memory.

Returns:

status code 200 if the routerId was de-registered, 404 if the routerId was not registered.