#include <BESShowContextResponseHandler.h>
Public Member Functions | |
BESShowContextResponseHandler (const string &name) | |
virtual | ~BESShowContextResponseHandler (void) |
virtual void | execute (BESDataHandlerInterface &dhi) |
executes the command to list the current context in the BES | |
virtual void | transmit (BESTransmitter *transmitter, BESDataHandlerInterface &dhi) |
transmit the response object built by the execute command using the specified transmitter object | |
virtual void | dump (ostream &strm) const |
dumps information about this object | |
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 string | get_name () const |
return the name of this response object | |
Static Public Member Functions | |
static BESResponseHandler * | ShowContextResponseBuilder (const string &name) |
Protected Attributes | |
string | _response_name |
BESResponseObject * | _response |
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
BESShowContextResponseHandler::BESShowContextResponseHandler | ( | const string & | name | ) |
Referenced by ShowContextResponseBuilder().
BESShowContextResponseHandler::~BESShowContextResponseHandler | ( | void | ) | [virtual] |
void BESShowContextResponseHandler::dump | ( | ostream & | strm | ) | const [virtual] |
dumps information about this object
Displays the pointer value of this instance
strm | C++ i/o stream to dump the information to |
Reimplemented from BESResponseHandler.
References BESIndent::Indent(), BESIndent::LMarg(), and BESIndent::UnIndent().
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.
dhi | structure that holds request and response information |
Implements BESResponseHandler.
References BESResponseHandler::_response, _BESDataHandlerInterface::action_name, BESInfo::begin_response(), BESInfoList::build_info(), BESInfo::end_response(), BESContextManager::list_context(), SET_CONTEXT_STR, SHOW_CONTEXT_STR, BESInfoList::TheList(), and BESContextManager::TheManager().
virtual string BESResponseHandler::get_name | ( | ) | const [inline, virtual, inherited] |
return the name of this response object
This name is used to determine which response handler can handle a requested responose, such as das, dds, ddx, tab, info, version, help, etc...
References BESResponseHandler::_response_name.
BESResponseObject * BESResponseHandler::get_response_object | ( | ) | [virtual, inherited] |
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.
References BESResponseHandler::_response.
Referenced by BESDapRequestHandler::dap_build_help(), and BESDapRequestHandler::dap_build_version().
BESResponseObject * BESResponseHandler::set_response_object | ( | BESResponseObject * | o | ) | [virtual, inherited] |
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.
o | new response object used to replace the current one |
References BESResponseHandler::_response.
BESResponseHandler * BESShowContextResponseHandler::ShowContextResponseBuilder | ( | const string & | name | ) | [static] |
References BESShowContextResponseHandler().
Referenced by BESDefaultModule::initialize().
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.
transmitter | object that knows how to transmit specific basic types | |
dhi | structure that holds the request and response information |
Implements BESResponseHandler.
References BESResponseHandler::_response, and BESInfo::transmit().
BESResponseObject* BESResponseHandler::_response [protected, inherited] |
Referenced by BESResponseHandler::dump(), BESVersionResponseHandler::execute(), BESStreamResponseHandler::execute(), BESStatusResponseHandler::execute(), BESShowDefsResponseHandler::execute(), execute(), BESShowContainersResponseHandler::execute(), BESSetContextResponseHandler::execute(), BESSetContainerResponseHandler::execute(), BESProcIdResponseHandler::execute(), BESHelpResponseHandler::execute(), BESDelDefsResponseHandler::execute(), BESDelDefResponseHandler::execute(), BESDelContainersResponseHandler::execute(), BESDelContainerResponseHandler::execute(), BESDefineResponseHandler::execute(), BESDDXResponseHandler::execute(), BESDDSResponseHandler::execute(), BESDataResponseHandler::execute(), BESDASResponseHandler::execute(), BESConfigResponseHandler::execute(), BESCatalogResponseHandler::execute(), BESResponseHandler::get_response_object(), BESResponseHandler::set_response_object(), BESVersionResponseHandler::transmit(), BESStatusResponseHandler::transmit(), BESShowDefsResponseHandler::transmit(), transmit(), BESShowContainersResponseHandler::transmit(), BESSetContextResponseHandler::transmit(), BESSetContainerResponseHandler::transmit(), BESProcIdResponseHandler::transmit(), BESHelpResponseHandler::transmit(), BESDelDefsResponseHandler::transmit(), BESDelDefResponseHandler::transmit(), BESDelContainersResponseHandler::transmit(), BESDelContainerResponseHandler::transmit(), BESDefineResponseHandler::transmit(), BESDDXResponseHandler::transmit(), BESDDSResponseHandler::transmit(), BESDataResponseHandler::transmit(), BESDASResponseHandler::transmit(), BESConfigResponseHandler::transmit(), BESCatalogResponseHandler::transmit(), and BESResponseHandler::~BESResponseHandler().
string BESResponseHandler::_response_name [protected, inherited] |
Referenced by BESResponseHandler::dump(), BESDDXResponseHandler::execute(), and BESResponseHandler::get_name().