OPeNDAP Hyrax Back End Server (BES)
Updated for version 3.8.3
|
response handler that lists the context name/value pairs More...
#include <BESShowContextResponseHandler.h>
Public Member Functions | |
BESShowContextResponseHandler (const string &name) | |
virtual void | dump (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 string | get_name () const |
return the name of this response 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 void | transmit (BESTransmitter *transmitter, BESDataHandlerInterface &dhi) |
transmit the response object built by the execute command using the specified transmitter object | |
virtual | ~BESShowContextResponseHandler (void) |
Static Public Member Functions | |
static BESResponseHandler * | ShowContextResponseBuilder (const string &name) |
Protected Attributes | |
BESResponseObject * | _response |
string | _response_name |
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
Definition at line 51 of file BESShowContextResponseHandler.h.
BESShowContextResponseHandler::BESShowContextResponseHandler | ( | const string & | name | ) |
Definition at line 39 of file BESShowContextResponseHandler.cc.
Referenced by ShowContextResponseBuilder().
|
virtual |
Definition at line 44 of file BESShowContextResponseHandler.cc.
|
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.
Definition at line 106 of file BESShowContextResponseHandler.cc.
References BESIndent::Indent(), BESIndent::LMarg(), and BESIndent::UnIndent().
|
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.
Definition at line 63 of file BESShowContextResponseHandler.cc.
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().
|
inlinevirtualinherited |
return the name of this response object
This name is used to determine which response handler can handle a requested response, such as das, dds, ddx, tab, info, version, help, etc...
Definition at line 156 of file BESResponseHandler.h.
References BESResponseHandler::_response_name.
|
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.
Definition at line 53 of file BESResponseHandler.cc.
References BESResponseHandler::_response.
Referenced by DapRequestHandler::dap_build_das(), DapRequestHandler::dap_build_data(), DapRequestHandler::dap_build_dds(), DapRequestHandler::dap_build_help(), BESDapRequestHandler::dap_build_help(), DapRequestHandler::dap_build_vers(), BESDapRequestHandler::dap_build_version(), and BESDataHandlerInterface::get_response_object().
|
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.
o | new response object used to replace the current one |
Definition at line 59 of file BESResponseHandler.cc.
References BESResponseHandler::_response.
|
static |
Definition at line 116 of file BESShowContextResponseHandler.cc.
References BESShowContextResponseHandler().
Referenced by BESDefaultModule::initialize().
|
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.
Definition at line 87 of file BESShowContextResponseHandler.cc.
References BESResponseHandler::_response, and BESInfo::transmit().
|
protectedinherited |
Definition at line 85 of file BESResponseHandler.h.
Referenced by BESResponseHandler::dump(), BESStreamResponseHandler::execute(), BESProcIdResponseHandler::execute(), BESServicesResponseHandler::execute(), BESShowDefsResponseHandler::execute(), BESStatusResponseHandler::execute(), BESConfigResponseHandler::execute(), BESDDSResponseHandler::execute(), BESDataResponseHandler::execute(), BESDASResponseHandler::execute(), BESVersionResponseHandler::execute(), BESDelContainerResponseHandler::execute(), execute(), BESHelpResponseHandler::execute(), BESDataDDXResponseHandler::execute(), BESDelContainersResponseHandler::execute(), BESShowContainersResponseHandler::execute(), BESCatalogResponseHandler::execute(), BESSetContextResponseHandler::execute(), BESDelDefResponseHandler::execute(), BESDelDefsResponseHandler::execute(), BESDDXResponseHandler::execute(), BESSetContainerResponseHandler::execute(), BESDefineResponseHandler::execute(), BESResponseHandler::get_response_object(), BESResponseHandler::set_response_object(), BESServicesResponseHandler::transmit(), BESProcIdResponseHandler::transmit(), BESStatusResponseHandler::transmit(), BESDDSResponseHandler::transmit(), BESShowDefsResponseHandler::transmit(), BESConfigResponseHandler::transmit(), BESVersionResponseHandler::transmit(), BESDataResponseHandler::transmit(), BESDASResponseHandler::transmit(), BESDelContainerResponseHandler::transmit(), transmit(), BESDelContainersResponseHandler::transmit(), BESHelpResponseHandler::transmit(), BESShowContainersResponseHandler::transmit(), BESCatalogResponseHandler::transmit(), BESDataDDXResponseHandler::transmit(), BESDelDefsResponseHandler::transmit(), BESDDXResponseHandler::transmit(), BESSetContextResponseHandler::transmit(), BESDelDefResponseHandler::transmit(), BESSetContainerResponseHandler::transmit(), BESDefineResponseHandler::transmit(), and BESResponseHandler::~BESResponseHandler().
|
protectedinherited |
Definition at line 84 of file BESResponseHandler.h.
Referenced by BESResponseHandler::dump(), BESDataDDXResponseHandler::execute(), BESDDXResponseHandler::execute(), and BESResponseHandler::get_name().