SiteMapResponseHandler Class Reference

Response handler that returns a site map. More...

#include <SiteMapResponseHandler.h>

Inheritance diagram for SiteMapResponseHandler:

Collaboration diagram for SiteMapResponseHandler:

Public Member Functions
virtual void	dump (std::ostream &strm) const
	dumps information about this object
virtual void	execute (BESDataHandlerInterface &dhi)
	executes the command 'show catalog|leaves [for <node>];' by returning nodes or leaves at the top level or at the specified node.
virtual BESResponseObject *	get_response_object ()
	return the current response object
virtual BESResponseObject *	set_response_object (BESResponseObject *o)
	replaces the current response object with the specified one, returning the current response object
	SiteMapResponseHandler (const std::string &name)
virtual void	transmit (BESTransmitter *transmitter, BESDataHandlerInterface &dhi)
	transmit the response object built by the execute command using the specified transmitter object

Static Public Member Functions
static BESResponseHandler *	SiteMapResponseBuilder (const std::string &name)

Protected Attributes
std::string	d_annotation_service_url
std::string	d_response_name
BESResponseObject *	d_response_object = nullptr

Detailed Description

Response handler that returns a site map.

This ResponseHandler returns a simple text site map for the BES's catalogs (or a specific catalog, if that optional parameter is given in the command). Previous versions of the command wrote the site map to a file at the top level of the file system the BES uses for the default catalog. This version returns the site map to the caller (and does not store it on the BES).

By design, the BES allows users to choose the kinds of 'Info' objects that are returned for these kinds of 'show' commands. However, the BESXMLInfo response object is not really correct for the site map since there is a specific 'XML format' for site maps and it's much more structured than the simple text listing of pathnames we're using. For this reason, the site map response handler uses a BESTextInfo object to return the response, regardless of the BES's default Info object configuration.

See also

BESResponseObject

BESContainer

BESTransmitter

Definition at line 58 of file SiteMapResponseHandler.h.

Constructor & Destructor Documentation

SiteMapResponseHandler()

SiteMapResponseHandler::SiteMapResponseHandler

(

const std::string &

name

)

Definition at line 61 of file SiteMapResponseHandler.cc.

~SiteMapResponseHandler()

SiteMapResponseHandler::~SiteMapResponseHandler ( )

virtual

Definition at line 66 of file SiteMapResponseHandler.cc.

Member Function Documentation

dump()

void SiteMapResponseHandler::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 BESResponseHandler.

Definition at line 171 of file SiteMapResponseHandler.cc.

execute()

void SiteMapResponseHandler::execute ( BESDataHandlerInterface & dhi )

virtual

executes the command 'show catalog|leaves [for <node>];' by returning nodes or leaves at the top level or at the specified node.

The response object BESInfo is created to store the information.

Parameters

dhi	structure that holds request and response information

See also

BESDataHandlerInterface

BESInfo

BESRequestHandlerList

Implements BESResponseHandler.

Definition at line 80 of file SiteMapResponseHandler.cc.

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

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

o	new response object used to replace the current one

Returns

the response object being replaced

See also

BESResponseObject

Definition at line 68 of file BESResponseHandler.cc.

SiteMapResponseBuilder()

BESResponseHandler * SiteMapResponseHandler::SiteMapResponseBuilder ( const std::string & name )

static

Definition at line 180 of file SiteMapResponseHandler.cc.

transmit()

void SiteMapResponseHandler::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

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.

Definition at line 156 of file SiteMapResponseHandler.cc.

Member Data Documentation

d_annotation_service_url

std::string BESResponseHandler::d_annotation_service_url

protectedinherited

Definition at line 82 of file BESResponseHandler.h.

d_response_name

std::string BESResponseHandler::d_response_name

protectedinherited

Definition at line 79 of file BESResponseHandler.h.

d_response_object

BESResponseObject* BESResponseHandler::d_response_object = nullptr

protectedinherited

Definition at line 80 of file BESResponseHandler.h.

---

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

• SiteMapResponseHandler.h
• SiteMapResponseHandler.cc