ShowBesKeyCommand Class Reference

Inheritance diagram for ShowBesKeyCommand:

Collaboration diagram for ShowBesKeyCommand:

Public Member Functions
virtual void	dump (std::ostream &strm) const
	dumps information about this object
virtual BESDataHandlerInterface &	get_xmlcmd_dhi ()
	Return the current BESDataHandlerInterface.
virtual bool	has_response ()
	Does this command return a response to the client?
virtual void	parse_request (xmlNode *node)
	parse a show command. No properties or children elements
virtual void	prep_request ()
	Prepare any information needed to execute the request of this command.
	ShowBesKeyCommand (const BESDataHandlerInterface &base_dhi)

Static Public Member Functions
static void	add_command (const std::string &cmd_str, p_xmlcmd_builder cmd)
	Add a command to the possible commands allowed by this BES.
static BESXMLCommand *	CommandBuilder (const BESDataHandlerInterface &base_dhi)
static void	del_command (const std::string &cmd_str)
	Deletes the command called cmd_str from the list of possible commands.
static p_xmlcmd_builder	find_command (const std::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
std::string	d_cmd_log_info
	Used only for the log.
BESDataHandlerInterface	d_xmlcmd_dhi

Detailed Description

Definition at line 40 of file ShowBesKeyCommand.h.

Constructor & Destructor Documentation

ShowBesKeyCommand()

ShowBesKeyCommand::ShowBesKeyCommand

(

const BESDataHandlerInterface &

base_dhi

)

Definition at line 42 of file ShowBesKeyCommand.cc.

~ShowBesKeyCommand()

virtual ShowBesKeyCommand::~ShowBesKeyCommand ( )

inlinevirtual

Definition at line 43 of file ShowBesKeyCommand.h.

Member Function Documentation

add_command()

void BESXMLCommand::add_command ( const std::string & cmd_str, p_xmlcmd_builder cmd )

staticinherited

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_str	The name of the command
cmd	The function to call to create the BESXMLCommand object

Definition at line 88 of file BESXMLCommand.cc.

CommandBuilder()

BESXMLCommand * ShowBesKeyCommand::CommandBuilder ( const BESDataHandlerInterface & base_dhi )

static

Definition at line 108 of file ShowBesKeyCommand.cc.

del_command()

void BESXMLCommand::del_command ( const std::string & cmd_str )

staticinherited

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

Parameters

cmd_str

The name of the command to remove from the list

Definition at line 98 of file BESXMLCommand.cc.

dump()

void ShowBesKeyCommand::dump ( std::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 BESXMLCommand.

Definition at line 99 of file ShowBesKeyCommand.cc.

find_command()

p_xmlcmd_builder BESXMLCommand::find_command ( const std::string & cmd_str )

staticinherited

Find the BESXMLCommand creation function with the given name.

Parameters

cmd_str

The name of the command creation function to find

Definition at line 110 of file BESXMLCommand.cc.

get_xmlcmd_dhi()

virtual BESDataHandlerInterface & BESXMLCommand::get_xmlcmd_dhi ( )

inlinevirtualinherited

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 121 of file BESXMLCommand.h.

has_response()

virtual bool ShowBesKeyCommand::has_response ( )

inlinevirtual

Does this command return a response to the client?

Every command has an associated ResponseHandler, but not all ResponseHandlers return information to the BES's client. In fact, for any group of commands sent to the BES, only one can return information (except for errors, which stop command processing). If this command does not normally return a response (text or binary data), the value of this method should be false.

Returns

true if it returns a response, false otherwise

Implements BESXMLCommand.

Definition at line 49 of file ShowBesKeyCommand.h.

parse_request()

void ShowBesKeyCommand::parse_request ( xmlNode * node )

virtual

parse a show command. No properties or children elements

<showBesKey key="key_name" />

Parameters

node	xml2 element node pointer

Implements BESXMLCommand.

Definition at line 56 of file ShowBesKeyCommand.cc.

prep_request()

virtual void BESXMLCommand::prep_request ( )

inlinevirtualinherited

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

Reimplemented in BESXMLDefineCommand, BESXMLGetCommand, BESXMLGetDataDDXCommand, ncml_module::NCMLCacheAggXMLCommand, and SampleSayXMLCommand.

Definition at line 108 of file BESXMLCommand.h.

set_response()

void BESXMLCommand::set_response ( )

protectedvirtualinherited

The request has been parsed, use the command action name to set the response handler.

Definition at line 65 of file BESXMLCommand.cc.

Member Data Documentation

d_cmd_log_info

std::string BESXMLCommand::d_cmd_log_info

protectedinherited

Used only for the log.

Definition at line 75 of file BESXMLCommand.h.

d_xmlcmd_dhi

BESDataHandlerInterface BESXMLCommand::d_xmlcmd_dhi

protectedinherited

Definition at line 71 of file BESXMLCommand.h.

---

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

• ShowBesKeyCommand.h
• ShowBesKeyCommand.cc