BESDelDefsResponseHandler Class Reference

response handler that deletes all definitions from a specified definition store. More...

#include <BESDelDefsResponseHandler.h>

Inheritance diagram for BESDelDefsResponseHandler:

Collaboration diagram for BESDelDefsResponseHandler:

Public Member Functions
	BESDelDefsResponseHandler (const std::string &name)
virtual void	dump (std::ostream &strm) const
	dumps information about this object
virtual void	execute (BESDataHandlerInterface &dhi)
	executes the command to delete a container, a definition, or all definitions.
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 *	DelDefsResponseBuilder (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 deletes all definitions from a specified definition store.

Possible requests handled by this response handler are:

delete definitions [from <store_name>];

An informational response object is created and returned to the requester to inform them whether the request was successful.

See also

BESResponseObject

BESDefine

BESDefinitionStorage

BESTransmitter

Definition at line 53 of file BESDelDefsResponseHandler.h.

Constructor & Destructor Documentation

BESDelDefsResponseHandler()

BESDelDefsResponseHandler::BESDelDefsResponseHandler

(

const std::string &

name

)

Definition at line 54 of file BESDelDefsResponseHandler.cc.

~BESDelDefsResponseHandler()

BESDelDefsResponseHandler::~BESDelDefsResponseHandler ( void )

virtual

Definition at line 59 of file BESDelDefsResponseHandler.cc.

Member Function Documentation

DelDefsResponseBuilder()

BESResponseHandler * BESDelDefsResponseHandler::DelDefsResponseBuilder ( const std::string & name )

static

Definition at line 147 of file BESDelDefsResponseHandler.cc.

dump()

void BESDelDefsResponseHandler::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 138 of file BESDelDefsResponseHandler.cc.

execute()

void BESDelDefsResponseHandler::execute ( BESDataHandlerInterface & dhi )

virtual

executes the command to delete a container, a definition, or all definitions.

Removes all definitions from the specified definition store. If no definition store is specified, the default is volatile.

The response built is a silent informational object. The only response that a client would receive would be if there were an exception thrown attempting to delete the definitions from the store.

Parameters

dhi	structure that holds request and response information

Exceptions

BESSyntaxUserError

if unable to delete all definitions from the specified definition store. object

See also

BESDataHandlerInterface

BESSilentInfo

BESDefine

BESDefinitionStorage

BESDefinitionStorageList

Implements BESResponseHandler.

Definition at line 83 of file BESDelDefsResponseHandler.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 BESDelDefsResponseHandler::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 using the specified transmitter object.

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 119 of file BESDelDefsResponseHandler.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:

• BESDelDefsResponseHandler.h
• BESDelDefsResponseHandler.cc