BESCatalogResponseHandler Class Reference

response handler that returns nodes or leaves within the catalog either at the root or at a specified node. More...

#include <BESCatalogResponseHandler.h>

Inheritance diagram for BESCatalogResponseHandler:

Collaboration diagram for BESCatalogResponseHandler:

Public Member Functions
	BESCatalogResponseHandler (const std::string &name)
virtual void	dump (std::ostream &strm) const
	dumps information about this object
virtual void	execute (BESDataHandlerInterface &dhi)
	Execute the showCatalog command.
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 *	CatalogResponseBuilder (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 returns nodes or leaves within the catalog either at the root or at a specified node.

Deprecated

Use the showNode command instead. jhrg 7/25/18

See also

BESResponseObject

BESContainer

BESTransmitter

Definition at line 47 of file BESCatalogResponseHandler.h.

Constructor & Destructor Documentation

BESCatalogResponseHandler()

BESCatalogResponseHandler::BESCatalogResponseHandler

(

const std::string &

name

)

Definition at line 56 of file BESCatalogResponseHandler.cc.

~BESCatalogResponseHandler()

BESCatalogResponseHandler::~BESCatalogResponseHandler ( void )

virtual

Definition at line 61 of file BESCatalogResponseHandler.cc.

Member Function Documentation

CatalogResponseBuilder()

BESResponseHandler * BESCatalogResponseHandler::CatalogResponseBuilder ( const std::string & name )

static

Definition at line 172 of file BESCatalogResponseHandler.cc.

dump()

void BESCatalogResponseHandler::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 163 of file BESCatalogResponseHandler.cc.

execute()

void BESCatalogResponseHandler::execute ( BESDataHandlerInterface & dhi )

virtual

Execute the showCatalog command.

The response object BESInfo is created to store the information.

Parameters

dhi	structure that holds request and response information

See also

BESDataHandlerInterface

BESInfo

BESRequestHandlerList

Implements BESResponseHandler.

Definition at line 74 of file BESCatalogResponseHandler.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 BESCatalogResponseHandler::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 as text

Parameters

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

See also

BESInfo

BESTransmitter

BESDataHandlerInterface

Implements BESResponseHandler.

Definition at line 148 of file BESCatalogResponseHandler.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:

• BESCatalogResponseHandler.h
• BESCatalogResponseHandler.cc