Class FlightAwareDAO

java.lang.Object

org.deltava.dao.http.DAO

org.deltava.dao.http.FlightAwareDAO

Direct Known Subclasses:

GetFARoutes, GetFASchedule, GetFAWeather

abstract class FlightAwareDAO
extends DAO

An abstract class to describe FlightAware RESTful Data Access Objects.

Since:

8.0

Version:

11.1

Author:

Luke

Constructor Summary

Constructors

Constructor	Description
FlightAwareDAO()

Method Summary

Modifier and Type	Method	Description
protected String	buildURL(String method, Map<String,String> params)	Builds a FlightAware REST URL.
protected void	init(String url)	Helper method to open the connection.
final void	setKey(String key)	Sets the API Key to use.
void	setMaxResults(int maxResults)	Sets the maximum number of results to retrieve.

Methods inherited from class DAO

getCompression, getHeaderField, getIn, getOut, getResponseCode, reset, setAuthentication, setCompression, setConnectTimeout, setMethod, setReadTimeout, setRequestHeader, setReturnErrorStream

Modifier and Type	Method	Description
Compression	getCompression()	Returns the response compression type.
protected String	getHeaderField(String name)	Returns an HTTP response header.
protected InputStream	getIn()	Retrieves an input stream to the URL.
protected OutputStream	getOut()	Retrieves an output stream to the URL.
protected int	getResponseCode()	Returns the HTTP response code for this request.
void	reset()	Resets the connection for subsequent reuse.
protected void	setAuthentication(String userID, String pwd)	Sets an authentication request header.
void	setCompression(Compression... cmps)	Updates the allowed compression for this request.
void	setConnectTimeout(int timeout)	Sets the HTTP connect timeout.
void	setMethod(String method)	Sets the HTTP method to use if not GET.
void	setReadTimeout(int timeout)	Sets the HTTP connect timeout.
protected void	setRequestHeader(String name, String value)	Sets a request header.
void	setReturnErrorStream(boolean returnErrStream)	Sets whether the error stream should be returned when connecting and an error occurs.

Methods inherited from class Object

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

Constructor Details

FlightAwareDAO

FlightAwareDAO()

Method Details

setKey

public final void setKey(String key)

Sets the API Key to use.

Parameters:

key - the key

setMaxResults

public void setMaxResults(int maxResults)

Sets the maximum number of results to retrieve.

Parameters:

maxResults - the maximum number of results

init

protected void init(String url)
             throws IOException

Description copied from class: DAO

Helper method to open the connection.

Overrides:

init in class DAO

Parameters:

url - the URI to connect to

Throws:

IOException - if an error occurs

buildURL

protected String buildURL(String method,
 Map<String,String> params)

Builds a FlightAware REST URL.

Parameters:

method - the API method name

params - a Map of parameters and values

Returns:

the URL to call