Container representing a remote request. More...

#include <S3Container.h>

Inheritance diagram for s3::S3Container:

Collaboration diagram for s3::S3Container:

Public Member Functions
std::string	access () override
	access the remote target response by making the remote request

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

void	filter_response (const std::map< std::string, std::string, std::less<> > &content_filters) const
	Filter the cached resource. Each key in content_filters is replaced with its associated map value.

std::string	get_attributes () const
	retrieve the attributes desired from this container

std::string	get_constraint () const
	retrieve the constraint expression for this container

std::string	get_container_type () const
	retrieve the type of data this container holds, such as cedar or netcdf.

std::string	get_dap4_constraint () const
	retrieve the constraint expression for this container

std::string	get_dap4_function () const
	retrieve the constraint expression for this container

std::string	get_real_name () const
	retrieve the real name for this container, such as a file name.

std::string	get_relative_name () const
	Get the relative name of the object in this container.

std::string	get_symbolic_name () const
	retrieve the symbolic name for this container

S3Container &	operator= (const S3Container &other)=delete

BESContainer *	ptr_duplicate () override
	pure abstract method to duplicate this instances of BESContainer

bool	release () override
	release the resources

	S3Container (const S3Container &copy_from)=delete

	S3Container (const std::string &sym_name, const std::string &real_name, const std::string &type)
	Creates an instances of S3Container with symbolic name and real name, which is the remote request.

void	set_attributes (const std::string &attrs)
	set desired attributes for this container

void	set_constraint (const std::string &s)
	set the constraint for this container

void	set_container_type (const std::string &type)
	set the type of data that this container represents, such as cedar or netcdf.

void	set_dap4_constraint (const std::string &s)
	set the constraint for this container

void	set_dap4_function (const std::string &s)
	set the constraint for this container

void	set_real_name (const std::string &real_name)
	set the real name for this container, such as a file name if reading a data file.

void	set_relative_name (const std::string &relative)
	Set the relative name of the object in this container.

Protected Member Functions
void	_duplicate (BESContainer &copy_to)
	duplicate this instance into the passed container

Detailed Description

Container representing a remote request.

The real name of a S3Container is the actual remote request. When the access method is called the remote request is made, the response saved to file if successful, and the target response returned as the real container that a data handler would then open.

See also: S3ContainerStorage

Definition at line 48 of file S3Container.h.

Constructor & Destructor Documentation

◆ S3Container()

s3::S3Container::S3Container	(	const std::string &	sym_name,
		const std::string &	real_name,
		const std::string &	type )

Creates an instances of S3Container with symbolic name and real name, which is the remote request.

The real_name is the remote request URL.

Parameters

sym_name	symbolic name representing this remote container
real_name	The S3 restified path.

Exceptions

BESSyntaxUserError if the url does not validate

See also: S3Utils

Definition at line 93 of file S3Container.cc.

Member Function Documentation

◆ _duplicate()

void BESContainer::_duplicate ( BESContainer & copy_to )

protectedinherited

duplicate this instance into the passed container

Parameters

copy_to The container to copy this instance into

Definition at line 54 of file BESContainer.cc.

◆ access()

string s3::S3Container::access ( )

overridevirtual

access the remote target response by making the remote request

Returns: full path to the remote request response data file

Exceptions

BESError if there is a problem making the remote request

Implements BESContainer.

Definition at line 150 of file S3Container.cc.

◆ dump()

void s3::S3Container::dump ( std::ostream & strm ) const

overridevirtual

dumps information about this object

Displays the pointer value of this instance along with information about this container.

Parameters

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

Reimplemented from BESContainer.

Definition at line 240 of file S3Container.cc.

◆ filter_response()

void s3::S3Container::filter_response ( const std::map< std::string, std::string, std::less<> > & content_filters ) const

Filter the cached resource. Each key in content_filters is replaced with its associated map value.

WARNING: Does not lock cache. This method assumes that the process has already acquired an exclusive lock on the cache file.

WARNING: This method will overwrite the cached data with the filtered result.

Parameters

content_filters A map of key value pairs which define the filter operation. Each key found in the resource will be replaced with its associated value.

Definition at line 131 of file S3Container.cc.

◆ get_attributes()

std::string BESContainer::get_attributes ( ) const

inlineinherited

retrieve the attributes desired from this container

Returns: attributes desired from this container

Definition at line 243 of file BESContainer.h.

◆ get_constraint()

std::string BESContainer::get_constraint ( ) const

inlineinherited

retrieve the constraint expression for this container

Returns: constraint expression for this execution for the symbolic name

Definition at line 195 of file BESContainer.h.

◆ get_container_type()

std::string BESContainer::get_container_type ( ) const

inlineinherited

retrieve the type of data this container holds, such as cedar or netcdf.

Returns: type of data this container represents, such as cedar or netcdf

Definition at line 233 of file BESContainer.h.

◆ get_dap4_constraint()

std::string BESContainer::get_dap4_constraint ( ) const

inlineinherited

retrieve the constraint expression for this container

Returns: constraint expression for this execution for the symbolic name

Definition at line 204 of file BESContainer.h.

◆ get_dap4_function()

std::string BESContainer::get_dap4_function ( ) const

inlineinherited

retrieve the constraint expression for this container

Returns: constraint expression for this execution for the symbolic name

Definition at line 213 of file BESContainer.h.

◆ get_real_name()

std::string BESContainer::get_real_name ( ) const

inlineinherited

retrieve the real name for this container, such as a file name.

Returns: real name, such as file name

Definition at line 181 of file BESContainer.h.

◆ get_relative_name()

std::string BESContainer::get_relative_name ( ) const

inlineinherited

Get the relative name of the object in this container.

Definition at line 187 of file BESContainer.h.

◆ get_symbolic_name()

std::string BESContainer::get_symbolic_name ( ) const

inlineinherited

retrieve the symbolic name for this container

Returns: symbolic name for this container

Definition at line 222 of file BESContainer.h.

◆ ptr_duplicate()

BESContainer * s3::S3Container::ptr_duplicate ( )

overridevirtual

pure abstract method to duplicate this instances of BESContainer

Implements BESContainer.

Definition at line 100 of file S3Container.cc.

◆ release()

bool s3::S3Container::release ( )

overridevirtual

release the resources

Release the resource

Returns: true if the resource is released successfully and false otherwise

Implements BESContainer.

Definition at line 223 of file S3Container.cc.

◆ set_attributes()

void BESContainer::set_attributes ( const std::string & attrs )

inlineinherited

set desired attributes for this container

Parameters

attrs attributes desired to access for this container

Definition at line 171 of file BESContainer.h.

◆ set_constraint()

void BESContainer::set_constraint ( const std::string & s )

inlineinherited

set the constraint for this container

Parameters

s	constraint

Definition at line 119 of file BESContainer.h.

◆ set_container_type()

void BESContainer::set_container_type ( const std::string & type )

inlineinherited

set the type of data that this container represents, such as cedar or netcdf.

Parameters

type	type of data, such as cedar or netcdf

Definition at line 162 of file BESContainer.h.

◆ set_dap4_constraint()

void BESContainer::set_dap4_constraint ( const std::string & s )

inlineinherited

set the constraint for this container

Parameters

s	constraint

Definition at line 128 of file BESContainer.h.

◆ set_dap4_function()

void BESContainer::set_dap4_function ( const std::string & s )

inlineinherited

set the constraint for this container

Parameters

s	constraint

Definition at line 137 of file BESContainer.h.

◆ set_real_name()

void BESContainer::set_real_name ( const std::string & real_name )

inlineinherited

set the real name for this container, such as a file name if reading a data file.

Parameters

real_name real name, such as the file name

Definition at line 147 of file BESContainer.h.

◆ set_relative_name()

void BESContainer::set_relative_name ( const std::string & relative )

inlineinherited

Set the relative name of the object in this container.

Definition at line 153 of file BESContainer.h.

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

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ S3Container()

Member Function Documentation

◆ _duplicate()

◆ access()

◆ dump()

◆ filter_response()

◆ get_attributes()

◆ get_constraint()

◆ get_container_type()

◆ get_dap4_constraint()

◆ get_dap4_function()

◆ get_real_name()

◆ get_relative_name()

◆ get_symbolic_name()

◆ ptr_duplicate()

◆ release()

◆ set_attributes()

◆ set_constraint()

◆ set_container_type()

◆ set_dap4_constraint()

◆ set_dap4_function()

◆ set_real_name()

◆ set_relative_name()