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

#include <BESXMLShowErrorCommand.h>

Inheritance diagram for BESXMLShowErrorCommand:
Collaboration diagram for BESXMLShowErrorCommand:

List of all members.

Public Member Functions

 BESXMLShowErrorCommand (const BESDataHandlerInterface &base_dhi)
virtual void dump (ostream &strm) const
 dumps information about this object
virtual BESDataHandlerInterfaceget_dhi ()
 Return the current BESDataHandlerInterface.
virtual bool has_response ()
 Has a response handler been created given the request document?
virtual void parse_request (xmlNode *node)
 parse a set context command.
virtual void prep_request ()
 Prepare any information needed to execute the request of this command.
virtual ~BESXMLShowErrorCommand ()

Static Public Member Functions

static void add_command (const string &cmd_str, p_xmlcmd_builder cmd)
 Add a command to the possible commands allowed by this BES.
static BESXMLCommandCommandBuilder (const BESDataHandlerInterface &base_dhi)
static bool del_command (const string &cmd_str)
 Deletes the command called cmd_str from the list of possible commands.
static p_xmlcmd_builder find_command (const string &cmd_str)
 Find the BESXMLCommand creation function with the given name.

Protected Member Functions

virtual void set_response ()
 The request has been parsed, use the command action name to set the response handler.

Protected Attributes

BESDataHandlerInterface _dhi
string _str_cmd

Detailed Description

Definition at line 39 of file BESXMLShowErrorCommand.h.


Constructor & Destructor Documentation

virtual BESXMLShowErrorCommand::~BESXMLShowErrorCommand ( ) [inline, virtual]

Definition at line 43 of file BESXMLShowErrorCommand.h.


Member Function Documentation

void BESXMLCommand::add_command ( const string &  cmd_str,
p_xmlcmd_builder  cmd 
) [static, inherited]

Add a command to the possible commands allowed by this BES.

This adds a function to parse a specific BES command within the BES request document using the given name. If a command element is found with the name cmd_str, then the XMLCommand object is created using the passed cmd object.

Parameters:
cmd_strThe name of the command
cmdThe function to call to create the BESXMLCommand object

Definition at line 85 of file BESXMLCommand.cc.

Referenced by BESXMLDefaultCommands::initialize(), and BESXMLDapCommandModule::initialize().

Definition at line 108 of file BESXMLShowErrorCommand.cc.

References BESXMLShowErrorCommand().

Referenced by BESXMLDefaultCommands::initialize().

Here is the call graph for this function:

bool BESXMLCommand::del_command ( const string &  cmd_str) [static, inherited]

Deletes the command called cmd_str from the list of possible commands.

Parameters:
cmd_strThe name of the command to remove from the list

Definition at line 96 of file BESXMLCommand.cc.

Referenced by BESXMLDefaultCommands::terminate(), and BESXMLDapCommandModule::terminate().

void BESXMLShowErrorCommand::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 BESXMLCommand.

Definition at line 98 of file BESXMLShowErrorCommand.cc.

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

Here is the call graph for this function:

p_xmlcmd_builder BESXMLCommand::find_command ( const string &  cmd_str) [static, inherited]

Find the BESXMLCommand creation function with the given name.

Parameters:
cmd_strThe name of the command creation function to find

Definition at line 113 of file BESXMLCommand.cc.

Referenced by BESXMLInterface::build_data_request_plan(), and BESXMLGetCommand::parse_request().

virtual BESDataHandlerInterface& BESXMLCommand::get_dhi ( ) [inline, virtual, inherited]

Return the current BESDataHandlerInterface.

Since there can be multiple commands within a single request document, different interface objects can be created. This returns the current interface object

Returns:
The current BESDataHandlerInterface object

Reimplemented in BESXMLGetCommand.

Definition at line 87 of file BESXMLCommand.h.

References BESXMLCommand::_dhi.

Referenced by BESXMLInterface::build_data_request_plan(), BESXMLInterface::clean(), and BESXMLGetCommand::get_dhi().

virtual bool BESXMLShowErrorCommand::has_response ( ) [inline, virtual]

Has a response handler been created given the request document?

Returns:
true if a response handler has been set, false otherwise

Implements BESXMLCommand.

Definition at line 47 of file BESXMLShowErrorCommand.h.

void BESXMLShowErrorCommand::parse_request ( xmlNode *  node) [virtual]

parse a set context command.

<showError type="error_type_num" />

Where error_type_num is one of the following 1. Internal Error - the error is internal to the BES Server 2. Internal Fatal Error - error is fatal, can not continue 3. Syntax User Error - the requester has a syntax error in request or config 4. Forbidden Error - the requester is forbidden to see the resource 5. Not Found Error - the resource can not be found

Parameters:
nodexml2 element node pointer

Implements BESXMLCommand.

Definition at line 60 of file BESXMLShowErrorCommand.cc.

References BESXMLCommand::_dhi, BESXMLCommand::_str_cmd, BESDataHandlerInterface::action, BESDataHandlerInterface::data, BESXMLUtils::GetNodeInfo(), BESXMLCommand::set_response(), SHOW_ERROR, SHOW_ERROR_STR, and SHOW_ERROR_TYPE.

Here is the call graph for this function:

virtual void BESXMLCommand::prep_request ( ) [inline, virtual, inherited]

Prepare any information needed to execute the request of this command.

Reimplemented in BESXMLDefineCommand, BESXMLGetCommand, and BESXMLGetDataDDXCommand.

Definition at line 78 of file BESXMLCommand.h.

Referenced by BESXMLGetCommand::prep_request().


Member Data Documentation


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