nc::CDBProperties

NAME
SYNOPSIS
Detailed Description
Member Typedef Documentation
Member Function Documentation
Author

NAME

nc::CDBProperties −

SYNOPSIS

#include <acsncCDBProperties.h>

Public Types

typedef std::map< std::string, double > EventHandlerTimeoutMap

Static Public Member Functions

static bool cdbChannelConfigExists (const std::string &channelName)

static CosNotification::AdminProperties getCDBAdminProps (const std::string &channelName)

static CosNotification::QoSProperties getCDBQoSProps (const std::string &channelName)

static bool getIntegrationLogs (const std::string &channelName)

static EventHandlerTimeoutMap getEventHandlerTimeoutMap (const std::string &channelName)

static CDB::DAL_ptr getCDB ()

Detailed Description

Class which contains static methods used to discover whether or not properties for ACS notification channels have been defined in the ACS CDB. If these properties, are present this class turns the pure XML records into CORBA properties.

Member Typedef Documentation

typedef std::map<std::string, double> nc::CDBProperties::EventHandlerTimeoutMap

Member Function Documentation

static bool nc::CDBProperties::cdbChannelConfigExists (const std::string & channelName) [static] Simple function which returns true if the given channel has an entry in $ACS_CDB/CDB/MACI/EventChannels/ section of the ACS configuration database.

Parameters:

channelName name of the channel we want to know about

Returns:

true if an entry exists in the ACS CDB for this channel and false otherwise.

static CDB::DAL_ptr nc::CDBProperties::getCDB () [static] Helper function returns a reference to the ACS CDB.

Referenced by nc::Helper::getNotificationFactoryName().

static CosNotification::AdminProperties nc::CDBProperties::getCDBAdminProps (const std::string & channelName) [static] Given a channel name that exists in the ACS CDB ($ACS_CDB/CDB/MACI/Channels/channelName/channelName.xml), this function returns the channels administrative properties in their CORBA format.

Parameters:

channelName name of the channel found in $ACS_CDB/CDB/MACI/Channels

Returns:

channel’s admin properties

static CosNotification::QoSProperties nc::CDBProperties::getCDBQoSProps (const std::string & channelName) [static] Given a channel name that exists in the ACS CDB ($ACS_CDB/CDB/MACI/Channels/channelName/channelName.xml), this function returns the channel’s quality of service properties in their CORBA format.

Parameters:

channelName name of the channel found in $ACS_CDB/CDB/MACI/Channels

Returns:

channel’s quality of service properties

static EventHandlerTimeoutMap nc::CDBProperties::getEventHandlerTimeoutMap (const std::string & channelName) [static] The following returns a map where each key is the name of an event and the value is the maximum amount of time an event handler has to process the event before a warning message is logged.

Parameters:

channelName - name of the channel

static bool nc::CDBProperties::getIntegrationLogs (const std::string & channelName) [static] The following was requested by H. Sommer and is needed for integrations. It should be removed at some later date.

Author

Generated automatically by Doxygen for ACS-2015.2 C++ API from the source code.