org.transitime.api.utils

Class StandardParameters

java.lang.Object

org.transitime.api.utils.StandardParameters

public class StandardParameters
extends java.lang.Object

For getting the standard parameters from the URI used to access the feed. Includes the key, agency, and the media type (JSON or XML). Does not include command specific parameters.

Author:

SkiBu Smith

Constructor Summary

Constructors

Constructor and Description
StandardParameters()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createResponse(java.lang.Object object) For creating a Response of a single object of the appropriate media type.
java.lang.String	getAgencyId() Simple getter for the agency ID
CommandsInterface	getCommandsInterface() Gets the CommandsInterface for the specified agencyId.
ConfigInterface	getConfigInterface() Gets the ConfigInterface for the specified agencyId.
java.lang.String	getKey() Simple getter for the key
java.lang.String	getMediaType() Returns the media type to use for the response based on optional accept header and the optional format specification in the query string of the URL.
PredictionsInterface	getPredictionsInterface() Gets the PredictionsInterface for the agencyId specified as part of the standard parameters.
javax.servlet.http.HttpServletRequest	getRequest() Returns the HttpServletRequest.
ServerStatusInterface	getServerStatusInterface() Gets the ServerStatusInterface for the specified agencyId.
VehiclesInterface	getVehiclesInterface() Gets the VehiclesInterface for the specified agencyId.
void	validate() Makes sure not access feed too much and that the key is valid.

Methods inherited from class java.lang.Object

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

Constructor Detail

StandardParameters

public StandardParameters()

Method Detail

getMediaType

public java.lang.String getMediaType()
                              throws javax.ws.rs.WebApplicationException

Returns the media type to use for the response based on optional accept header and the optional format specification in the query string of the URL. Setting format in query string overrides what is set in accept header. This way it is always simple to generate a http get for particular format simply by setting query string.

If format specification is incorrect then BadRequest WebApplicationException is thrown.

The media type is not determined in the constructor because then an exception would cause an ugly error message because it would be handled before the root-resource class get method is being called.

Returns:

The resulting media type

Throws:

javax.ws.rs.WebApplicationException

validate

public void validate()
              throws javax.ws.rs.WebApplicationException

Makes sure not access feed too much and that the key is valid. If there is a problem then throws a WebApplicationException.

Throws:

javax.ws.rs.WebApplicationException

createResponse

public javax.ws.rs.core.Response createResponse(java.lang.Object object)

For creating a Response of a single object of the appropriate media type.

Parameters:

object - Object to be returned in XML or JSON

Returns:

The created response in the proper media type.

getVehiclesInterface

public VehiclesInterface getVehiclesInterface()
                                       throws javax.ws.rs.WebApplicationException

Gets the VehiclesInterface for the specified agencyId. If not valid then throws WebApplicationException.

Returns:

The VehiclesInterface

Throws:

javax.ws.rs.WebApplicationException

getCommandsInterface

public CommandsInterface getCommandsInterface()
                                       throws javax.ws.rs.WebApplicationException

Gets the CommandsInterface for the specified agencyId. If not valid then throws WebApplicationException.

Returns:

The CommandsInterface

Throws:

javax.ws.rs.WebApplicationException

getPredictionsInterface

public PredictionsInterface getPredictionsInterface()
                                             throws javax.ws.rs.WebApplicationException

Gets the PredictionsInterface for the agencyId specified as part of the standard parameters. If not valid then throws WebApplicationException.

Returns:

The VehiclesInterface

Throws:

javax.ws.rs.WebApplicationException

getConfigInterface

public ConfigInterface getConfigInterface()
                                   throws javax.ws.rs.WebApplicationException

Gets the ConfigInterface for the specified agencyId. If not valid then throws WebApplicationException.

Returns:

The VehiclesInterface

Throws:

javax.ws.rs.WebApplicationException

getServerStatusInterface

public ServerStatusInterface getServerStatusInterface()
                                               throws javax.ws.rs.WebApplicationException

Gets the ServerStatusInterface for the specified agencyId. If not valid then throws WebApplicationException.

Returns:

The VehiclesInterface

Throws:

javax.ws.rs.WebApplicationException

getKey

public java.lang.String getKey()

Simple getter for the key

Returns:

getAgencyId

public java.lang.String getAgencyId()

Simple getter for the agency ID

Returns:

getRequest

public javax.servlet.http.HttpServletRequest getRequest()

Returns the HttpServletRequest.

Returns: