BESKeys Class Reference

mapping of key/value pairs defining different behaviors of an application. More...

#include <BESKeys.h>

Inheritance diagram for BESKeys:
Inheritance graph
[legend]
Collaboration diagram for BESKeys:
Collaboration graph
[legend]

List of all members.

Public Types

typedef map< string, vector
< string > >::const_iterator 
Keys_citer

Public Member Functions

virtual void dump (ostream &strm) const
 dumps information about this object
void get_value (const string &s, string &val, bool &found)
 Retrieve the value of a given key, if set.
void get_values (const string &s, vector< string > &vals, bool &found)
 Retrieve the values of a given key, if set.
Keys_citer keys_begin ()
Keys_citer keys_end ()
string keys_file_name ()
void set_key (const string &pair)
 allows the user to set key/value pairs from within the application.
void set_key (const string &key, const string &val, bool addto=false)
 allows the user to set key/value pairs from within the application.
 ~BESKeys ()
 cleans up the key/value pair mapping

Protected Member Functions

 BESKeys (const string &keys_file_name)
 default constructor that reads loads key/value pairs from the specified file.

Detailed Description

mapping of key/value pairs defining different behaviors of an application.

BESKeys provides a mechanism to define the behavior of an application given key/value pairs. For example, how authentication will work, database access information, level of debugging and where log files are to be located.

Key/value pairs can be loaded from an external initialization file or set within the application itself, for example from the command line.

If from a file the key/value pair is set one per line and cannot span multiple lines. Comments are allowed using the pound (#) character. For example:

 #
 # Who is responsible for this server
 #
 BES.ServerAdministrator=dods-tech@unidata.ucar.edu

 #
 # Default server port and unix socket information and whether the server
 #is secure or not.
 #
 BES.ServerPort=10002
 BES.ServerUnixSocket=/tmp/bes.socket
 BES.ServerSecure=no
 * 

Key/value pairs can also be set by passing in a key=value string, or by passing in a key and value string to the object.

BES provides a single object for access to a single BESKeys object, TheBESKeys.

Definition at line 84 of file BESKeys.h.


Member Typedef Documentation

typedef map< string, vector< string > >::const_iterator BESKeys::Keys_citer

Definition at line 120 of file BESKeys.h.


Constructor & Destructor Documentation

BESKeys::BESKeys ( const string &  keys_file_name  )  [protected]

default constructor that reads loads key/value pairs from the specified file.

This constructor uses the specified file to load key/value pairs. This file holds different key/value pairs for the application, one key/value pair per line separated by an equal (=) sign.

key=value

Comments are allowed in the file and must begin with a pound (#) sign at the beginning of the line. No comments are allowed at the end of lines.

Exceptions:
BESInternalFatalError thrown if there is an error reading the initialization file or a syntax error in the file, i.e. a malformed key/value pair.

Definition at line 74 of file BESKeys.cc.

BESKeys::~BESKeys (  ) 

cleans up the key/value pair mapping

Definition at line 95 of file BESKeys.cc.


Member Function Documentation

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

dumps information about this object

Displays the pointer value of this instance along with all of the keys.

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

Implements BESObj.

Definition at line 480 of file BESKeys.cc.

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

Here is the call graph for this function:

void BESKeys::get_value ( const string &  s,
string &  val,
bool &  found 
)

Retrieve the value of a given key, if set.

This method allows the user of BESKeys to retrieve the value of the specified key. If multiple values are set then an exception is thrown.

Parameters:
s The key the user is looking for
val The value of the key the user is looking for
found Set to true of the key is set or false if the key is not set. The value of a key can be set to the empty string, which is why this boolean is provided.
Exceptions:
BESSyntaxUserError if multiple values are available for the specified key

Definition at line 424 of file BESKeys.cc.

Referenced by BESInfo::add_data_from_file(), BESCache::BESCache(), BESCatalogList::BESCatalogList(), BESCatalogUtils::BESCatalogUtils(), BESContainerStorageFile::BESContainerStorageFile(), BESContainerStorageVolatile::BESContainerStorageVolatile(), BESInfo::BESInfo(), BESLog::BESLog(), BESMemoryGlobalArea::BESMemoryGlobalArea(), BESServerHandler::BESServerHandler(), BESUncompressManager::BESUncompressManager(), BESInfoList::build_info(), BESExceptionManager::handle_exception(), and ServerApp::initialize().

void BESKeys::get_values ( const string &  s,
vector< string > &  vals,
bool &  found 
)

Retrieve the values of a given key, if set.

This method allows the user of BESKeys to retrieve the value of the specified key.

Parameters:
s The key the user is looking for
vals The value set for the specified key
found Set to true of the key is set or false if the key is not set. The value of a key can be set to the empty string, which is why this boolean is provided.

Definition at line 461 of file BESKeys.cc.

Referenced by BESCatalogUtils::BESCatalogUtils().

Keys_citer BESKeys::keys_begin (  )  [inline]

Definition at line 121 of file BESKeys.h.

Referenced by BESConfigResponseHandler::execute().

Keys_citer BESKeys::keys_end (  )  [inline]

Definition at line 122 of file BESKeys.h.

Referenced by BESConfigResponseHandler::execute().

string BESKeys::keys_file_name (  )  [inline]

Definition at line 110 of file BESKeys.h.

void BESKeys::set_key ( const string &  pair  ) 

allows the user to set key/value pairs from within the application.

This method allows users of BESKeys to set key/value pairs from within the application, such as for testing purposes, key/value pairs from the command line, etc...

If the key is already set then this value replaces the value currently held in the keys map.

Parameters:
pair the key/value pair passed as key=value

Definition at line 400 of file BESKeys.cc.

References set_key().

Here is the call graph for this function:

void BESKeys::set_key ( const string &  key,
const string &  val,
bool  addto = false 
)

allows the user to set key/value pairs from within the application.

This method allows users of BESKeys to set key/value pairs from within the application, such as for testing purposes, key/value pairs from the command line, etc...

If addto is set to true then the value is added to the list of values for key

If addto is false, and the key is already set then this value replaces all values for the key

Parameters:
key name of the key/value pair to be set
val value of the key to be set
addto Specifies whether to add the value to the key or set the value. Default is to set, not add to

Definition at line 372 of file BESKeys.cc.

Referenced by set_key().


The documentation for this class was generated from the following files:
Generated by  doxygen 1.6.2-20100208