org.opentripplanner.standalone

Class OTPServer

java.lang.Object

org.opentripplanner.standalone.OTPServer

public class OTPServer
extends Object

This replaces a Spring application context, which OTP originally used. It contains a field referencing each top-level component of an OTP server. This means that supplying a single instance of this object allows accessing any of the other OTP components.

Field Summary

Fields

Modifier and Type	Field and Description
File	basePath The directory under which graphs, caches, etc.
CommandLineParameters	params
PointSetCache	pointSetCache
ScriptingService	scriptingService
SurfaceCache	surfaceCache

Constructor Summary

Constructors

Constructor and Description
OTPServer(CommandLineParameters params, GraphService gs)

Method Summary

Modifier and Type	Method and Description
GraphService	getGraphService()
Router	getRouter(String routerId)
Collection<String>	getRouterIds()
org.glassfish.hk2.utilities.binding.AbstractBinder	makeBinder() Return an HK2 Binder that injects this specific OTPServer instance into Jersey web resources.

Methods inherited from class java.lang.Object

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

Field Detail

basePath

public File basePath

The directory under which graphs, caches, etc. will be stored.

surfaceCache

public SurfaceCache surfaceCache

pointSetCache

public PointSetCache pointSetCache

scriptingService

public ScriptingService scriptingService

params

public CommandLineParameters params

Constructor Detail

OTPServer

public OTPServer(CommandLineParameters params,
                 GraphService gs)

Method Detail

getGraphService

public GraphService getGraphService()

Returns:

The GraphService. Please use it only when the GraphService itself is necessary. To get Graph instances, use getRouter().

getRouterIds

public Collection<String> getRouterIds()

Returns:

A list of all router IDs currently available.

getRouter

public Router getRouter(String routerId)
                 throws GraphNotFoundException

Throws:

GraphNotFoundException

makeBinder

public org.glassfish.hk2.utilities.binding.AbstractBinder makeBinder()

Return an HK2 Binder that injects this specific OTPServer instance into Jersey web resources. This should be registered in the ResourceConfig (Jersey) or Application (JAX-RS) as a singleton. Jersey forces us to use injection to get application context into HTTP method handlers, but in OTP we always just inject this OTPServer instance and grab anything else we need (routers, graphs, application components) from this single object. More on custom injection in Jersey 2: http://jersey.576304.n2.nabble.com/Custom-providers-in-Jersey-2-tp7580699p7580715.html