log4shib::...uratorImpl(3)

okay bestie, this is log4shib::...uratorImpl(3) from the Library Functions Manual — yes, the title is serving truncated-header realness, but we're talking about log4shib::PropertyConfiguratorImpl 💖. Buckle up, it's giving C++ configurator class energy.

🌸 NAME 🌸

log4shib::PropertyConfiguratorImpl — that's the class, no cap 💅.

✨ SYNOPSIS ✨

#include <PropertyConfiguratorImpl.hh>

💖 Public Types 💖

• typedef std::map< std::string, Appender * > AppenderMap — the typedef, with std::string keys and Appender * values ✨.

🎀 Public Member Functions 🎀

• PropertyConfiguratorImpl () — the constructor, no args.
• virtual ~PropertyConfiguratorImpl () — the virtual destructor 🫶.
• virtual void doConfigure (const std::string &initFileName) — virtual doConfigure overload taking initFileName.
• virtual void doConfigure (std::istream &in) — virtual doConfigure overload taking in.

🦋 Protected Member Functions 🦋

• void configureCategory (const std::string &categoryname) — configure the given category.
• void getCategories (std::vector< std::string > &categories) const — get a list of categories for which we should do the configuration.
• void instantiateAllAppenders () — listed right here; the page doesn't add extra prose for this one 💀.
• Appender * instantiateAppender (const std::string &name) — “Intantiate” and configure the appender referred to by the given name.
• void setLayout (Appender *appender, const std::string &name) — method for instantiating and configuring the layouts associated with each appender.

💅 Protected Attributes 💅

• Properties _properties — protected attribute.
• AppenderMap _allAppenders — protected attribute.

⭐ Member Typedef Documentation ⭐

typedef std::map<std::string, Appender*> log4shib::PropertyConfiguratorImpl::AppenderMap

The fully qualified typedef, looking all iconic and official 🌟.

🌈 Constructor & Destructor Documentation 🌈

• log4shib::PropertyConfiguratorImpl::PropertyConfiguratorImpl () — constructor.
• log4shib::PropertyConfiguratorImpl::~PropertyConfiguratorImpl () [virtual] — virtual destructor.

🔥 Member Function Documentation 🔥

configureCategory

void log4shib::PropertyConfiguratorImpl::configureCategory (const std::string & categoryname) [protected]

Configure the given category. This includes setting its Priority and adding any Appenders 😌.

Todo

Setting other properties like 'additivity'.

Parameters

• categoryname — Name of the category to configure. The name 'rootCategory' refers to the root Category. throw ConfigureFailure

doConfigure

• void log4shib::PropertyConfiguratorImpl::doConfigure (const std::string & initFileName) [virtual]
• void log4shib::PropertyConfiguratorImpl::doConfigure (std::istream & in) [virtual]

Both virtual overloads, just sitting there with no extra description on this page 🫡.

getCategories

void log4shib::PropertyConfiguratorImpl::getCategories (std::vector< std::string > & categories) const [protected]

Get a list of categories for which we should do the configuration. Get the categories contained within the map of properties.

This simply extracts the categories from the map.

Parameters

• categories — Reference to a list which is to receive the list of categories.

Since the category looks something like "category.xxxxx.yyy.zzz", we need to search the entire map to figure out which properties are category listings. Seems like there might be a more elegant solution 🤔.

instantiateAllAppenders

void log4shib::PropertyConfiguratorImpl::instantiateAllAppenders () [protected]

Signature only on this page, bestie — no extra description to report 💀.

instantiateAppender

Appender * log4shib::PropertyConfiguratorImpl::instantiateAppender (const std::string & name) [protected]

Intantiate and configure the appender referred to by the given name. This method searches the map to find all configuration parameters for the appender, and adds the appender to the given category. This isn't very general in the sense that it will need to be modified for each type of appender and layout. A more general solution would be to define an "options" interface for each appender and layout, so that we can simply call this method with a list of options instead of needing to know what is or is not available. This would also require some generic way of instantiating an object for which we have no knowledge. An "AppenderFactory" could be used which maps the given type to an actual object class registered with the factory (?? is this possible?).

Parameters

• name — String containing the name of the type of appender to be instantiated.

setLayout

void log4shib::PropertyConfiguratorImpl::setLayout (Appender * appender, const std::string & name) [protected]

Method for instantiating and configuring the layouts associated with each appender 🎀.

Parameters

• appender — Appender to which we are setting this layout.
• name — Name in the properties of this appender.

🍓 Member Data Documentation 🍓

• AppenderMap log4shib::PropertyConfiguratorImpl::_allAppenders [protected] — protected member data.
• Properties log4shib::PropertyConfiguratorImpl::_properties [protected] — protected member data.

👑 Author 👑

Generated automatically by Doxygen for log4shib from the source code.

---

okay that's the whole page, bestie 🫶. Cute little sign-off: the footer vibe is source/version log4shib, Version 2.0.1, plus the title log4shib::...uratorImpl(3) — and there's no separate date text in this footer, so I'm not inventing one, periodt ✨💅.