OPeNDAP Hyrax Back End Server (BES)  Updated for version 3.8.3
BESShowContainersResponseHandler Class Reference

response handler that returns list of continers currently defined in all container storage lists. More...

#include <BESShowContainersResponseHandler.h>

Inheritance diagram for BESShowContainersResponseHandler:
Inheritance graph
Collaboration diagram for BESShowContainersResponseHandler:
Collaboration graph

Public Member Functions

 BESShowContainersResponseHandler (const string &name)
 
virtual void dump (ostream &strm) const
 dumps information about this object More...
 
virtual void execute (BESDataHandlerInterface &dhi)
 executes the command 'show containers;' by returning the list of currently defined containers in all container stores More...
 
virtual string get_name () const
 return the name of this response object 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...
 
virtual ~BESShowContainersResponseHandler (void)
 

Static Public Member Functions

static BESResponseHandlerShowContainersResponseBuilder (const string &name)
 

Protected Attributes

BESResponseObject_response
 
string _response_name
 

Detailed Description

response handler that returns list of continers currently defined in all container storage lists.

A request 'show containers;' will be handled by this response handler. It returns the list of currently defined containers for each container storage registered with the server and transmits the response as an informational response.

See also
BESResponseObject
BESContainerStorage
BESContainerStorageList
BESContainer
BESTransmitter

Definition at line 52 of file BESShowContainersResponseHandler.h.

Constructor & Destructor Documentation

◆ BESShowContainersResponseHandler()

BESShowContainersResponseHandler::BESShowContainersResponseHandler ( const string &  name)

Definition at line 39 of file BESShowContainersResponseHandler.cc.

Referenced by ShowContainersResponseBuilder().

◆ ~BESShowContainersResponseHandler()

BESShowContainersResponseHandler::~BESShowContainersResponseHandler ( void  )
virtual

Definition at line 44 of file BESShowContainersResponseHandler.cc.

Member Function Documentation

◆ dump()

void BESShowContainersResponseHandler::dump ( 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 104 of file BESShowContainersResponseHandler.cc.

References BESResponseHandler::dump(), BESIndent::Indent(), BESIndent::LMarg(), and BESIndent::UnIndent().

Here is the call graph for this function:

◆ execute()

void BESShowContainersResponseHandler::execute ( BESDataHandlerInterface dhi)
virtual

executes the command 'show containers;' by returning the list of currently defined containers in all container stores

This response handler knows how to retrieve information about all containers stored with any container storage objects. This response handler creates a BESInfo response object to store the container information.

Parameters
dhistructure that holds request and response information
See also
BESDataHandlerInterface
BESInfo
BESContainerStorageList
BESContainerStorage
BESContainer

Implements BESResponseHandler.

Definition at line 63 of file BESShowContainersResponseHandler.cc.

References BESResponseHandler::_response, BESDataHandlerInterface::action_name, BESInfo::begin_response(), BESInfoList::build_info(), BESInfo::end_response(), BESContainerStorageList::show_containers(), SHOWCONTAINERS_RESPONSE_STR, BESInfoList::TheList(), and BESContainerStorageList::TheList().

Here is the call graph for this function:

◆ get_name()

virtual string BESResponseHandler::get_name ( ) const
inlinevirtualinherited

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...

Returns
response name

Definition at line 156 of file BESResponseHandler.h.

References BESResponseHandler::_response_name, and BESResponseHandler::dump().

Here is the call graph for this function:

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

References BESResponseHandler::_response.

Referenced by BESDapRequestHandler::dap_build_help(), BESDapRequestHandler::dap_build_version(), and BESDataHandlerInterface::get_response_object().

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

References BESResponseHandler::_response.

◆ ShowContainersResponseBuilder()

BESResponseHandler * BESShowContainersResponseHandler::ShowContainersResponseBuilder ( const string &  name)
static

Definition at line 114 of file BESShowContainersResponseHandler.cc.

References BESShowContainersResponseHandler().

Referenced by BESDefaultModule::initialize().

Here is the call graph for this function:

◆ transmit()

void BESShowContainersResponseHandler::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 (BESInfo) then transmit it as text.

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 85 of file BESShowContainersResponseHandler.cc.

References BESResponseHandler::_response, and BESInfo::transmit().

Here is the call graph for this function:

Member Data Documentation

◆ _response

BESResponseObject* BESResponseHandler::_response
protectedinherited

Definition at line 85 of file BESResponseHandler.h.

Referenced by BESResponseHandler::dump(), BESStreamResponseHandler::execute(), BESServicesResponseHandler::execute(), BESProcIdResponseHandler::execute(), BESStatusResponseHandler::execute(), BESConfigResponseHandler::execute(), BESDDSResponseHandler::execute(), BESShowDefsResponseHandler::execute(), BESDataResponseHandler::execute(), BESDASResponseHandler::execute(), BESVersionResponseHandler::execute(), BESDelContainerResponseHandler::execute(), BESShowContextResponseHandler::execute(), execute(), BESCatalogResponseHandler::execute(), BESHelpResponseHandler::execute(), BESDataDDXResponseHandler::execute(), BESDelContainersResponseHandler::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(), BESShowDefsResponseHandler::transmit(), BESConfigResponseHandler::transmit(), BESDDSResponseHandler::transmit(), BESStatusResponseHandler::transmit(), BESDataResponseHandler::transmit(), BESDASResponseHandler::transmit(), BESVersionResponseHandler::transmit(), BESDelContainerResponseHandler::transmit(), BESShowContextResponseHandler::transmit(), BESDataDDXResponseHandler::transmit(), BESCatalogResponseHandler::transmit(), BESDelContainersResponseHandler::transmit(), BESHelpResponseHandler::transmit(), transmit(), BESSetContextResponseHandler::transmit(), BESDelDefsResponseHandler::transmit(), BESDDXResponseHandler::transmit(), BESDelDefResponseHandler::transmit(), BESSetContainerResponseHandler::transmit(), BESDefineResponseHandler::transmit(), and BESResponseHandler::~BESResponseHandler().

◆ _response_name

string BESResponseHandler::_response_name
protectedinherited

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