bes  Updated for version 3.17.4
BESServiceRegistry Class Reference

The service registry allows modules to register services with the BES that they provide. More...

#include <BESServiceRegistry.h>

Inheritance diagram for BESServiceRegistry:
Inheritance graph

Public Member Functions

virtual void add_format (const string &service, const string &cmd, const string &format)
 add a format response to a command of a service More...
 
virtual void add_service (const string &name)
 Add a service to the BES. More...
 
virtual void add_to_service (const string &service, const string &cmd, const string &cmd_descript, const string &format)
 This function allows callers to add to a service that already exists. More...
 
virtual bool does_handle_service (const string &handler, const string &service)
 Asks if the specified handler can handle the specified service. More...
 
virtual void dump (ostream &strm) const
 dumps information about this object More...
 
virtual void handles_service (const string &handler, const string &service)
 The specified handler can handle the specified service. More...
 
virtual void remove_service (const string &name)
 remove a service from the BES More...
 
virtual bool service_available (const string &name, const string &cmd="", const string &format="")
 Determines if a service and, optionally, a command and a return format, is available. More...
 
virtual void services_handled (const string &handler, list< string > &services)
 returns the list of servies provided by the handler in question More...
 
virtual void show_services (BESInfo &info)
 fills in the response object for the <showService /> request More...
 

Static Public Member Functions

static BESServiceRegistryTheRegistry ()
 

Detailed Description

For example, the dap service provides the das, dds, ddx, and dods commands as part of its service. Data handlers, such as that provided in the nc_module for netcdf data, can register that it can provide the dap services by calling the handle_services call.

Also provided by this class is the response body for the <showServices >/ command, returning the list of services, the commands provided by that services, and the description of those commands

Definition at line 60 of file BESServiceRegistry.h.

Member Function Documentation

◆ add_format()

void BESServiceRegistry::add_format ( const string &  service,
const string &  cmd,
const string &  format 
)
virtual
Parameters
servicename of the service to add the format to
cmdthe command in the service to add the format to
formatthe format to add
Exceptions
BESInternalErrorif the service or command do not exist or if the format has already been registered.

Definition at line 124 of file BESServiceRegistry.cc.

◆ add_service()

void BESServiceRegistry::add_service ( const string &  name)
virtual
Parameters
namename of the service to be added
Exceptions
BESInternalErrorif the service already exists

Definition at line 53 of file BESServiceRegistry.cc.

◆ add_to_service()

void BESServiceRegistry::add_to_service ( const string &  service,
const string &  cmd,
const string &  cmd_descript,
const string &  format 
)
virtual

For example, the dap-server modules add to the dap service the three commands ascii, html_form, and info_page. These three responses use the three basic commands of the dap service, das, dds, and datadds.

Parameters
servicename of the service to add the commands to
cmdthe command being added to the service
cmd_descriptthe description of the command being added to the service
formatthe format of the command being added to the service
Exceptions
BESInternalErrorif the service does not exist or the command is already reigstered with the service

Definition at line 84 of file BESServiceRegistry.cc.

◆ does_handle_service()

bool BESServiceRegistry::does_handle_service ( const string &  handler,
const string &  service 
)
virtual

Does the specified handler provide the specified service.

Parameters
handlername of the handler to check
servicename of the service the handler might handle
Returns
true if the handler does provide the service, false otherwise

Definition at line 303 of file BESServiceRegistry.cc.

◆ dump()

void BESServiceRegistry::dump ( ostream &  strm) const
virtual

Displays the pointer value of this instance along with information about the service registry

Parameters
strmC++ i/o stream to dump the information to

Implements BESObj.

Definition at line 391 of file BESServiceRegistry.cc.

◆ handles_service()

void BESServiceRegistry::handles_service ( const string &  handler,
const string &  service 
)
virtual

This function lets the BES know that the specifie dhandler can handle the services provided by service. For example, the netcdf_handler registeres that it can handle the dap services, meaning that it can fill in the DAP responses.

Parameters
handlername of the data handler being registered
servicename of the service the handler now provides
Exceptions
BESInternalErrorif the service does not exist

Definition at line 265 of file BESServiceRegistry.cc.

◆ remove_service()

void BESServiceRegistry::remove_service ( const string &  service)
virtual

This function removes the specified service from the BES, meaning that the service is no longer provided by the BES. It also removes the service from any handlers that registered to handle the service

Parameters
servicename of the service to remove

Definition at line 176 of file BESServiceRegistry.cc.

◆ service_available()

bool BESServiceRegistry::service_available ( const string &  service,
const string &  cmd = "",
const string &  format = "" 
)
virtual

Given a service name and possibly a command name and return format, determine if that service is available and, if not empty, if the service provides the specified command.

Parameters
servicethe name of the service in question
cmdthe service command in question, defaults to empty string
formatthe service return format in question, defaults to empty string
Returns
true if the service is available and, if provided, the command is provided by the service and, if format is provided, the return format of the service and command

Definition at line 216 of file BESServiceRegistry.cc.

◆ services_handled()

void BESServiceRegistry::services_handled ( const string &  handler,
list< string > &  services 
)
virtual

If the handler is not found, then the services list will be empty

Parameters
handlername of the handler to inquire about
servicesout parameter that will hold the services provided by the handler

Definition at line 328 of file BESServiceRegistry.cc.

◆ show_services()

void BESServiceRegistry::show_services ( BESInfo info)
virtual

This function is called to fill in the response object for the <showServices /> request. It adds each of the services and the commands provided by that service.

Parameters
infoThe BES informational object that will hold the response

Definition at line 352 of file BESServiceRegistry.cc.


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