BESContainerStorageList Class Reference

Provides a mechanism for accessing container information from different container stores registered with this server. More...

#include <BESContainerStorageList.h>

Inheritance diagram for BESContainerStorageList:

Inheritance graph
[legend]
Collaboration diagram for BESContainerStorageList:

Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual ~BESContainerStorageList ()
virtual bool add_persistence (BESContainerStorage *p)
 Add a persistent store to the list.
virtual bool del_persistence (const string &persist_name)
 remove a persistent store from the list
virtual BESContainerStoragefind_persistence (const string &persist_name)
 find the persistence store with the given name
virtual BESContainerlook_for (const string &sym_name)
 look for the specified container information in the list of persistent stores.
virtual void show_containers (BESInfo &info)
 show information for each container in each persistence store
virtual void dump (ostream &strm) const
 dumps information about this object

Static Public Member Functions

static BESContainerStorageListTheList ()

Protected Member Functions

 BESContainerStorageList ()

Classes

struct  _persistence_list


Detailed Description

Provides a mechanism for accessing container information from different container stores registered with this server.

This class provides a mechanism for users to access container information from different container stores, such as from a MySQL database, a file, or volatile stores.

Users can add different BESContainerStorage instances to this persistent list. Then, when a user looks for a symbolic name, that search goes through the list of persistent stores in order.

If the symbolic name is not found then a flag is checked to determine whether to simply log the fact that the symbolic name was not found, or to throw an exception of type BESContainerStorageException.

See also:
BESContainerStorage

BESContainer

BESContainerStorageException


Constructor & Destructor Documentation

BESContainerStorageList::BESContainerStorageList (  )  [protected]

BESContainerStorageList::~BESContainerStorageList (  )  [virtual]


Member Function Documentation

bool BESContainerStorageList::add_persistence ( BESContainerStorage cp  )  [virtual]

Add a persistent store to the list.

Each persistent store has a name. If a persistent store already exists in the list with that name then the persistent store is not added. Otherwise the store is added to the list.

The persistent stores are searched in the order in which they were added.

Parameters:
cp persistent store to add to the list
Returns:
true if successfully added, false otherwise
See also:
BESContainerStorage

References BESContainerStorage::get_name().

Referenced by BESDefaultModule::initialize().

Here is the call graph for this function:

bool BESContainerStorageList::del_persistence ( const string &  persist_name  )  [virtual]

remove a persistent store from the list

Removes the named persistent store from the list.

Parameters:
persist_name name of the persistent store to be removed
Returns:
true if successfully removed, false otherwise
See also:
BESContainerStorage

Referenced by BESDefaultModule::terminate().

BESContainerStorage * BESContainerStorageList::find_persistence ( const string &  persist_name  )  [virtual]

find the persistence store with the given name

Returns the persistence store with the given name

Parameters:
persist_name name of the persistent store to be found
Returns:
the persistence store BESContainerStorage
See also:
BESContainerStorage

Referenced by BESSetContainerResponseHandler::execute(), BESDelContainersResponseHandler::execute(), and BESDelContainerResponseHandler::execute().

BESContainer * BESContainerStorageList::look_for ( const string &  sym_name  )  [virtual]

look for the specified container information in the list of persistent stores.

Look for the container with the specified symbolic name in the BESContainerStorage instances. The first to find it wins.

If the container information is not found then, depending on the value of the key BES.Container.Persistence in the bes configuration file, an exception is thrown or it is logged to the bes log file that it was not found. If the key is set to Nice, nice, or NICE then information is logged to the bes log file stating that the container information was not found.

Parameters:
sym_name symbolic name of the container to look for
Returns:
a new instances of BESContainer if found, else 0. The caller owns the returned container and is responsible for deleting cleaning
Exceptions:
BESSyntaxUserError if container not found and strict set in the bes configuration file for BES.Container.Persistence
See also:
BESContainerStorage

BESContainer

BESKeys

BESLog

BESSyntaxUserError

References BESLog::TheLog().

Referenced by BESDefineCommand::parse_request().

Here is the call graph for this function:

void BESContainerStorageList::show_containers ( BESInfo info  )  [virtual]

show information for each container in each persistence store

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

Parameters:
info object to store the container and persistent store information
See also:
BESInfo

References BESInfo::begin_tag(), and BESInfo::end_tag().

Referenced by BESShowContainersResponseHandler::execute().

Here is the call graph for this function:

void BESContainerStorageList::dump ( ostream &  strm  )  const [virtual]

dumps information about this object

Displays the pointer value of this instance along with information about the container storage objects stored in this list.

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

Implements BESObj.

References BESIndent::Indent(), BESIndent::LMarg(), and BESIndent::UnIndent().

Here is the call graph for this function:

BESContainerStorageList * BESContainerStorageList::TheList (  )  [static]


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

Generated on Wed Sep 24 12:24:51 2008 for OPeNDAP Back End Server (BES) by  doxygen 1.5.6