org.opentripplanner.standalone

Class OTPApplication

java.lang.Object

javax.ws.rs.core.Application

org.opentripplanner.standalone.OTPApplication

public class OTPApplication
extends javax.ws.rs.core.Application

A JAX-RS Application subclass which provides hard-wired configuration of an OTP server. Avoids auto-scanning of any kind, and keeps injection to a bare minimum using HK2, the injection library Jersey itself uses. Jersey has its own ResourceConfig class which is a subclass of Application. We can get away with not using any Jersey-specific "conveniences" and stick with stock JAX-RS.

Field Summary

Fields

Modifier and Type	Field and Description
OTPServer	server

Constructor Summary

Constructors

Constructor and Description
OTPApplication(OTPServer server, boolean secure) The OTPServer provides entry points to OTP routing functionality for a collection of OTPRouters.

Method Summary

Modifier and Type	Method and Description
Set<Class<?>>	getClasses() This method registers classes with Jersey to define web resources and enable custom features.
Map<String,Object>	getProperties() Enabling tracing allows us to see how web resource names were matched from the client, in headers.
Set<Object>	getSingletons() Like getClasses, this method declares web resources, providers, and features to the JAX-RS implementation.

Methods inherited from class java.lang.Object

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

Field Detail

server

public final OTPServer server

Constructor Detail

OTPApplication

public OTPApplication(OTPServer server,
                      boolean secure)

The OTPServer provides entry points to OTP routing functionality for a collection of OTPRouters. It provides a Java API, not an HTTP API. The OTPApplication wraps an OTPServer in a Jersey (JAX-RS) Application, configuring an HTTP API.

Parameters:

server - The OTP server to wrap

secure - Should this server require authentication over HTTPS to access secure resources, e.g. /routers?

Method Detail

getClasses

public Set<Class<?>> getClasses()

This method registers classes with Jersey to define web resources and enable custom features. These are classes (not instances) that will be instantiated by Jersey for each request (they are request-scoped). Types that have been confirmed to work are: annotated resources, ContextResolver implementation, ContainerResponseFilter and ContainerRequestFilter. Note that the listed classes do not need to be annotated with @Provider -- that is for scanning config.

Overrides:

getClasses in class javax.ws.rs.core.Application

getSingletons

public Set<Object> getSingletons()

Like getClasses, this method declares web resources, providers, and features to the JAX-RS implementation. However, these are single instances that will be reused for all requests (they are singleton-scoped). See https://jersey.java.net/apidocs/latest/jersey/javax/ws/rs/core/Application.html#getSingletons() Leave