Class GetVATSIMData

java.lang.Object

org.deltava.dao.http.DAO

org.deltava.dao.http.GetVATSIMData

public class GetVATSIMData
extends DAO

A Data Access Object to read VATSIM API data.

Since:

1.0

Version:

11.6

Author:

Luke

Constructor Summary

Constructors

Constructor	Description
GetVATSIMData()

Method Summary

Modifier and Type	Method	Description
Certificate	getInfo(String id)	Returns information about the selected VATSIM certificate.
boolean	getOnline(String id)	Returns whether a VATSIM user is connected to the network.

Methods inherited from class DAO

getCompression, getHeaderField, getIn, getOut, getResponseCode, init, 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.
protected void	init(String url)	Helper method to open the connection.
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

GetVATSIMData

public GetVATSIMData()

Method Details

getInfo

public Certificate getInfo(String id)
                    throws DAOException

Returns information about the selected VATSIM certificate.

Parameters:

id - the VATSIM certificate ID

Returns:

a Certificate bean

Throws:

DAOException - if an error occurs

getOnline

public boolean getOnline(String id)
                  throws DAOException

Returns whether a VATSIM user is connected to the network.

Parameters:

id - the VATSIM ID

Returns:

TRUE if connected, otherwise FALSE

Throws:

DAOException - if an error occurs