implementation of BESContainerStorage that stores containers in memory for the duration of this process. More...

#include <BESContainerStorageVolatile.h>

Inheritance diagram for BESContainerStorageVolatile:

Collaboration diagram for BESContainerStorageVolatile:

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

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

Public Member Functions
virtual void	add_container (const std::string &sym_name, const std::string &real_name, const std::string &type)
	add a file container to the volatile list. The container's realname represents the path to a data file in the file system.

	BESContainerStorageVolatile (const std::string &n)
	create an instance of this persistent store with the given name.

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

virtual void	dump (std::ostream &strm) const
	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

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 BESContainerStorage that stores containers in memory for the duration of this process.

This implementation of BESContainerStorage stores volatile containers in memory for the duration of this process. A list of containers is stored in the object. The look_for method simply looks for the specified symbolic name in the list of containers and returns if a match is found. Containers can be added to this instance as long as the symbolic name doesn't already exist.

See also: BESContainerStorage; BESContainer

Definition at line 57 of file BESContainerStorageVolatile.h.

Member Typedef Documentation

◆ Container_citer

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

Definition at line 70 of file BESContainerStorageVolatile.h.

◆ Container_iter

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

Definition at line 71 of file BESContainerStorageVolatile.h.

Constructor & Destructor Documentation

◆ BESContainerStorageVolatile()

BESContainerStorageVolatile::BESContainerStorageVolatile ( const std::string & n )

create an instance of this persistent store with the given name.

Creates an instances of BESContainerStorageVolatile with the given name.

Note: This constructor will fail with an Internal Fatal Error if the BES Keys file cannot be read. That is, the if the singleton TheBESKeys cannot be initialized, the access to the BES keys will throw a BESInternalFatalError.

Todo: Remove the non-BESCatalog file system stuff in this class and combine it with BESContainerStorageCatalog.

Parameters

n	name of this persistent store

See also: BESContainer

Definition at line 69 of file BESContainerStorageVolatile.cc.

◆ ~BESContainerStorageVolatile()

BESContainerStorageVolatile::~BESContainerStorageVolatile ( )

virtual

Definition at line 90 of file BESContainerStorageVolatile.cc.

Member Function Documentation

◆ add_container() [1/2]

void BESContainerStorageVolatile::add_container ( BESContainer * c )

protectedvirtual

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 BESContainerStorageVolatile::add_container	(	const std::string &	sym_name,
		const std::string &	real_name,
		const std::string &	type )

virtual

add a file container to the volatile list. The container's realname represents the path to a data file in the file system.

If a container other than a BESFileContainer is to be added to the list then a derived class of BESContainerStorageVolatile should call the protected add_container method that takes an already built container. This method adds a container represented by a data file.

Parameters

sym_name	symbolic name of the container being created
real_name	The real name of the container, as provided by the user/client. This name is relative to the BES Data Root Directory
type	type of data represented by this container

Exceptions

BESInternalError	if no type is specified
BESInternalError	if a container with the passed symbolic name already exists.

Implements BESContainerStorage.

Reimplemented in BESFileContainerStorage, builddmrpp::NgapBuildDmrppContainerStorage, cmr::CmrContainerStorage, gateway::GatewayContainerStorage, httpd_catalog::HttpdCatalogContainerStorage, ngap::NgapOwnedContainerStorage, and s3::S3ContainerStorage.

Definition at line 135 of file BESContainerStorageVolatile.cc.

◆ del_container()

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

virtual

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 ( )

virtual

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 BESContainerStorageVolatile::dump ( std::ostream & strm ) const

virtual

dumps information about this object

Displays the pointer value of this instance along with information about the containers stored in this volatile list.

Parameters

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

Implements BESContainerStorage.

Reimplemented in BESFileContainerStorage, builddmrpp::NgapBuildDmrppContainerStorage, cmr::CmrContainerStorage, gateway::GatewayContainerStorage, httpd_catalog::HttpdCatalogContainerStorage, ngap::NgapOwnedContainerStorage, and s3::S3ContainerStorage.

Definition at line 317 of file BESContainerStorageVolatile.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 )

virtual

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 )

virtual

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 )

virtual

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

protected

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

protected

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

◆ BESContainerStorageVolatile()

◆ ~BESContainerStorageVolatile()

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