This class is used to build responses for/by the BES. More...

#include <BESDapResponseBuilder.h>

Collaboration diagram for BESDapResponseBuilder:

Public Member Functions
	BESDapResponseBuilder ()
	Make an empty instance. More...

virtual void	establish_timeout (std::ostream &stream) const
	Use values of this instance to establish a timeout alarm for the server. More...

virtual std::string	get_async_accepted () const

virtual std::string	get_btp_func_ce () const

virtual std::string	get_ce () const
	Return the entire DAP2 constraint expression in a string. More...

virtual std::string	get_dap4ce () const
	Return the entire DAP4 constraint expression in a string. More...

virtual std::string	get_dap4function () const
	Return the entire DAP4 server side function expression in a string. More...

virtual std::string	get_dataset_name () const
	The ``dataset name'' is the filename or other string that the filter program will use to access the data. More...

virtual std::string	get_store_result () const

int	get_timeout () const
	Get the server's timeout value. More...

virtual void	remove_timeout () const

virtual BESDapResponseCache *	responseCache ()
	Lazy getter for the ResponseCache. More...

virtual void	send_dap2_data (std::ostream &data_stream, libdap::DDS &dds, libdap::ConstraintEvaluator &eval, bool with_mime_headers=true)
	Send the data in the DDS object back to the client program. More...

virtual void	send_dap4_data (std::ostream &out, libdap::DMR &dmr, bool with_mime_headers=true)

virtual void	send_das (std::ostream &out, libdap::DAS &das, bool with_mime_headers=true) const

virtual void	send_das (std::ostream &out, libdap::DDS &dds, libdap::ConstraintEvaluator &eval, bool constrained=false, bool with_mime_headers=true)

virtual void	send_dds (std::ostream &out, libdap::DDS &dds, libdap::ConstraintEvaluator &eval, bool constrained=false, bool with_mime_headers=true)
	This function formats and prints an ASCII representation of a DDS on stdout. More...

virtual void	send_ddx (std::ostream &out, libdap::DDS &dds, libdap::ConstraintEvaluator &eval, bool with_mime_headers=true)
	Send the DDX response. More...

virtual void	send_dmr (std::ostream &out, libdap::DMR &dmr, bool with_mime_headers=true)

virtual void	serialize_dap2_data_dds (std::ostream &out, libdap::DDS &dds, libdap::ConstraintEvaluator &eval, bool ce_eval=true)
	Build/return the BLOB part of the DAP2 data response. More...

virtual void	serialize_dap2_data_ddx (std::ostream &out, libdap::DDS &dds, libdap::ConstraintEvaluator &eval, const std::string &boundary, const std::string &start, bool ce_eval=true)
	Serialize a DAP3.2 DataDDX to the stream "out". More...

virtual void	serialize_dap4_data (std::ostream &out, libdap::DMR &dmr, bool with_mime_headers=true)
	Serialize the DAP4 data response to the passed stream. More...

virtual void	set_async_accepted (std::string _aa)

virtual void	set_btp_func_ce (std::string _ce)

virtual void	set_ce (std::string _ce)
	Set the DAP2 constraint expression. More...

virtual void	set_dap4ce (std::string _ce)
	Set the DAP4 constraint expression. More...

virtual void	set_dap4function (std::string _func)
	Set the DAP4 Server Side Fucntion expression. More...

virtual void	set_dataset_name (const std::string _dataset)
	Set the dataset name, which is a string used to access the dataset on the machine running the server. More...

virtual void	set_store_result (std::string _sr)

void	set_timeout (int timeout=0)
	Set the server's timeout value. More...

virtual void	split_ce (libdap::ConstraintEvaluator &eval, const std::string &expr="")
	Split the CE so that the server functions that compute new values are separated into their own string and can be evaluated separately from the rest of the CE (which can contain simple and slicing projection as well as other types of function calls). More...

virtual bool	store_dap4_result (ostream &out, libdap::DMR &dmr)
	Should this DAP4 result be stored and the client sent an Asynchronous response? This code looks at the 'store_result' property to determine if the response should be asynchronous and then, if so, churns through the options, sorting out if the client sent the correct information indicating it knows how to process them. More...

virtual	~BESDapResponseBuilder ()

Protected Member Functions
void	initialize ()
	Called when initializing a ResponseBuilder that's not going to be passed command line arguments. More...

void	send_dap4_data_using_ce (std::ostream &out, libdap::DMR &dmr, bool with_mime_headersr)

bool	store_dap2_result (ostream &out, libdap::DDS &dds, libdap::ConstraintEvaluator &eval)
	Should this result be returned using the asynchronous response mechanism? Look at the 'store_result' property and see if the code should return this using the asynchronous mechanism. More...

Protected Attributes
std::string	d_async_accepted
	Version std::string for the library's default protocol version. More...

std::string	d_btp_func_ce
	DAP4 Server Side Function expression. More...

std::string	d_dap2ce
	Name of the dataset/database. More...

std::string	d_dap4ce
	DAP2 Constraint expression. More...

std::string	d_dap4function
	DAP4 Constraint expression. More...

std::string	d_dataset

std::string	d_default_protocol
	Response timeout after N seconds. More...

BESDapResponseCache *	d_response_cache

std::string	d_store_result
	If set (i.e. More...

int	d_timeout
	The BTP functions, extracted from the CE. More...

Friends
class	ResponseBuilderTest

Detailed Description

This class is used to build responses for/by the BES.

This class replaces DODSFilter (although DODSFilter is still included in the library, its use is deprecated). and it does not have a provision for command line arguments.

Author: jhrg 1/28/2011

Definition at line 45 of file BESDapResponseBuilder.h.

Constructor & Destructor Documentation

BESDapResponseBuilder::BESDapResponseBuilder ( )

inline

Make an empty instance.

Use the set_*() methods to load with needed values. You must call at least set_dataset_name() or be requesting version information.

Definition at line 85 of file BESDapResponseBuilder.h.

References initialize().

Here is the call graph for this function:

BESDapResponseBuilder::~BESDapResponseBuilder ( )

virtual

Definition at line 125 of file BESDapResponseBuilder.cc.

Member Function Documentation

void BESDapResponseBuilder::establish_timeout ( std::ostream & stream ) const

virtual

Use values of this instance to establish a timeout alarm for the server.

If the timeout value is zero, do nothing.

Definition at line 277 of file BESDapResponseBuilder.cc.

std::string BESDapResponseBuilder::get_async_accepted ( ) const

virtual

Definition at line 219 of file BESDapResponseBuilder.cc.

virtual std::string BESDapResponseBuilder::get_btp_func_ce ( ) const

inlinevirtual

Definition at line 107 of file BESDapResponseBuilder.h.

References d_btp_func_ce.

Referenced by BESAsciiTransmit::send_basic_ascii().

string BESDapResponseBuilder::get_ce ( ) const

virtual

Return the entire DAP2 constraint expression in a string.

This includes both the projection and selection clauses, but not the question mark.

Get the constraint expression.

Returns: A string object that contains the constraint expression.

Definition at line 141 of file BESDapResponseBuilder.cc.

Referenced by BESAsciiTransmit::send_basic_ascii().

string BESDapResponseBuilder::get_dap4ce ( ) const

virtual

Return the entire DAP4 constraint expression in a string.

Get the DAP4 constraint expression.

Returns: A string object that contains the constraint expression.

Definition at line 164 of file BESDapResponseBuilder.cc.

string BESDapResponseBuilder::get_dap4function ( ) const

virtual

Return the entire DAP4 server side function expression in a string.

Get the DAP4 server side function expression.

Returns: A string object that contains the constraint expression.

Definition at line 187 of file BESDapResponseBuilder.cc.

string BESDapResponseBuilder::get_dataset_name ( ) const

virtual

The ``dataset name'' is the filename or other string that the filter program will use to access the data.

In some cases this will indicate a disk file containing the data. In others, it may represent a database query or some other exotic data access method.

Get the dataset name.

Returns: A string object that contains the name of the dataset.

Definition at line 238 of file BESDapResponseBuilder.cc.

Referenced by BESDapResponseCache::cache_dataset(), and BESStoredDapResultCache::store_dap2_result().

std::string BESDapResponseBuilder::get_store_result ( ) const

virtual

Definition at line 208 of file BESDapResponseBuilder.cc.

int BESDapResponseBuilder::get_timeout ( ) const

Get the server's timeout value.

Definition at line 269 of file BESDapResponseBuilder.cc.

void BESDapResponseBuilder::initialize ( )

protected

Called when initializing a ResponseBuilder that's not going to be passed command line arguments.

Definition at line 97 of file BESDapResponseBuilder.cc.

References DAP_PROTOCOL_VERSION.

Referenced by BESDapResponseBuilder().

void BESDapResponseBuilder::remove_timeout ( ) const

virtual

Definition at line 289 of file BESDapResponseBuilder.cc.

BESDapResponseCache * BESDapResponseBuilder::responseCache ( )

virtual

Lazy getter for the ResponseCache.

Definition at line 118 of file BESDapResponseBuilder.cc.

References BESDapResponseCache::get_instance().

Referenced by BESAsciiTransmit::send_basic_ascii().

Here is the call graph for this function:

void BESDapResponseBuilder::send_dap2_data	(	std::ostream &	data_stream,
		libdap::DDS &	dds,
		libdap::ConstraintEvaluator &	eval,
		bool	with_mime_headers = `true`
	)

virtual

Send the data in the DDS object back to the client program.

The data is encoded using a Marshaller, and enclosed in a MIME document which is all sent to data_stream.

Note: This is the DAP2 data response.

Transmit data.

Parameters

dds	A DDS object containing the data to be sent.
eval	A reference to the ConstraintEvaluator to use.
data_stream	Write the response to this stream.
anc_location	A directory to search for ancillary files (in addition to the CWD). This is used in a call to get_data_last_modified_time().
with_mime_headers	If true, include the MIME headers in the response. Defaults to true.

Returns: void

Definition at line 795 of file BESDapResponseBuilder.cc.

References BESDEBUG.

void BESDapResponseBuilder::send_dap4_data	(	std::ostream &	out,
		libdap::DMR &	dmr,
		bool	with_mime_headers = `true`
	)

virtual

Definition at line 1020 of file BESDapResponseBuilder.cc.

void BESDapResponseBuilder::send_dap4_data_using_ce	(	std::ostream &	out,
		libdap::DMR &	dmr,
		bool	with_mime_headersr
	)

protected

Definition at line 994 of file BESDapResponseBuilder.cc.

virtual void BESDapResponseBuilder::send_das	(	std::ostream &	out,
		libdap::DAS &	das,
		bool	with_mime_headers = `true`
	)		const

virtual

virtual void BESDapResponseBuilder::send_das	(	std::ostream &	out,
		libdap::DDS &	dds,
		libdap::ConstraintEvaluator &	eval,
		bool	constrained = `false`,
		bool	with_mime_headers = `true`
	)

virtual

void BESDapResponseBuilder::send_dds	(	std::ostream &	out,
		libdap::DDS &	dds,
		libdap::ConstraintEvaluator &	eval,
		bool	constrained = `false`,
		bool	with_mime_headers = `true`
	)

virtual

This function formats and prints an ASCII representation of a DDS on stdout.

Either an entire DDS or a constrained DDS may be sent. This function looks in the local cache and uses a DDS object there if it's valid. Otherwise, if the request CE contains server functions that build data for the response, the resulting DDS will be cached.

Transmit a DDS.

Parameters

out	The output stream to which the DAS is to be sent.
dds	The DDS to send back to a client.
eval	A reference to the ConstraintEvaluator to use.
constrained	If this argument is true, evaluate the current constraint expression and send the `constrained DDS' back to the client.
constrained	If true, apply the constraint bound to this instance of ResponseBuilder
with_mime_headers	If true (default) send MIME headers.

Returns: void

See also: DDS

Definition at line 480 of file BESDapResponseBuilder.cc.

void BESDapResponseBuilder::send_ddx	(	std::ostream &	out,
		libdap::DDS &	dds,
		libdap::ConstraintEvaluator &	eval,
		bool	with_mime_headers = `true`
	)

virtual

Send the DDX response.

The DDX never contains data, instead it holds a reference to a Blob response which is used to get the data values. The DDS and DAS objects are built using code that already exists in the servers.

Note: This is the DAP3.x metadata response; it is supported by most DAP2 servers as well. The DAP4 DDX will contain types not present in DAP2 or 3.x

Parameters

dds	The dataset's DDS with attributes in the variables.
eval	A reference to the ConstraintEvaluator to use.
out	Destination
with_mime_headers	If true, include the MIME headers in the response. Defaults to true.

Definition at line 899 of file BESDapResponseBuilder.cc.

void BESDapResponseBuilder::send_dmr	(	std::ostream &	out,
		libdap::DMR &	dmr,
		bool	with_mime_headers = `true`
	)

virtual

Definition at line 965 of file BESDapResponseBuilder.cc.

References BESDEBUG.

void BESDapResponseBuilder::serialize_dap2_data_dds	(	std::ostream &	out,
		libdap::DDS &	dds,
		libdap::ConstraintEvaluator &	eval,
		bool	ce_eval = `true`
	)

virtual

Build/return the BLOB part of the DAP2 data response.

Definition at line 718 of file BESDapResponseBuilder.cc.

References BESDEBUG.

void BESDapResponseBuilder::serialize_dap2_data_ddx	(	std::ostream &	out,
		libdap::DDS &	dds,
		libdap::ConstraintEvaluator &	eval,
		const std::string &	boundary,
		const std::string &	start,
		bool	ce_eval = `true`
	)

virtual

Serialize a DAP3.2 DataDDX to the stream "out".

This was originally intended to be used for DAP4.

Definition at line 742 of file BESDapResponseBuilder.cc.

References BESDEBUG.

Referenced by BESDapResponseCache::cache_dataset(), and BESStoredDapResultCache::store_dap2_result().

void BESDapResponseBuilder::serialize_dap4_data	(	std::ostream &	out,
		libdap::DMR &	dmr,
		bool	with_mime_headers = `true`
	)

virtual

Serialize the DAP4 data response to the passed stream.

Definition at line 1062 of file BESDapResponseBuilder.cc.

References BESDEBUG, CRLF, and max.

Referenced by BESStoredDapResultCache::store_dap4_result().

void BESDapResponseBuilder::set_async_accepted ( std::string _aa )

virtual

Definition at line 224 of file BESDapResponseBuilder.cc.

References BESDEBUG.

virtual void BESDapResponseBuilder::set_btp_func_ce ( std::string _ce )

inlinevirtual

Definition at line 111 of file BESDapResponseBuilder.h.

void BESDapResponseBuilder::set_ce ( std::string _ce )

virtual

Set the DAP2 constraint expression.

This will filter the CE text removing any 'WWW' escape characters except space. Spaces are left in the CE because the CE parser uses whitespace to delimit tokens while some datasets have identifiers that contain spaces. It's possible to use double quotes around identifiers too, but most client software doesn't know about that.

@brief Set the CE

Parameters

_ce	The constraint expression

Definition at line 156 of file BESDapResponseBuilder.cc.

void BESDapResponseBuilder::set_dap4ce ( std::string _ce )

virtual

Set the DAP4 constraint expression.

This will filter the DAP4 CE text removing any 'WWW' escape characters except space. Spaces are left in the CE because the CE parser uses whitespace to delimit tokens while some datasets have identifiers that contain spaces. It's possible to use double quotes around identifiers too, but most client software doesn't know about that.

@brief Set the CE

Parameters

_ce	The constraint expression

Definition at line 179 of file BESDapResponseBuilder.cc.

void BESDapResponseBuilder::set_dap4function ( std::string _func )

virtual

Set the DAP4 Server Side Fucntion expression.

This will filter the function expression text removing any 'WWW' escape characters except space. Spaces are left in the CE because the CE parser uses whitespace to delimit tokens while some datasets have identifiers that contain spaces. It's possible to use double quotes around identifiers too, but most client software doesn't know about that.

@brief Set the CE

Parameters

_ce	The constraint expression

Definition at line 203 of file BESDapResponseBuilder.cc.

void BESDapResponseBuilder::set_dataset_name ( const std::string _dataset )

virtual

Set the dataset name, which is a string used to access the dataset on the machine running the server.

That is, this is typically a pathname to a data file, although it doesn't have to be. This is not echoed in error messages (because that would reveal server storage patterns that data providers might want to hide). All WWW-style escapes are replaced except for spaces.

Set the dataset pathname.

Parameters

ds	The pathname (or equivalent) to the dataset.

Definition at line 253 of file BESDapResponseBuilder.cc.

void BESDapResponseBuilder::set_store_result ( std::string _sr )

virtual

Definition at line 213 of file BESDapResponseBuilder.cc.

References BESDEBUG.

void BESDapResponseBuilder::set_timeout ( int t = 0 )

Set the server's timeout value.

A value of zero (the default) means no timeout.

See also: To establish a timeout, call establish_timeout(ostream &)

Parameters

t	Server timeout in seconds. Default is zero (no timeout).

Definition at line 263 of file BESDapResponseBuilder.cc.

void BESDapResponseBuilder::split_ce	(	libdap::ConstraintEvaluator &	eval,
		const std::string &	expr = `""`
	)

virtual

Split the CE so that the server functions that compute new values are separated into their own string and can be evaluated separately from the rest of the CE (which can contain simple and slicing projection as well as other types of function calls).

Definition at line 320 of file BESDapResponseBuilder.cc.

References BESDEBUG.

Referenced by BESAsciiTransmit::send_basic_ascii().

bool BESDapResponseBuilder::store_dap2_result	(	ostream &	out,
		libdap::DDS &	dds,
		libdap::ConstraintEvaluator &	eval
	)

protected

Should this result be returned using the asynchronous response mechanism? Look at the 'store_result' property and see if the code should return this using the asynchronous mechanism.

If yes, it will try and return the correct response or an error if the server is not configured or the client has not included the correct information in the request.

Parameters

out	Write information to the client using this stream
dds	The DDS that hold information used to build the response. The response won't be built until some time in the future
eval	Use this to evaluate the CE associated with the response.

Returns: True if the response should/will be returned asynchronously, false otherwise.

OOPS. Looks like the BES is not configured to use a Stored Result Cache. Looks like need to reject the request and move on.

Client accepts async responses so, woot! lets store this thing and tell them where to find it.

Client didn't indicate a willingness to accept an async response So - we tell them that async is required.

Definition at line 559 of file BESDapResponseBuilder.cc.

References BESStoredDapResultCache::assemblePath(), BESDEBUG, BESStoredDapResultCache::get_instance(), BESKeys::get_value(), NULL, BESStoredDapResultCache::store_dap2_result(), and TheBESKeys::TheKeys().

Here is the call graph for this function:

bool BESDapResponseBuilder::store_dap4_result	(	ostream &	out,
		libdap::DMR &	dmr
	)

virtual

Should this DAP4 result be stored and the client sent an Asynchronous response? This code looks at the 'store_result' property to determine if the response should be asynchronous and then, if so, churns through the options, sorting out if the client sent the correct information indicating it knows how to process them.

If the 'store_result' property is not set, then this method simply returns false, indicating that the response should be returned using the normal synchronous response pattern.

Parameters

out	Write information about the response here
dmr	This DMR will be serialized to build the response, at some point in time

Returns: True if the response will be Asynchronous, false if the DMR should be sent right away.

OOPS. Looks like the BES is not configured to use a Stored Result Cache. Looks like need to reject the request and move on.

Client accepts async responses so, woot! lets store this thing and tell them where to find it.

Client didn't indicate a willingness to accept an async response So - we tell them that async is required.

Definition at line 1103 of file BESDapResponseBuilder.cc.

References BESStoredDapResultCache::assemblePath(), BESDEBUG, BESStoredDapResultCache::get_instance(), BESKeys::get_value(), NULL, BESStoredDapResultCache::store_dap4_result(), and TheBESKeys::TheKeys().

Here is the call graph for this function:

Friends And Related Function Documentation

friend class ResponseBuilderTest

friend

Definition at line 47 of file BESDapResponseBuilder.h.

Member Data Documentation

std::string BESDapResponseBuilder::d_async_accepted

protected

Version std::string for the library's default protocol version.

Time, if any, that the client will wait for an async response. An empty string (length=0) means the client didn't supply an async parameter

Definition at line 62 of file BESDapResponseBuilder.h.

std::string BESDapResponseBuilder::d_btp_func_ce

protected

DAP4 Server Side Function expression.

Definition at line 54 of file BESDapResponseBuilder.h.

Referenced by get_btp_func_ce().

std::string BESDapResponseBuilder::d_dap2ce

protected

Name of the dataset/database.

Definition at line 51 of file BESDapResponseBuilder.h.

std::string BESDapResponseBuilder::d_dap4ce

protected

DAP2 Constraint expression.

Definition at line 52 of file BESDapResponseBuilder.h.

std::string BESDapResponseBuilder::d_dap4function

protected

DAP4 Constraint expression.

Definition at line 53 of file BESDapResponseBuilder.h.

std::string BESDapResponseBuilder::d_dataset

protected

Definition at line 50 of file BESDapResponseBuilder.h.

std::string BESDapResponseBuilder::d_default_protocol

protected

Response timeout after N seconds.

Definition at line 56 of file BESDapResponseBuilder.h.

BESDapResponseCache* BESDapResponseBuilder::d_response_cache

protected

Definition at line 73 of file BESDapResponseBuilder.h.

std::string BESDapResponseBuilder::d_store_result

protected

If set (i.e.

non-null) then the client has asked for the result to be stored for later retrieval. The value is the service URL used to construct the stored result access URL to be returned to the client. An empty string (length=0) means the client didn't supply a store_result async parameter

Definition at line 70 of file BESDapResponseBuilder.h.

int BESDapResponseBuilder::d_timeout

protected

The BTP functions, extracted from the CE.

Definition at line 55 of file BESDapResponseBuilder.h.

The documentation for this class was generated from the following files:

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation