bes  Updated for version 3.20.6
bes::WhiteList Class Reference

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

#include <WhiteList.h>

Collaboration diagram for bes::WhiteList:
Collaboration graph

Public Member Functions

bool is_white_listed (const std::string &url)
 

Static Public Member Functions

static WhiteListget_white_list ()
 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 white list and provides a simple API (Is_Whitelisted()) 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 WhiteList.h.

Member Function Documentation

◆ get_white_list()

WhiteList * WhiteList::get_white_list ( )
static

Static accessor for the singleton.

Returns
A pointer to the singleton instance

Definition at line 55 of file WhiteList.cc.

◆ is_white_listed()

bool WhiteList::is_white_listed ( const std::string &  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 whitelist assembled from configuration. All file URLs are checked to be sure that they reference a resource within the BES default catalog.

Note
RemoteAccess 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
urlThe URL to test
Returns
True if the URL may be dereferenced, given the BES's configuration, false otherwise.

Definition at line 87 of file WhiteList.cc.


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