BESDap4ResponseHandler Class Reference

response handler that builds an OPeNDAP Dap4 data response More...

#include <BESDap4ResponseHandler.h>

Inheritance diagram for BESDap4ResponseHandler:

Collaboration diagram for BESDap4ResponseHandler:

Public Member Functions
	BESDap4ResponseHandler (const std::string &name)
virtual void	dump (std::ostream &strm) const
	dumps information about this object
virtual void	execute (BESDataHandlerInterface &dhi)
	executes the command 'get dap for def_name;'
virtual std::string	get_dmrpp_name () const
	Get the name of the DMR++ handler.
virtual BESResponseObject *	get_response_object ()
	return the current response object
virtual bool	get_use_dmrpp () const
	Is the BES.Use.Dmrpp key set in the bes.conf?
virtual BESResponseObject *	set_response_object (BESResponseObject *o)
	replaces the current response object with the specified one, returning the current response object
virtual void	transmit (BESTransmitter *transmitter, BESDataHandlerInterface &dhi)
	transmit the response object built by the execute command using the specified transmitter object

Static Public Member Functions
static BESResponseHandler *	Dap4ResponseBuilder (const std::string &name)

Protected Attributes
std::string	d_annotation_service_url
std::string	d_response_name
BESResponseObject *	d_response_object = nullptr

Friends
class	Dap4ResponseHandlerTest

Detailed Description

response handler that builds an OPeNDAP Dap4 data response

This ResponseHandler is used to build DAP4 data responses.

This class looks in the MDS for cached/stored DMR++ responses and, if found, will re-direct the request to the DMR++ requestHandler, regardless of the dataset's format and/or RequestHandler as specified by the bes.conf TypeMatch configuration. However, this can be suppressed using a configuration parameter in the bes.conf file. If the bes key BES.Use.Dmrpp is not yes, the handler does not look in the MDS for DMR++ responses and no attempt to redirect the request is made. The bes key BES.Dmrpp.Name should be set to the name of the DMR++ handler used in the key BES.modules.

See also

DMR

BESContainer

BESTransmitter

Definition at line 49 of file BESDap4ResponseHandler.h.

Constructor & Destructor Documentation

BESDap4ResponseHandler()

BESDap4ResponseHandler::BESDap4ResponseHandler

(

const std::string &

name

)

Definition at line 43 of file BESDap4ResponseHandler.cc.

~BESDap4ResponseHandler()

BESDap4ResponseHandler::~BESDap4ResponseHandler ( )

virtual

Definition at line 50 of file BESDap4ResponseHandler.cc.

Member Function Documentation

Dap4ResponseBuilder()

BESResponseHandler * BESDap4ResponseHandler::Dap4ResponseBuilder ( const std::string & name )

static

Definition at line 133 of file BESDap4ResponseHandler.cc.

dump()

void BESDap4ResponseHandler::dump ( std::ostream & strm ) const

virtual

dumps information about this object

Displays the pointer value of this instance

Parameters

strm	C++ i/o stream to dump the information to

Implements BESObj.

Definition at line 124 of file BESDap4ResponseHandler.cc.

execute()

void BESDap4ResponseHandler::execute ( BESDataHandlerInterface & dhi )

virtual

executes the command 'get dap for def_name;'

Parameters

dhi	structure that holds request and response information

See also

BESDataHandlerInterface

BESDMRResponse

BESRequestHandlerList

Implements BESResponseHandler.

Definition at line 61 of file BESDap4ResponseHandler.cc.

get_dmrpp_name()

virtual std::string BESDap4ResponseHandler::get_dmrpp_name ( ) const

inlinevirtual

Get the name of the DMR++ handler.

Returns

The value of the BES.Dmrpp.Name bes key.

Definition at line 75 of file BESDap4ResponseHandler.h.

get_response_object()

BESResponseObject * BESResponseHandler::get_response_object ( )

virtualinherited

return the current response object

Returns the current response object, null if one has not yet been created. The response handler maintains ownership of the response object.

Returns

current response object

See also

BESResponseObject

Definition at line 62 of file BESResponseHandler.cc.

get_use_dmrpp()

virtual bool BESDap4ResponseHandler::get_use_dmrpp ( ) const

inlinevirtual

Is the BES.Use.Dmrpp key set in the bes.conf?

Returns

True or false.

Definition at line 67 of file BESDap4ResponseHandler.h.

set_response_object()

BESResponseObject * BESResponseHandler::set_response_object ( BESResponseObject * o )

virtualinherited

replaces the current response object with the specified one, returning the current response object

This method is used to replace the response object with a new one, for example if during aggregation a new response object is built from the current response object.

The caller of set_response_object now owns the returned response object. The new response object is now owned by the response object.

Parameters

o	new response object used to replace the current one

Returns

the response object being replaced

See also

BESResponseObject

Definition at line 68 of file BESResponseHandler.cc.

transmit()

void BESDap4ResponseHandler::transmit ( BESTransmitter * transmitter, BESDataHandlerInterface & dhi )

virtual

transmit the response object built by the execute command using the specified transmitter object

If a response object was built then transmit it using the send_dmr method on the transmitter object.

Parameters

transmitter	object that knows how to transmit specific basic types
dhi	structure that holds the request and response information

See also

BESDMRResponse

BESTransmitter

BESDataHandlerInterface

Implements BESResponseHandler.

Definition at line 111 of file BESDap4ResponseHandler.cc.

Friends And Related Symbol Documentation

Dap4ResponseHandlerTest

friend class Dap4ResponseHandlerTest

friend

Definition at line 54 of file BESDap4ResponseHandler.h.

Member Data Documentation

d_annotation_service_url

std::string BESResponseHandler::d_annotation_service_url

protectedinherited

Definition at line 82 of file BESResponseHandler.h.

d_response_name

std::string BESResponseHandler::d_response_name

protectedinherited

Definition at line 79 of file BESResponseHandler.h.

d_response_object

BESResponseObject* BESResponseHandler::d_response_object = nullptr

protectedinherited

Definition at line 80 of file BESResponseHandler.h.

---

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

• BESDap4ResponseHandler.h
• BESDap4ResponseHandler.cc