bes Updated for version 3.21.1
The Backend Server (BES) is the lower two tiers of the Hyrax data server
ncml_module::NCMLRequestHandler Class Reference

#include <NCMLRequestHandler.h>

Inheritance diagram for ncml_module::NCMLRequestHandler:
Inheritance graph
Collaboration diagram for ncml_module::NCMLRequestHandler:
Collaboration graph

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
 
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
 
 NCMLRequestHandler (const std::string &name)
 
virtual bool remove_method (const std::string &name)
 remove the specified handler method from this request handler
 

Static Public Member Functions

static std::string get_global_attributes_container_name ()
 
static bool ncml_build_das (BESDataHandlerInterface &dhi)
 
static bool ncml_build_data (BESDataHandlerInterface &dhi)
 
static bool ncml_build_dds (BESDataHandlerInterface &dhi)
 
static bool ncml_build_dmr (BESDataHandlerInterface &dhi)
 
static bool ncml_build_help (BESDataHandlerInterface &dhi)
 
static bool ncml_build_vers (BESDataHandlerInterface &dhi)
 

Detailed Description

Handler for AIS Using NCML

Definition at line 40 of file NCMLRequestHandler.h.

Member Typedef Documentation

◆ Handler_citer

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

Definition at line 89 of file BESRequestHandler.h.

◆ Handler_iter

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

Definition at line 90 of file BESRequestHandler.h.

Constructor & Destructor Documentation

◆ NCMLRequestHandler()

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

Definition at line 85 of file NCMLRequestHandler.cc.

◆ ~NCMLRequestHandler()

NCMLRequestHandler::~NCMLRequestHandler ( void )
virtual

Definition at line 111 of file NCMLRequestHandler.cc.

Member Function Documentation

◆ add_attributes()

void BESRequestHandler::add_attributes ( BESDataHandlerInterface & )
virtualinherited

Definition at line 150 of file BESRequestHandler.cc.

◆ add_handler()

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

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 )
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_namename of the response object this method can fill in
handler_methoda 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 NCMLRequestHandler::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
strmC++ i/o stream to dump the information to

Reimplemented from BESRequestHandler.

Definition at line 410 of file NCMLRequestHandler.cc.

◆ find_method()

p_request_handler_method BESRequestHandler::find_method ( const std::string & 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_namename 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_global_attributes_container_name()

static std::string ncml_module::NCMLRequestHandler::get_global_attributes_container_name ( )
inlinestatic

Definition at line 65 of file NCMLRequestHandler.h.

◆ get_lmt()

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

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 ( )
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.

◆ get_name()

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

Definition at line 92 of file BESRequestHandler.h.

◆ ncml_build_das()

bool NCMLRequestHandler::ncml_build_das ( BESDataHandlerInterface & dhi)
static

Definition at line 166 of file NCMLRequestHandler.cc.

◆ ncml_build_data()

bool NCMLRequestHandler::ncml_build_data ( BESDataHandlerInterface & dhi)
static

Definition at line 283 of file NCMLRequestHandler.cc.

◆ ncml_build_dds()

bool NCMLRequestHandler::ncml_build_dds ( BESDataHandlerInterface & dhi)
static

Definition at line 198 of file NCMLRequestHandler.cc.

◆ ncml_build_dmr()

bool NCMLRequestHandler::ncml_build_dmr ( BESDataHandlerInterface & dhi)
static

Definition at line 319 of file NCMLRequestHandler.cc.

◆ ncml_build_help()

bool NCMLRequestHandler::ncml_build_help ( BESDataHandlerInterface & dhi)
static

Definition at line 385 of file NCMLRequestHandler.cc.

◆ ncml_build_vers()

bool NCMLRequestHandler::ncml_build_vers ( BESDataHandlerInterface & dhi)
static

Definition at line 376 of file NCMLRequestHandler.cc.

◆ remove_method()

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

remove the specified handler method from this request handler

Parameters
handler_namename 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: