BESShowContextResponseHandler Class Reference

response handler that lists the context name/value pairs More...

#include <BESShowContextResponseHandler.h>

Inheritance diagram for BESShowContextResponseHandler:

Collaboration diagram for BESShowContextResponseHandler:

Public Member Functions
	BESShowContextResponseHandler (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 list the current context in the BES
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 *	ShowContextResponseBuilder (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 lists the context name/value pairs

This response handler list all context name/vallue pairs currently set within the system with the command:

show context;

The response is an informational object

See also

BESResponseObject

BESContainer

BESTransmitter

Definition at line 51 of file BESShowContextResponseHandler.h.

Constructor & Destructor Documentation

BESShowContextResponseHandler()

BESShowContextResponseHandler::BESShowContextResponseHandler

(

const std::string &

name

)

Definition at line 43 of file BESShowContextResponseHandler.cc.

~BESShowContextResponseHandler()

BESShowContextResponseHandler::~BESShowContextResponseHandler ( void )

virtual

Definition at line 48 of file BESShowContextResponseHandler.cc.

Member Function Documentation

dump()

void BESShowContextResponseHandler::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

Reimplemented from BESResponseHandler.

Definition at line 110 of file BESShowContextResponseHandler.cc.

execute()

void BESShowContextResponseHandler::execute ( BESDataHandlerInterface & dhi )

virtual

executes the command to list the current context in the BES

Context in the BES refers to name/value pairs set in the BES to help direct the operation of the BES. For example, there might be an error display context, an error context, a response context (make them all silent), a test run context (don't actually execute the commands, just go through the motions). This response handler knows how to retrieve the list of context name/value pairs.

Parameters

dhi	structure that holds request and response information

See also

BESDataHandlerInterface

BESInfo

BESContextManager

Implements BESResponseHandler.

Definition at line 67 of file BESShowContextResponseHandler.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.

ShowContextResponseBuilder()

BESResponseHandler * BESShowContextResponseHandler::ShowContextResponseBuilder ( const std::string & name )

static

Definition at line 120 of file BESShowContextResponseHandler.cc.

transmit()

void BESShowContextResponseHandler::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 91 of file BESShowContextResponseHandler.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:

• BESShowContextResponseHandler.h
• BESShowContextResponseHandler.cc