BESXDResponseHandler Class Reference

response handler that builds an OPeNDAP ASCII response object More...

#include <BESXDResponseHandler.h>

Inheritance diagram for BESXDResponseHandler:

Collaboration diagram for BESXDResponseHandler:

Public Member Functions
	BESXDResponseHandler (const std::string &name)
void	dump (std::ostream &strm) const override
	dumps information about this object
virtual void	execute (BESDataHandlerInterface &dhi)
	executes the command 'get ascii for <def_name>' by executing the request for each container in the specified definition.
virtual BESResponseObject *	get_response_object ()
	return the current response object
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 *	XDResponseBuilder (const std::string &name)

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

Detailed Description

response handler that builds an OPeNDAP ASCII response object

A request 'get xml_data for <def_name>;' will be handled by this response handler. Given a definition name it determines what containers are to be used to build the OPeNDAP ASCII response object. It then transmits the DataDDS object as xml_data values.

See also

DataDDS

BESContainer

BESTransmitter

Definition at line 46 of file BESXDResponseHandler.h.

Constructor & Destructor Documentation

BESXDResponseHandler()

BESXDResponseHandler::BESXDResponseHandler

(

const std::string &

name

)

Definition at line 42 of file BESXDResponseHandler.cc.

~BESXDResponseHandler()

BESXDResponseHandler::~BESXDResponseHandler ( void )

virtual

Definition at line 47 of file BESXDResponseHandler.cc.

Member Function Documentation

dump()

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

overridevirtualinherited

dumps information about this object

Displays the pointer value of this instance along with the name of this response handler and, if present, dumps the response object itself.

Parameters

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

Implements BESObj.

Reimplemented in bes::NullResponseHandler, bes::SetContextsResponseHandler, bes::ShowNodeResponseHandler, BESServicesResponseHandler, BESSetContainerResponseHandler, BESSetContextResponseHandler, BESShowContainersResponseHandler, BESShowContextResponseHandler, BESShowDefsResponseHandler, BESShowErrorResponseHandler, BESStatusResponseHandler, BESStreamResponseHandler, BESVersionResponseHandler, GatewayPathInfoResponseHandler, SampleSayResponseHandler, ShowBesKeyResponseHandler, ShowPathInfoResponseHandler, SiteMapResponseHandler, and W10nShowPathInfoResponseHandler.

Definition at line 82 of file BESResponseHandler.cc.

execute()

void BESXDResponseHandler::execute ( BESDataHandlerInterface & dhi )

virtual

executes the command 'get ascii for <def_name>' by executing the request for each container in the specified definition.

For each container in the specified definition go to the request handler for that container and have it add to the OPeNDAP DAS response object. The DAS response object is built within this method and passed to the request handler list.

Parameters

dhi	structure that holds request and response information

See also

_BESDataHandlerInterface

DAS

BESRequestHandlerList

Implements BESResponseHandler.

Definition at line 64 of file BESXDResponseHandler.cc.

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.

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 BESXDResponseHandler::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_das 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

DAS

BESTransmitter

_BESDataHandlerInterface

Implements BESResponseHandler.

Definition at line 93 of file BESXDResponseHandler.cc.

XDResponseBuilder()

BESResponseHandler * BESXDResponseHandler::XDResponseBuilder ( const std::string & name )

static

Definition at line 101 of file BESXDResponseHandler.cc.

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:

• BESXDResponseHandler.h
• BESXDResponseHandler.cc