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

#include <BESDelDefResponseHandler.h>

Inheritance diagram for BESDelDefResponseHandler:

Public Member Functions
	BESDelDefResponseHandler (const string &name)

virtual void	dump (ostream &strm) const
	dumps information about this object More...

virtual void	execute (BESDataHandlerInterface &dhi)
	executes the command to delete a definition More...

virtual string	get_name () const
	return the name of this response object More...

virtual BESResponseObject *	get_response_object ()
	return the current response object More...

virtual BESResponseObject *	set_response_object (BESResponseObject *o)
	replaces the current response object with the specified one, returning the current response object More...

virtual void	transmit (BESTransmitter *transmitter, BESDataHandlerInterface &dhi)
	transmit the response object built by the execute command using the specified transmitter object More...

Static Public Member Functions
static BESResponseHandler *	DelDefResponseBuilder (const string &name)

Protected Attributes
BESResponseObject *	_response

string	_response_name

Detailed Description

Possible requests handled by this response handler are:

delete definition <def_name> [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 BESDelDefResponseHandler.h.

Member Function Documentation

void BESDelDefResponseHandler::dump ( ostream & strm ) const

virtual

Displays the pointer value of this instance

Parameters

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

Reimplemented from BESResponseHandler.

Definition at line 148 of file BESDelDefResponseHandler.cc.

References BESResponseHandler::dump().

void BESDelDefResponseHandler::execute ( BESDataHandlerInterface & dhi )

virtual

Removes a definition from a specified definition storage found in BESDefinitionStorageList::TheList(). 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 definition.

Parameters

dhi	structure that holds request and response information

Exceptions

BESSyntaxUserError if unable to delete the specified definition from the specified definition store. object

See also: BESDataHandlerInterface; BESSilentInfo; BESDefine; BESDefinitionStorage; BESDefinitionStorageList

Implements BESResponseHandler.

Definition at line 75 of file BESDelDefResponseHandler.cc.

References BESDataHandlerInterface::data, BESDefinitionStorage::del_definition(), and BESDefinitionStorageList::find_persistence().

virtual string BESResponseHandler::get_name ( ) const

inlinevirtualinherited

This name is used to determine which response handler can handle a requested response, such as das, dds, ddx, tab, info, version, help, etc...

Returns: response name

Definition at line 156 of file BESResponseHandler.h.

References BESResponseHandler::dump().

BESResponseObject * BESResponseHandler::get_response_object ( )

virtualinherited

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 53 of file BESResponseHandler.cc.

BESResponseObject * BESResponseHandler::set_response_object ( BESResponseObject * o )

virtualinherited

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 59 of file BESResponseHandler.cc.

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

virtual

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 129 of file BESDelDefResponseHandler.cc.

References BESInfo::transmit().

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

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Member Function Documentation