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

#include <BESServiceRegistry.h>

Inheritance diagram for BESServiceRegistry:

Collaboration diagram for BESServiceRegistry:

Public Member Functions
virtual void	add_format (const std::string &service, const std::string &cmd, const std::string &format)
	add a format response to a command of a service

virtual void	add_service (const std::string &name)
	Add a service to the BES.

virtual void	add_to_service (const std::string &service, const std::string &cmd, const std::string &cmd_descript, const std::string &format)
	This function allows callers to add to a service that already exists.

virtual bool	does_handle_service (const std::string &handler, const std::string &service)
	Asks if the specified handler can handle the specified service.

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

virtual void	handles_service (const std::string &handler, const std::string &service)
	The specified handler can handle the specified service.

virtual void	remove_service (const std::string &name)
	remove a service from the BES

virtual bool	service_available (const std::string &name, const std::string &cmd="", const std::string &format="")
	Determines if a service and, optionally, a command and a return format, is available.

virtual void	services_handled (const std::string &handler, std::list< std::string > &services)
	returns the list of servies provided by the handler in question

virtual void	show_services (BESInfo &info)
	fills in the response object for the <showService /> request

Static Public Member Functions
static BESServiceRegistry *	TheRegistry ()

Detailed Description

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

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 57 of file BESServiceRegistry.h.

Constructor & Destructor Documentation

◆ BESServiceRegistry()

BESServiceRegistry::BESServiceRegistry ( )

Definition at line 48 of file BESServiceRegistry.cc.

◆ ~BESServiceRegistry()

BESServiceRegistry::~BESServiceRegistry ( )

virtual

Definition at line 50 of file BESServiceRegistry.cc.

Member Function Documentation

◆ add_format()

void BESServiceRegistry::add_format	(	const std::string &	service,
		const std::string &	cmd,
		const std::string &	format )

virtual

add a format response to a command of a service

Parameters

service	name of the service to add the format to
cmd	the command in the service to add the format to
format	the format to add

Exceptions

BESInternalError if the service or command do not exist or if the format has already been registered.

Definition at line 133 of file BESServiceRegistry.cc.

◆ add_service()

void BESServiceRegistry::add_service ( const std::string & name )

virtual

Add a service to the BES.

Parameters

name	name of the service to be added

Exceptions

BESInternalError if the service already exists

Definition at line 58 of file BESServiceRegistry.cc.

◆ add_to_service()

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

virtual

This function allows callers to add to a service that already exists.

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

service	name of the service to add the commands to
cmd	the command being added to the service
cmd_descript	the description of the command being added to the service
format	the format of the command being added to the service

Exceptions

BESInternalError if the service does not exist or the command is already reigstered with the service

Definition at line 91 of file BESServiceRegistry.cc.

◆ does_handle_service()

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

virtual

Asks if the specified handler can handle the specified service.

Does the specified handler provide the specified service.

Parameters

handler	name of the handler to check
service	name of the service the handler might handle

Returns: true if the handler does provide the service, false otherwise

Definition at line 320 of file BESServiceRegistry.cc.

◆ dump()

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

virtual

dumps information about this object

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

Parameters

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

Implements BESObj.

Definition at line 414 of file BESServiceRegistry.cc.

◆ handles_service()

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

virtual

The specified handler can handle the specified service.

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

handler	name of the data handler being registered
service	name of the service the handler now provides

Exceptions

BESInternalError if the service does not exist

Definition at line 280 of file BESServiceRegistry.cc.

◆ remove_service()

void BESServiceRegistry::remove_service ( const std::string & name )

virtual

remove a service from the BES

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

service name of the service to remove

Definition at line 187 of file BESServiceRegistry.cc.

◆ service_available()

bool BESServiceRegistry::service_available	(	const std::string &	name,
		const std::string &	cmd = "",
		const std::string &	format = "" )

virtual

Determines if a service and, optionally, a command and a return format, is available.

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

service	the name of the service in question
cmd	the service command in question, defaults to empty string
format	the 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 229 of file BESServiceRegistry.cc.

◆ services_handled()

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

virtual

returns the list of servies provided by the handler in question

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

Parameters

handler	name of the handler to inquire about
services	out parameter that will hold the services provided by the handler

Definition at line 347 of file BESServiceRegistry.cc.

◆ show_services()

void BESServiceRegistry::show_services ( BESInfo & info )

virtual

fills in the response object for the <showService /> request

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

info	The BES informational object that will hold the response

Definition at line 373 of file BESServiceRegistry.cc.

◆ TheRegistry()

BESServiceRegistry * BESServiceRegistry::TheRegistry ( )

static

Definition at line 479 of file BESServiceRegistry.cc.

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

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ BESServiceRegistry()

◆ ~BESServiceRegistry()

Member Function Documentation

◆ add_format()

◆ add_service()

◆ add_to_service()

◆ does_handle_service()

◆ dump()

◆ handles_service()

◆ remove_service()

◆ service_available()

◆ services_handled()

◆ show_services()

◆ TheRegistry()