#include <FFRequestHandler.h>

Inheritance diagram for FFRequestHandler:

Collaboration diagram for FFRequestHandler:

Public Types
typedef map< string, p_request_handler >::const_iterator	Handler_citer

typedef map< string, p_request_handler >::iterator	Handler_iter

Public Member Functions
virtual bool	add_handler (const string &handler_name, p_request_handler handler_method)
	add a handler method to the request handler that knows how to fill in a specific response object More...

virtual void	dump (ostream &strm) const
	dumps information about this object More...

	FFRequestHandler (const string &name)

virtual p_request_handler	find_handler (const string &handler_name)
	find the method that can handle the specified response object type More...

virtual string	get_handler_names ()
	return a comma separated list of response object types handled by this request handler More...

virtual const string &	get_name () const

virtual bool	remove_handler (const string &handler_name)
	remove the specified handler method from this request handler More...

virtual	~FFRequestHandler (void)

Static Public Member Functions
static bool	ff_build_das (BESDataHandlerInterface &dhi)

static bool	ff_build_data (BESDataHandlerInterface &dhi)

static bool	ff_build_dds (BESDataHandlerInterface &dhi)

static bool	ff_build_dmr (BESDataHandlerInterface &dhi)
	Build the DMR object. More...

static bool	ff_build_help (BESDataHandlerInterface &dhi)

static bool	ff_build_version (BESDataHandlerInterface &dhi)

static string	get_RSS_format_files ()

static bool	get_RSS_format_support ()

Detailed Description

Definition at line 33 of file FFRequestHandler.h.

Member Typedef Documentation

typedef map< string, p_request_handler >::const_iterator BESRequestHandler::Handler_citer

inherited

Definition at line 83 of file BESRequestHandler.h.

typedef map< string, p_request_handler >::iterator BESRequestHandler::Handler_iter

inherited

Definition at line 84 of file BESRequestHandler.h.

Constructor & Destructor Documentation

FFRequestHandler::FFRequestHandler ( const string & name )

Definition at line 80 of file FFRequestHandler.cc.

References BESRequestHandler::add_handler(), BESDEBUG, DAP4DATA_RESPONSE, DAS_RESPONSE, DATA_RESPONSE, DDS_RESPONSE, DMR_RESPONSE, ff_build_das(), ff_build_data(), ff_build_dds(), ff_build_dmr(), ff_build_help(), ff_build_version(), ff_register_functions(), BESKeys::get_value(), HELP_RESPONSE, BESUtil::lowercase(), TheBESKeys::TheKeys(), and VERS_RESPONSE.

Here is the call graph for this function:

FFRequestHandler::~FFRequestHandler ( void )

virtual

Definition at line 120 of file FFRequestHandler.cc.

Member Function Documentation

bool BESRequestHandler::add_handler	(	const string &	handler_name,
		p_request_handler	handler_method
	)

virtualinherited

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 51 of file BESRequestHandler.cc.

References BESRequestHandler::find_handler().

Referenced by BESAsciiRequestHandler::BESAsciiRequestHandler(), BESDapRequestHandler::BESDapRequestHandler(), BESUsageRequestHandler::BESUsageRequestHandler(), BESWWWRequestHandler::BESWWWRequestHandler(), BESXDRequestHandler::BESXDRequestHandler(), CSVRequestHandler::CSVRequestHandler(), DapRequestHandler::DapRequestHandler(), FFRequestHandler(), FitsRequestHandler::FitsRequestHandler(), FoJsonRequestHandler::FoJsonRequestHandler(), FONcRequestHandler::FONcRequestHandler(), FONgRequestHandler::FONgRequestHandler(), GatewayRequestHandler::GatewayRequestHandler(), GDALRequestHandler::GDALRequestHandler(), HDF4RequestHandler::HDF4RequestHandler(), HDF5RequestHandler::HDF5RequestHandler(), ncml_module::NCMLRequestHandler::NCMLRequestHandler(), NCRequestHandler::NCRequestHandler(), and W10nJsonRequestHandler::W10nJsonRequestHandler().

Here is the call graph for this function:

void BESRequestHandler::dump ( ostream & strm ) const

virtualinherited

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 DapRequestHandler, ncml_module::NCMLRequestHandler, FONcRequestHandler, FoJsonRequestHandler, W10nJsonRequestHandler, BESDapRequestHandler, CSVRequestHandler, BESAsciiRequestHandler, BESUsageRequestHandler, BESWWWRequestHandler, FONgRequestHandler, FitsRequestHandler, BESXDRequestHandler, and GatewayRequestHandler.

Definition at line 135 of file BESRequestHandler.cc.

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

Referenced by GatewayRequestHandler::dump(), BESXDRequestHandler::dump(), FONgRequestHandler::dump(), FitsRequestHandler::dump(), BESAsciiRequestHandler::dump(), CSVRequestHandler::dump(), BESDapRequestHandler::dump(), BESUsageRequestHandler::dump(), BESWWWRequestHandler::dump(), FoJsonRequestHandler::dump(), W10nJsonRequestHandler::dump(), FONcRequestHandler::dump(), ncml_module::NCMLRequestHandler::dump(), DapRequestHandler::dump(), and BESRequestHandlerList::dump().

Here is the call graph for this function:

bool FFRequestHandler::ff_build_das ( BESDataHandlerInterface & dhi )

static

Definition at line 124 of file FFRequestHandler.cc.

References BESContainer::access(), BESDASResponse::clear_container(), BESDataHandlerInterface::container, ff_get_attributes(), find_ancillary_rss_das(), BESDASResponse::get_das(), BESResponseHandler::get_response_object(), get_RSS_format_support(), BESContainer::get_symbolic_name(), BESDataHandlerInterface::response_handler, and BESDASResponse::set_container().

Referenced by FFRequestHandler().

Here is the call graph for this function:

bool FFRequestHandler::ff_build_data ( BESDataHandlerInterface & dhi )

static

Definition at line 213 of file FFRequestHandler.cc.

References BESContainer::access(), BufPtr, BufSiz, BufVal, BESDataDDSResponse::clear_container(), BESDataHandlerInterface::container, ff_get_attributes(), ff_read_descriptors(), BESDataDDSResponse::get_dds(), BESResponseHandler::get_response_object(), BESContainer::get_symbolic_name(), NULL, BESDataHandlerInterface::response_handler, BESDapResponse::set_constraint(), BESDASResponse::set_container(), and BESDataDDSResponse::set_container().

Referenced by FFRequestHandler().

Here is the call graph for this function:

bool FFRequestHandler::ff_build_dds ( BESDataHandlerInterface & dhi )

static

Definition at line 166 of file FFRequestHandler.cc.

References BESContainer::access(), BESDEBUG, BESDDSResponse::clear_container(), BESDataHandlerInterface::container, ff_get_attributes(), ff_read_descriptors(), BESDDSResponse::get_dds(), BESResponseHandler::get_response_object(), BESContainer::get_symbolic_name(), BESDataHandlerInterface::response_handler, BESDapResponse::set_constraint(), BESDASResponse::set_container(), and BESDDSResponse::set_container().

Referenced by FFRequestHandler().

Here is the call graph for this function:

bool FFRequestHandler::ff_build_dmr ( BESDataHandlerInterface & dhi )

static

Build the DMR object.

This is used for both the DAP4 DMR and Data responses. This version of the method uses the DMR's 'DDS constructor'.

Parameters

dhi

Returns: True on success or throw an exception on error.

Definition at line 266 of file FFRequestHandler.cc.

References BESContainer::access(), BufPtr, BufSiz, BufVal, BESDataHandlerInterface::container, ff_get_attributes(), ff_read_descriptors(), BESDMRResponse::get_dmr(), BESResponseHandler::get_response_object(), NULL, BESDataHandlerInterface::response_handler, BESDapResponse::set_dap4_constraint(), and BESDapResponse::set_dap4_function().

Referenced by FFRequestHandler().

Here is the call graph for this function:

bool FFRequestHandler::ff_build_help ( BESDataHandlerInterface & dhi )

static

Definition at line 324 of file FFRequestHandler.cc.

References BESInfo::begin_tag(), BESInfo::end_tag(), FF_NAME, BESResponseHandler::get_response_object(), BESUtil::implode(), PACKAGE_NAME, PACKAGE_VERSION, BESDataHandlerInterface::response_handler, BESServiceRegistry::services_handled(), and BESServiceRegistry::TheRegistry().

Referenced by FFRequestHandler().

Here is the call graph for this function:

bool FFRequestHandler::ff_build_version ( BESDataHandlerInterface & dhi )

static

Definition at line 350 of file FFRequestHandler.cc.

References BESVersionInfo::add_module(), BESResponseHandler::get_response_object(), PACKAGE_NAME, PACKAGE_VERSION, and BESDataHandlerInterface::response_handler.

Referenced by FFRequestHandler().

Here is the call graph for this function:

p_request_handler BESRequestHandler::find_handler ( const string & handler_name )

virtualinherited

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 93 of file BESRequestHandler.cc.

Referenced by BESRequestHandler::add_handler(), BESRequestHandlerList::execute_all(), and BESRequestHandlerList::execute_current().

string BESRequestHandler::get_handler_names ( )

virtualinherited

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.

virtual const string& BESRequestHandler::get_name ( ) const

inlinevirtualinherited

Definition at line 86 of file BESRequestHandler.h.

static string FFRequestHandler::get_RSS_format_files ( )

inlinestatic

Definition at line 51 of file FFRequestHandler.h.

Referenced by find_ancillary_rss_das(), and find_ancillary_rss_formats().

static bool FFRequestHandler::get_RSS_format_support ( )

inlinestatic

Definition at line 50 of file FFRequestHandler.h.

Referenced by ff_build_das(), ff_read_descriptors(), and read_attributes().

bool BESRequestHandler::remove_handler ( const string & handler_name )

virtualinherited

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 70 of file BESRequestHandler.cc.

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

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation