bes  Updated for version 3.20.8
bes::AllowedHosts Class Reference

Can a given URL be dereferenced given the BES's configuration? More...

#include <AllowedHosts.h>

Collaboration diagram for bes::AllowedHosts:
Collaboration graph

Public Member Functions

bool is_allowed (const std::string &candidate_url)
 

Static Public Member Functions

static AllowedHoststheHosts ()
 Static accessor for the singleton. More...
 

Detailed Description

Can a given URL be dereferenced given the BES's configuration?

Embodies a configuration based remote access allowed list and provides a simple API, is_allowed() for determining which resources may be accessed. This enables a system administrator to control the remote systems a particular BES daemon can access.

Note
This class is a singleton

Definition at line 51 of file AllowedHosts.h.

Member Function Documentation

◆ is_allowed()

bool AllowedHosts::is_allowed ( const std::string &  candidate_url)

This method provides an access condition assessment for URLs and files to be accessed by the BES. The http and https URLs are verified against a allowed hosts list assembled from configuration. All file URLs are checked to be sure that they reference a resource within the BES default catalog.

Note
AllowedHosts is a singleton. This method will instantiate the class if that has not already been done. This method should only be called from the main thread of a multi-threaded application.
Parameters
candidate_urlThe URL to test
Returns
True if the URL may be dereferenced, given the BES's configuration, false otherwise.

Definition at line 90 of file AllowedHosts.cc.

◆ theHosts()

AllowedHosts * AllowedHosts::theHosts ( )
static

Static accessor for the singleton.

Returns
A pointer to the singleton instance

Definition at line 58 of file AllowedHosts.cc.


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