bes  Updated for version 3.20.6
BESShowContextResponseHandler Class Reference

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

#include <BESShowContextResponseHandler.h>

Collaboration diagram for BESShowContextResponseHandler:
Collaboration graph

Public Member Functions

 BESShowContextResponseHandler (const std::string &name)
 
virtual void dump (std::ostream &strm) const
 dumps information about this object More...
 
virtual void execute (BESDataHandlerInterface &dhi)
 executes the command to list the current context in the BES More...
 
virtual BESResponseObjectget_response_object ()
 return the current response object More...
 
virtual BESResponseObjectset_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 BESResponseHandlerShowContextResponseBuilder (const std::string &name)
 

Protected Attributes

std::string d_annotation_service_url
 
std::string d_response_name
 
BESResponseObjectd_response_object
 

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.

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
strmC++ 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
dhistructure 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 82 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
onew response object used to replace the current one
Returns
the response object being replaced
See also
BESResponseObject

Definition at line 88 of file BESResponseHandler.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
transmitterobject that knows how to transmit specific basic types
dhistructure that holds the request and response information
See also
BESInfo
BESTransmitter
BESDataHandlerInterface

Implements BESResponseHandler.

Definition at line 91 of file BESShowContextResponseHandler.cc.


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