implementation of BESContainerStorageVolatile that represents a resource managed by the NASA NGAP/EOSDIS cloud-based data system. These resources are stored in S3 and must be transferred to the server before they can be used. In the Hyrax server, these are DMR++ (i.e., XML) files, not the actual data files. The data files are stored in S3 but are subset directly from S3 using information in the (much smaller) DMR++ files More...

#include <NgapOwnedContainerStorage.h>

Inheritance diagram for ngap::NgapOwnedContainerStorage:

Collaboration diagram for ngap::NgapOwnedContainerStorage:

Public Types
typedef std::map< std::string, BESContainer * >::const_iterator	Container_citer

typedef std::map< std::string, BESContainer * >::iterator	Container_iter

Public Member Functions
void	add_container (const std::string &s_name, const std::string &r_name, const std::string &type) override
	adds a container with the provided information

virtual bool	del_container (const std::string &s_name)
	removes a container with the given symbolic name from the list and deletes it.

virtual bool	del_containers ()
	removes all container

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

virtual const std::string &	get_name () const
	retrieve the name of this persistent store

virtual bool	isData (const std::string &inQuestion, std::list< std::string > &provides)
	determine if the given container is data and what services are available for it

virtual BESContainer *	look_for (const std::string &sym_name)
	looks for the specified container using the symbolic name passed

	NgapOwnedContainerStorage (const std::string &n)

virtual void	show_containers (BESInfo &info)
	show information for each container in this persistent store

Protected Member Functions
virtual void	add_container (BESContainer *c)
	add the passed container to the list of containers in volatile storage

virtual void	show_container (const std::string &sym_name, const std::string &real_name, const std::string &type, BESInfo &info)
	add information for a container to the informational response object

Protected Attributes
bool	_follow_sym_links

std::string	_my_name

std::string	_root_dir

Detailed Description

implementation of BESContainerStorageVolatile that represents a resource managed by the NASA NGAP/EOSDIS cloud-based data system. These resources are stored in S3 and must be transferred to the server before they can be used. In the Hyrax server, these are DMR++ (i.e., XML) files, not the actual data files. The data files are stored in S3 but are subset directly from S3 using information in the (much smaller) DMR++ files

See also: BESContainerStorageVolatile; GatewayContainer

Definition at line 47 of file NgapOwnedContainerStorage.h.

Member Typedef Documentation

◆ Container_citer

typedef std::map<std::string,BESContainer*>::const_iterator BESContainerStorageVolatile::Container_citer

inherited

Definition at line 70 of file BESContainerStorageVolatile.h.

◆ Container_iter

typedef std::map<std::string,BESContainer*>::iterator BESContainerStorageVolatile::Container_iter

inherited

Definition at line 71 of file BESContainerStorageVolatile.h.

Constructor & Destructor Documentation

◆ NgapOwnedContainerStorage()

ngap::NgapOwnedContainerStorage::NgapOwnedContainerStorage ( const std::string & n )

inlineexplicit

Definition at line 49 of file NgapOwnedContainerStorage.h.

Member Function Documentation

◆ add_container() [1/2]

void BESContainerStorageVolatile::add_container ( BESContainer * c )

protectedvirtualinherited

add the passed container to the list of containers in volatile storage

This method adds the passed container to the list of volatile containers. The passed container is owned by the list if added and should not be deleted by the caller.

If a container with the symbolic name of the passed container is already in the list then an exception is thrown.

Parameters

c	container to add to the list

Exceptions

BESContainerStorageExcpetion	if the passed container is null
BESContainerStorageExcpetion	if no type is specified in the passed container
BESContainerStorageExcpetion	if a container with the passed symbolic name already exists.

Implements BESContainerStorage.

Definition at line 191 of file BESContainerStorageVolatile.cc.

◆ add_container() [2/2]

void ngap::NgapOwnedContainerStorage::add_container	(	const std::string &	s_name,
		const std::string &	r_name,
		const std::string &	type )

overridevirtual

adds a container with the provided information

Parameters

s_name	symbolic name for the container
r_name	the remote request url
type	ignored. The type of the target response is determined by the request response, or could be passed in

Reimplemented from BESContainerStorageVolatile.

Definition at line 44 of file NgapOwnedContainerStorage.cc.

◆ del_container()

bool BESContainerStorageVolatile::del_container ( const std::string & s_name )

virtualinherited

removes a container with the given symbolic name from the list and deletes it.

Parameters

s_name symbolic name for the container

Returns: true if successfully removed and false otherwise

Implements BESContainerStorage.

Definition at line 216 of file BESContainerStorageVolatile.cc.

◆ del_containers()

bool BESContainerStorageVolatile::del_containers ( )

virtualinherited

removes all container

This method removes all containers from the persistent store. It does not delete the real data behind the container.

Returns: true if successfully removed and false otherwise

Implements BESContainerStorage.

Definition at line 241 of file BESContainerStorageVolatile.cc.

◆ dump()

void ngap::NgapOwnedContainerStorage::dump ( std::ostream & strm ) const

overridevirtual

dumps information about this object

Displays the pointer value of this instance along with information about each of the GatewayContainers already stored.

Parameters

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

Reimplemented from BESContainerStorageVolatile.

Definition at line 56 of file NgapOwnedContainerStorage.cc.

◆ get_name()

virtual const std::string & BESContainerStorage::get_name ( ) const

inlinevirtualinherited

retrieve the name of this persistent store

Returns: name of this persistent store.

Definition at line 91 of file BESContainerStorage.h.

◆ isData()

bool BESContainerStorageVolatile::isData	(	const std::string &	inQuestion,
		std::list< std::string > &	provides )

virtualinherited

determine if the given container is data and what services are available for it

Parameters

inQuestion	the container in question
provides	an output parameter for storing the list of services provided for this container

Implements BESContainerStorage.

Reimplemented in BESFileContainerStorage.

Definition at line 264 of file BESContainerStorageVolatile.cc.

◆ look_for()

BESContainer * BESContainerStorageVolatile::look_for ( const std::string & sym_name )

virtualinherited

looks for the specified container using the symbolic name passed

If a match is made with the symbolic name then the stored container is duplicated and returned to the user. If not, 0 is returned.

Parameters

sym_name symbolic name of the container to look for

Returns: a new BESContainer instance using the ptr_duplicate method on BESContainer

Implements BESContainerStorage.

Definition at line 105 of file BESContainerStorageVolatile.cc.

◆ show_container()

void BESContainerStorage::show_container	(	const std::string &	sym_name,
		const std::string &	real_name,
		const std::string &	type,
		BESInfo &	info )

protectedvirtualinherited

add information for a container to the informational response object

Parameters

sym_name	symbolic name of the container to add
real_name	real name, e.g. file name, of the container to add
type	data type of the container
info	The BES information object to add container information to

See also: BESInfo

Definition at line 48 of file BESContainerStorage.cc.

◆ show_containers()

void BESContainerStorageVolatile::show_containers ( BESInfo & info )

virtualinherited

show information for each container in this persistent store

For each container in this persistent store, add information about each of those containers. The information added to the information object includes a line for each container within this persistent store which includes the symbolic name, the real name, and the data type, separated by commas.

In the case of this persistent store information from each container added to the volatile list is added to the information object.

Parameters

info	object to store the container and persistent store information

See also: BESInfo

Implements BESContainerStorage.

Definition at line 290 of file BESContainerStorageVolatile.cc.

Member Data Documentation

◆ _follow_sym_links

bool BESContainerStorageVolatile::_follow_sym_links

protectedinherited

Definition at line 63 of file BESContainerStorageVolatile.h.

◆ _my_name

std::string BESContainerStorage::_my_name

protectedinherited

Definition at line 69 of file BESContainerStorage.h.

◆ _root_dir

std::string BESContainerStorageVolatile::_root_dir

protectedinherited

Definition at line 62 of file BESContainerStorageVolatile.h.

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

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Container_citer

◆ Container_iter

Constructor & Destructor Documentation

◆ NgapOwnedContainerStorage()

Member Function Documentation

◆ add_container() [1/2]

◆ add_container() [2/2]

◆ del_container()

◆ del_containers()

◆ dump()

◆ get_name()

◆ isData()

◆ look_for()

◆ show_container()

◆ show_containers()

Member Data Documentation

◆ _follow_sym_links

◆ _my_name

◆ _root_dir