_BESDataHandlerInterface Struct Reference

Structure storing information used by the BES to handle the request. More...

#include <BESDataHandlerInterface.h>

Collaboration diagram for _BESDataHandlerInterface:

Collaboration graph
[legend]
List of all members.

Public Types

typedef map< string, string
>::const_iterator 
data_citer

Public Member Functions

 _BESDataHandlerInterface ()
void first_container ()
 set the container pointer to the first container in the containers list
void next_container ()
 set the container pointer to the next * container in the list, null if at the end or no containers in list
const map< string, string > & data_c () const
void dump (ostream &strm) const

Public Attributes

BESResponseHandlerresponse_handler
list< BESContainercontainers
list< BESContainer >::iterator containers_iterator
BESContainercontainer
 pointer to current container in this interface
string action
 the response object requested, e.g. das, dds
string action_name
string transmit_protocol
 request protocol, such as HTTP
map< string, string > data
 the map of string data that will be required for the current request.
BESInfoerror_info
 error information object

Detailed Description

Structure storing information used by the BES to handle the request.

This information is used throughout the BES framework to handle the request and to also store information for logging and reporting.

Definition at line 57 of file BESDataHandlerInterface.h.


Member Typedef Documentation

typedef map<string, string>::const_iterator _BESDataHandlerInterface::data_citer

Definition at line 109 of file BESDataHandlerInterface.h.


Constructor & Destructor Documentation

_BESDataHandlerInterface::_BESDataHandlerInterface (  )  [inline]

Definition at line 59 of file BESDataHandlerInterface.h.


Member Function Documentation

void _BESDataHandlerInterface::first_container (  )  [inline]

set the container pointer to the first container in the containers list

Definition at line 75 of file BESDataHandlerInterface.h.

References container, containers, and containers_iterator.

Referenced by BESStreamResponseHandler::execute(), BESDefineResponseHandler::execute(), BESRequestHandlerList::execute_each(), BESRequestHandlerList::execute_once(), BESDefineCommand::parse_request(), constraintT::run(), BESDapTransmit::send_basic_das(), BESFilterTransmitter::send_basic_data(), BESDapTransmit::send_basic_data(), BESFilterTransmitter::send_basic_dds(), BESDapTransmit::send_basic_dds(), BESFilterTransmitter::send_basic_ddx(), and BESDapTransmit::send_basic_ddx().

void _BESDataHandlerInterface::next_container (  )  [inline]

set the container pointer to the next * container in the list, null if at the end or no containers in list

Definition at line 86 of file BESDataHandlerInterface.h.

References container, containers, and containers_iterator.

Referenced by BESDefineResponseHandler::execute(), BESRequestHandlerList::execute_each(), BESDefineCommand::parse_request(), and constraintT::run().

const map<string, string>& _BESDataHandlerInterface::data_c (  )  const [inline]

Definition at line 108 of file BESDataHandlerInterface.h.

References data.

void BESDataHandlerInterface::dump ( ostream &  strm  )  const

Definition at line 40 of file BESDataHandlerInterface.cc.

References action, action_name, container, containers, data, BESInfo::dump(), BESContainer::dump(), BESResponseHandler::dump(), error_info, BESIndent::Indent(), BESIndent::LMarg(), response_handler, transmit_protocol, and BESIndent::UnIndent().

Referenced by BESCmdInterface::build_data_request_plan(), BESInterface::dump(), and operator<<().

Here is the call graph for this function:


Member Data Documentation

BESResponseHandler* _BESDataHandlerInterface::response_handler

Definition at line 64 of file BESDataHandlerInterface.h.

Referenced by BESCgiInterface::build_data_request_plan(), TestRequestHandler::cdf_build_help(), BESInterface::clean(), BESDapRequestHandler::dap_build_help(), BESDapRequestHandler::dap_build_version(), dump(), BESInterface::execute_data_request_plan(), OPENDAP_CLASSRequestHandler::OPENDAP_TYPE_build_help(), OPENDAP_CLASSRequestHandler::OPENDAP_TYPE_build_vers(), BESCmdParser::parse(), and BESInterface::transmit_data().

list<BESContainer> _BESDataHandlerInterface::containers

Definition at line 66 of file BESDataHandlerInterface.h.

Referenced by BESCgiInterface::build_data_request_plan(), dump(), BESStreamResponseHandler::execute(), first_container(), next_container(), BESGetCommand::parse_request(), BESDefineCommand::parse_request(), and constraintT::run().

list<BESContainer>::iterator _BESDataHandlerInterface::containers_iterator

Definition at line 67 of file BESDataHandlerInterface.h.

Referenced by first_container(), and next_container().

BESContainer* _BESDataHandlerInterface::container

pointer to current container in this interface

Definition at line 71 of file BESDataHandlerInterface.h.

Referenced by dump(), BESStreamResponseHandler::execute(), BESDefineResponseHandler::execute(), BESRequestHandlerList::execute_current(), BESRequestHandlerList::execute_each(), first_container(), next_container(), BESDefineCommand::parse_request(), BESConstraintFuncs::post_append(), BESDapTransmit::send_basic_das(), BESDapTransmit::send_basic_dds(), and BESDapTransmit::send_basic_ddx().

string _BESDataHandlerInterface::action

the response object requested, e.g. das, dds

Definition at line 97 of file BESDataHandlerInterface.h.

Referenced by BESCgiInterface::build_data_request_plan(), dump(), BESDDXResponseHandler::execute(), BESRequestHandlerList::execute_all(), BESRequestHandlerList::execute_current(), BESInterface::execute_data_request_plan(), TestCommand::parse_request(), BESShowCommand::parse_request(), BESSetContextCommand::parse_request(), BESSetContainerCommand::parse_request(), BESGetCommand::parse_request(), BESDelDefsCommand::parse_request(), BESDelDefCommand::parse_request(), BESDelContainersCommand::parse_request(), BESDelContainerCommand::parse_request(), BESDefineCommand::parse_request(), and BESCatalogCommand::parse_request().

string _BESDataHandlerInterface::action_name

Definition at line 98 of file BESDataHandlerInterface.h.

Referenced by dump(), BESVersionResponseHandler::execute(), BESStatusResponseHandler::execute(), BESShowDefsResponseHandler::execute(), BESShowContextResponseHandler::execute(), BESShowContainersResponseHandler::execute(), BESSetContextResponseHandler::execute(), BESSetContainerResponseHandler::execute(), BESProcIdResponseHandler::execute(), BESKeysResponseHandler::execute(), BESHelpResponseHandler::execute(), BESDelDefsResponseHandler::execute(), BESDelDefResponseHandler::execute(), BESDelContainersResponseHandler::execute(), BESDelContainerResponseHandler::execute(), BESDefineResponseHandler::execute(), BESDDXResponseHandler::execute(), BESDDSResponseHandler::execute(), BESDataResponseHandler::execute(), BESDASResponseHandler::execute(), BESCatalogResponseHandler::execute(), and BESExceptionManager::handle_exception().

string _BESDataHandlerInterface::transmit_protocol

request protocol, such as HTTP

Definition at line 102 of file BESDataHandlerInterface.h.

Referenced by BESCgiInterface::BESCgiInterface(), TestRequestHandler::cdf_build_help(), dump(), BESApacheInterface::exception_manager(), BESCmdInterface::initialize(), and BESApacheInterface::initialize().

map<string, string> _BESDataHandlerInterface::data

the map of string data that will be required for the current request.

Definition at line 107 of file BESDataHandlerInterface.h.

Referenced by BESCmdInterface::BESCmdInterface(), BESCmdInterface::build_data_request_plan(), BESCmdInterface::clean(), data_c(), dump(), BESInterface::end_request(), BESSetContextResponseHandler::execute(), BESSetContainerResponseHandler::execute(), BESDelDefsResponseHandler::execute(), BESDelDefResponseHandler::execute(), BESDelContainersResponseHandler::execute(), BESDelContainerResponseHandler::execute(), BESDefineResponseHandler::execute(), BESCatalogResponseHandler::execute(), BESInterface::execute_data_request_plan(), BESCmdInterface::execute_data_request_plan(), BESInterface::initialize(), BESCmdInterface::initialize(), BESApacheInterface::initialize(), BESInterface::invoke_aggregation(), BESCmdInterface::invoke_aggregation(), BESCmdInterface::log_status(), BESSetCommand::parse_options(), BESDefineCommand::parse_options(), BESSetContextCommand::parse_request(), BESSetContainerCommand::parse_request(), BESGetCommand::parse_request(), BESDelDefsCommand::parse_request(), BESDelDefCommand::parse_request(), BESDelContainersCommand::parse_request(), BESDelContainerCommand::parse_request(), BESDefineCommand::parse_request(), BESCatalogCommand::parse_request(), BESConstraintFuncs::post_append(), constraintT::run(), BESFilterTransmitter::send_basic_data(), BESDapTransmit::send_basic_data(), BESFilterTransmitter::send_basic_dds(), BESDapTransmit::send_basic_dds(), BESFilterTransmitter::send_basic_ddx(), BESDapTransmit::send_basic_ddx(), BESInterface::transmit_data(), and BESCmdInterface::transmit_data().

BESInfo* _BESDataHandlerInterface::error_info

error information object

Definition at line 113 of file BESDataHandlerInterface.h.

Referenced by dump(), BESInterface::execute_request(), BESExceptionManager::handle_exception(), TestException::handleException(), BESDapHandlerException::handleException(), BESCmdInterface::log_status(), and BESInterface::transmit_data().


The documentation for this struct was generated from the following files:
Generated on Wed Aug 29 03:27:47 2007 for OPeNDAP Back End Server (BES) by  doxygen 1.5.2