bes  Updated for version 3.20.6
ShowPathInfoResponseHandler Class Reference

response handler that returns nodes or leaves within the catalog either at the root or at a specified node. More...

#include <ShowPathInfoResponseHandler.h>

Collaboration diagram for ShowPathInfoResponseHandler:
Collaboration graph

Public Member Functions

virtual void dump (std::ostream &strm) const
 dumps information about this object More...
 
void eval_resource_path (const std::string &resource_path, const std::string &catalog_root, const bool follow_sym_links, std::string &validPath, bool &isFile, bool &isDir, long long &size, long long &lastModifiedTime, bool &canRead, std::string &remainder)
 
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. More...
 
virtual BESResponseObjectget_response_object ()
 return the current response object More...
 
virtual BESResponseObjectset_response_object (BESResponseObject *o)
 replaces the current response object with the specified one, returning the current response object More...
 
 ShowPathInfoResponseHandler (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 More...
 

Static Public Member Functions

static BESResponseHandlerShowPathInfoResponseBuilder (const std::string &name)
 

Protected Attributes

std::string d_annotation_service_url
 
std::string d_response_name
 
BESResponseObjectd_response_object
 

Detailed Description

response handler that returns nodes or leaves within the catalog either at the root or at a specified node.

A request 'show catalog [for <node>];' or 'show leaves for <node>; will be handled by this response handler. It returns nodes or leaves either at the root level if no node is specified in the request, or the nodes or leaves under the specified node.

See also
BESResponseObject
BESContainer
BESTransmitter

Definition at line 51 of file ShowPathInfoResponseHandler.h.

Member Function Documentation

◆ dump()

void ShowPathInfoResponseHandler::dump ( std::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 BESResponseHandler.

Definition at line 261 of file ShowPathInfoResponseHandler.cc.

◆ execute()

void ShowPathInfoResponseHandler::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
dhistructure that holds request and response information
See also
BESDataHandlerInterface
BESInfo
BESRequestHandlerList

Implements BESResponseHandler.

Definition at line 99 of file ShowPathInfoResponseHandler.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 82 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
onew response object used to replace the current one
Returns
the response object being replaced
See also
BESResponseObject

Definition at line 88 of file BESResponseHandler.cc.

◆ transmit()

void ShowPathInfoResponseHandler::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
transmitterobject that knows how to transmit specific basic types
dhistructure that holds the request and response information
See also
BESInfo
BESTransmitter
BESDataHandlerInterface

Implements BESResponseHandler.

Definition at line 246 of file ShowPathInfoResponseHandler.cc.


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