BESShowDefsResponseHandler Class Reference

response handler that returns list of definitions currently defined More...

#include <BESShowDefsResponseHandler.h>

Inheritance diagram for BESShowDefsResponseHandler:

Inheritance graph
[legend]
Collaboration diagram for BESShowDefsResponseHandler:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 BESShowDefsResponseHandler (const string &name)
virtual ~BESShowDefsResponseHandler (void)
virtual void execute (BESDataHandlerInterface &dhi)
 executes the command 'show definitions;' by returning the list of currently defined definitions
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 BESResponseObjectget_response_object ()
 return the current response object
virtual BESResponseObjectset_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 BESResponseHandlerShowDefsResponseBuilder (const string &handler_name)

Protected Attributes

string _response_name
BESResponseObject_response


Detailed Description

response handler that returns list of definitions currently defined

A request 'show definitions;' will be handled by this response handler. It returns the list of currently defined definitions and transmits the response as an informational response object.

See also:
BESResponseObject

BESContainer

BESTransmitter

BESInfo


Constructor & Destructor Documentation

BESShowDefsResponseHandler::BESShowDefsResponseHandler ( const string &  name  ) 

Referenced by ShowDefsResponseBuilder().

BESShowDefsResponseHandler::~BESShowDefsResponseHandler ( void   )  [virtual]


Member Function Documentation

void BESShowDefsResponseHandler::dump ( 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.

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

Here is the call graph for this function:

void BESShowDefsResponseHandler::execute ( BESDataHandlerInterface dhi  )  [virtual]

executes the command 'show definitions;' by returning the list of currently defined definitions

This response handler knows how to retrieve the list of definitions currently defined in the server. It simply asks the definition list to show all definitions given the BESInfo object created here.

Parameters:
dhi structure that holds request and response information
See also:
_BESDataHandlerInterface

BESInfo

BESDefinitionStorageList

Implements BESResponseHandler.

References BESResponseHandler::_response, _BESDataHandlerInterface::action_name, BESInfo::begin_response(), BESInfoList::build_info(), BESInfo::end_response(), BESDefinitionStorageList::show_definitions(), SHOWDEFS_RESPONSE_STR, BESDefinitionStorageList::TheList(), and BESInfoList::TheList().

Here is the call graph for this function:

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

Returns:
response name

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.

Returns:
current response object
See also:
BESResponseObject

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.

Parameters:
o new response object used to replace the current one
Returns:
the response object being replaced
See also:
BESResponseObject

References BESResponseHandler::_response.

BESResponseHandler * BESShowDefsResponseHandler::ShowDefsResponseBuilder ( const string &  handler_name  )  [static]

References BESShowDefsResponseHandler().

Referenced by BESDefaultModule::initialize().

Here is the call graph for this function:

void BESShowDefsResponseHandler::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.

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.

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

Here is the call graph for this function:


Member Data Documentation

Referenced by BESResponseHandler::dump(), BESVersionResponseHandler::execute(), BESStreamResponseHandler::execute(), BESStatusResponseHandler::execute(), execute(), BESShowContextResponseHandler::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(), transmit(), BESShowContextResponseHandler::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]


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

Generated on Sat May 16 07:27:19 2009 for OPeNDAP Back End Server (BES) by  doxygen 1.5.8