org.transitime.api.utils

Class WebUtils

java.lang.Object

org.transitime.api.utils.WebUtils

public class WebUtils
extends java.lang.Object

Utilities for web based API.

Author:

SkiBu Smith

Constructor Summary

Constructors

Constructor and Description
WebUtils()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	apiKey() Provides the API key to be used to access the Transitime API by Transitime web pages.
static javax.ws.rs.WebApplicationException	badRequestException(int response, java.lang.String s) Convenience method for when need to throw a special HTTP response exception, such as 429 which means Too Many Requests.
static javax.ws.rs.WebApplicationException	badRequestException(java.lang.String s) Convenience method for when need to throw a BAD_REQUEST exception response.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebUtils

public WebUtils()

Method Detail

apiKey

public static java.lang.String apiKey()

Provides the API key to be used to access the Transitime API by Transitime web pages.

Returns:

API key

badRequestException

public static javax.ws.rs.WebApplicationException badRequestException(java.lang.String s)

Convenience method for when need to throw a BAD_REQUEST exception response.

Parameters:

s - Message to be provided as part of the response.

Returns:

Exception to be thrown

badRequestException

public static javax.ws.rs.WebApplicationException badRequestException(int response,
                                                                      java.lang.String s)

Convenience method for when need to throw a special HTTP response exception, such as 429 which means Too Many Requests. See http://en.wikipedia.org/wiki/List_of_HTTP_status_codes for details of possible response codes.

Parameters:

response -

s -

Returns: