Class GetSimBrief

java.lang.Object

org.deltava.dao.http.DAO

org.deltava.dao.http.GetSimBrief

public class GetSimBrief
extends DAO

A Data Access Object to fetch SimBrief packages.

Since:

10.3

Version:

12.4

Author:

Luke

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	GetSimBrief.SimBriefException	SimBrief error data encapsulation class.

Constructor Summary

Constructors

Constructor	Description
GetSimBrief()

Method Summary

Modifier and Type	Method	Description
BriefingPackage	load(String id)	Loads a SimBrief briefing package.
String	refresh(String userID, String staticID)	Refreshes an existing SimBrief briefing package.

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

GetSimBrief

public GetSimBrief()

Method Details

load

public BriefingPackage load(String id)
                     throws DAOException

Loads a SimBrief briefing package.

Parameters:

id - the briefing ID

Returns:

the raw XML string

Throws:

DAOException - if an I/O error occurs

refresh

public String refresh(String userID,
 String staticID)
               throws DAOException

Refreshes an existing SimBrief briefing package.

Parameters:

userID - the SimBrief user ID that generated the package

staticID - the static ID

Returns:

the raw XML string

Throws:

DAOException - if an I/O error occurs