bes Updated for version 3.21.1
The Backend Server (BES) is the lower two tiers of the Hyrax data server
ngap::NgapApi Class Reference
Collaboration diagram for ngap::NgapApi:
Collaboration graph

Public Member Functions

 NgapApi (const NgapApi &other)=delete
 
NgapApioperator= (const NgapApi &other)=delete
 

Static Public Member Functions

static std::string convert_ngap_resty_path_to_data_access_url (const std::string &restified_path)
 Converts an NGAP restified granule path into a CMR metadata query for the granule.
 
static bool signed_url_is_expired (const http::url &signed_url)
 Has the signed S3 URL expired? If neither the CloudFront Expires header nor the AWS Expires header are present, then this function returns true.
 

Friends

class NgapApiTest
 

Detailed Description

Definition at line 47 of file NgapApi.h.

Member Function Documentation

◆ convert_ngap_resty_path_to_data_access_url()

string ngap::NgapApi::convert_ngap_resty_path_to_data_access_url ( const std::string & restified_path)
static

Converts an NGAP restified granule path into a CMR metadata query for the granule.

The NGAP module's "restified" interface utilizes a google-esque set of ordered key value pairs using the "/" character as field separator.

The NGAP container the "restified_path" will follow the template:

provider/daac_name/datasets/collection_name/granules/granule_name(s?)

Where "provider", "datasets", and "granules" are NGAP keys and "ddac_name", "collection_name", and "granule_name" the their respective values.

For example, "provider/GHRC_CLOUD/datasets/ACES_CONTINUOUS_DATA_V1/granules/aces1cont.nc"

https://cmr.earthdata.nasa.gov/search/granules.umm_json_v1_4? provider=GHRC_CLOUD &entry_title=ACES_CONTINUOUS_DATA_V1 &native_id=aces1cont.nc provider=GHRC_CLOUD &entry_title=ACES CONTINUOUS DATA V1 &native_id=aces1cont_2002.191_v2.50.tar provider=GHRC_CLOUD &native_id=olslit77.nov_analog.hdf &pretty=true

Parameters
restified_pathThe name to decompose.

Definition at line 414 of file NgapApi.cc.

◆ signed_url_is_expired()

bool ngap::NgapApi::signed_url_is_expired ( const http::url & signed_url)
static

Has the signed S3 URL expired? If neither the CloudFront Expires header nor the AWS Expires header are present, then this function returns true.

Note
This function is ony used in unit tests (jhrg 10/16/23)
Parameters
signed_url
Returns
True if the signed URL has expired, false otherwise.
Todo
Remove this since it is only used by tests and duplicates http::url::is_expired(). jhrg 10/18/23
See also
http::url::is_expired()

Definition at line 452 of file NgapApi.cc.

Friends And Related Symbol Documentation

◆ NgapApiTest

friend class NgapApiTest
friend

Definition at line 55 of file NgapApi.h.


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