Represents a specific data type request handler. More...

#include <BESRequestHandler.h>

Inheritance diagram for BESRequestHandler:

Collaboration diagram for BESRequestHandler:

Public Types
typedef std::map< std::string, p_request_handler_method >::const_iterator	Handler_citer

typedef std::map< std::string, p_request_handler_method >::iterator	Handler_iter

Public Member Functions
virtual void	add_attributes (BESDataHandlerInterface &)

virtual bool	add_handler (const std::string &name, p_request_handler_method method)
	Backward compatibility with the older version of this class.

virtual bool	add_method (const std::string &name, p_request_handler_method method)
	add a handler method to the request handler that knows how to fill in a specific response object

	BESRequestHandler (const std::string &name)

virtual void	dump (std::ostream &strm) const
	dumps information about this object

virtual p_request_handler_method	find_method (const std::string &name)
	find the method that can handle the specified response object type

virtual time_t	get_lmt (const std::string &name)
	Get the Last modified time for.

virtual std::string	get_method_names ()
	return a comma separated list of response object types handled by this request handler

virtual const std::string &	get_name () const

virtual bool	remove_method (const std::string &name)
	remove the specified handler method from this request handler

Detailed Description

Represents a specific data type request handler.

A request handler is an object that represents a specific data type. The specific data type knows how to fill in a response object, such as a DAS, DDS, help, version, etc... response object.

The response handlers know how to build the specified response object, and the request handler knows how to fill them in.

Each container in the BESDataHandlerInterface has an associated data type for that data container, such as Cedar, NetCDF, CDF, HDF, etc... Usually, in a given request, only one data type is requested. In other words, at least currently, it is rare to see a request asking for information from more than one type of data.

Each data request handler is registered with the server. When a request comes in, the request handler is looked up for each of those data types and is passed the information it needs to fill in the specified response object.

Each request handler can handle different types of response objects. Methods are registered within the request handler for the responses that the request handler can fill in. This method is looked up and is passed the information to fill in the response object.

Definition at line 74 of file BESRequestHandler.h.

Member Typedef Documentation

◆ Handler_citer

typedef std::map<std::string,p_request_handler_method>::const_iterator BESRequestHandler::Handler_citer

Definition at line 89 of file BESRequestHandler.h.

◆ Handler_iter

typedef std::map<std::string,p_request_handler_method>::iterator BESRequestHandler::Handler_iter

Definition at line 90 of file BESRequestHandler.h.

Constructor & Destructor Documentation

◆ BESRequestHandler()

BESRequestHandler::BESRequestHandler ( const std::string & name )

inline

Definition at line 80 of file BESRequestHandler.h.

◆ ~BESRequestHandler()

virtual BESRequestHandler::~BESRequestHandler ( void )

inlinevirtual

Definition at line 85 of file BESRequestHandler.h.

Member Function Documentation

◆ add_attributes()

void BESRequestHandler::add_attributes ( BESDataHandlerInterface & )

virtual

Definition at line 150 of file BESRequestHandler.cc.

◆ add_handler()

virtual bool BESRequestHandler::add_handler	(	const std::string &	name,
		p_request_handler_method	method )

inlinevirtual

Backward compatibility with the older version of this class.

Deprecated

Definition at line 101 of file BESRequestHandler.h.

◆ add_method()

bool BESRequestHandler::add_method	(	const std::string &	name,
		p_request_handler_method	handler_method )

virtual

add a handler method to the request handler that knows how to fill in a specific response object

Add a handler method for a specific response object to the request handler. The handler method takes a reference to a BESDataHandlerInterface and returns bool, true if the response object is filled in successfully by the method, false otherwise.

Parameters

handler_name	name of the response object this method can fill in
handler_method	a function pointer to the method that can fill in the specified response object

Returns: true if the handler is added, false if it already exists

See also: BESResponseObject; BESResponseNames

Definition at line 58 of file BESRequestHandler.cc.

◆ dump()

void BESRequestHandler::dump ( std::ostream & strm ) const

virtual

dumps information about this object

Displays the pointer value of this instance, the name of the request handler, and the names of all registered handler functions

Parameters

strm	C++ i/o stream to dump the information to

Implements BESObj.

Reimplemented in BESAsciiRequestHandler, BESDapRequestHandler, BESUsageRequestHandler, BESWWWRequestHandler, BESXDRequestHandler, builddmrpp::BuildDmrppRequestHandler, CSVRequestHandler, DapFunctionsRequestHandler, DapRequestHandler, dmrpp::DmrppRequestHandler, FitsRequestHandler, FoCovJsonRequestHandler, FoJsonRequestHandler, FONcRequestHandler, gateway::GatewayRequestHandler, ncml_module::NCMLRequestHandler, ngap::NgapRequestHandler, s3::S3RequestHandler, SampleRequestHandler, and W10nJsonRequestHandler.

Definition at line 164 of file BESRequestHandler.cc.

◆ find_method()

p_request_handler_method BESRequestHandler::find_method ( const std::string & name )

virtual

find the method that can handle the specified response object type

Find the method that can handle the specified response object type. The response object type is the same as the handler name.

Parameters

handler_name name of the method that can fill in the response object type

Returns: the method that can fill in the specified response object type

See also: BESResponseObject; BESResponseNames

Definition at line 95 of file BESRequestHandler.cc.

◆ get_lmt()

time_t BESRequestHandler::get_lmt ( const std::string & name )

virtual

Get the Last modified time for.

name

Handlers that need a more sophisticated method should subclass.

Parameters

name

Returns: The LMT

Definition at line 133 of file BESRequestHandler.cc.

◆ get_method_names()

string BESRequestHandler::get_method_names ( )

virtual

return a comma separated list of response object types handled by this request handler

Returns: the comma separated list of response object types

See also: BESResponseObject; BESResponseNames

Definition at line 112 of file BESRequestHandler.cc.

◆ get_name()

virtual const std::string & BESRequestHandler::get_name ( ) const

inlinevirtual

Definition at line 92 of file BESRequestHandler.h.

◆ remove_method()

bool BESRequestHandler::remove_method ( const std::string & name )

virtual

remove the specified handler method from this request handler

Parameters

handler_name name of the method to be removed, same as the name of the response object

Returns: true if successfully removed, false if not found

See also: BESResponseNames

Definition at line 74 of file BESRequestHandler.cc.

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

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ Handler_citer

◆ Handler_iter

Constructor & Destructor Documentation

◆ BESRequestHandler()

◆ ~BESRequestHandler()

Member Function Documentation

◆ add_attributes()

◆ add_handler()

◆ add_method()

◆ dump()

◆ find_method()

◆ get_lmt()

◆ get_method_names()

◆ get_name()

◆ remove_method()