Log::Log4perl::Config::BaseConfigurator - Configurator Base Class
This is a virtual base class, all configurators should be derived from it.
new
my $config_parser = SomeConfigParser->new( file => $file, );
my $data = $config_parser->parse();
Instead of file
, the derived class SomeConfigParser
may define any
type of configuration input medium (e.g. url => 'http://foobar'
).
It just has to make sure its parse()
method will later pull the input
data from the medium specified.
The base class accepts a filename or a reference to an array of text lines:
file
parse()
method later parses.
text
my $config_parser = MyYAMLParser->new( text => ['foo: bar', 'baz: bam', ], );
my $data = $config_parser->parse();
If either file
or text
parameters have been specified in the
constructor call, a later call to the configurator's text()
method
will return a reference to an array of configuration text lines.
This will typically be used by the parse()
method to process the
input.
parse
parse()
method returns a reference to a hash of hashes (HoH).
The top-most hash contains the
top-level keywords (category
, appender
) as keys, associated
with values which are references to more deeply nested hashes.
The log4perl.
prefix (e.g. as used in the PropertyConfigurator class)
is stripped, it's not part in the HoH structure.
Each Log4perl config value is indicated by the value
key, as in
$data->{category}->{Bar}->{Twix}->{value} = "WARN, Logfile"
The following Log::Log4perl configuration:
log4perl.category.Bar.Twix = WARN, Screen log4perl.appender.Screen = Log::Log4perl::Appender::File log4perl.appender.Screen.filename = test.log log4perl.appender.Screen.layout = Log::Log4perl::Layout::SimpleLayout
needs to be transformed by the parser's parse()
method
into this data structure:
{ appender => { Screen => { layout => { value => "Log::Log4perl::Layout::SimpleLayout" }, value => "Log::Log4perl::Appender::Screen", }, }, category => { Bar => { Twix => { value => "WARN, Screen" } } } }
For a full-fledged example, check out the sample YAML parser implementation
in eg/yamlparser
. It uses a simple YAML syntax to specify the Log4perl
configuration to illustrate the concept.
eg::L4pResurrectable, Log::Log4perl, Log::Log4perl::NDC, Log::Log4perl::Config, Log::Log4perl::Appender, Log::Log4perl::Util, Log::Log4perl::Level, Log::Log4perl::Filter, Log::Log4perl::Logger, Log::Log4perl::Layout, Log::Log4perl::JavaMap, Log::Log4perl::FAQ, Log::Log4perl::MDC, Log::Log4perl::Resurrector, Log::Log4perl::DateFormat, Log::Log4perl::Filter::Boolean, Log::Log4perl::Filter::LevelRange, Log::Log4perl::Filter::LevelMatch, Log::Log4perl::Filter::StringMatch, Log::Log4perl::Config::Watch, Log::Log4perl::Config::PropertyConfigurator, Log::Log4perl::Config::DOMConfigurator, Log::Log4perl::Config::BaseConfigurator, Log::Log4perl::JavaMap::FileAppender, Log::Log4perl::JavaMap::RollingFileAppender, Log::Log4perl::JavaMap::NTEventLogAppender, Log::Log4perl::JavaMap::TestBuffer, Log::Log4perl::JavaMap::JDBCAppender, Log::Log4perl::JavaMap::ConsoleAppender, Log::Log4perl::JavaMap::SyslogAppender, Log::Log4perl::Util::Semaphore, Log::Log4perl::Appender::Synchronized, Log::Log4perl::Appender::RRDs, Log::Log4perl::Appender::Screen, Log::Log4perl::Appender::DBI, Log::Log4perl::Appender::TestBuffer, Log::Log4perl::Appender::ScreenColoredLevels, Log::Log4perl::Appender::Socket, Log::Log4perl::Appender::Buffer, Log::Log4perl::Appender::Limit, Log::Log4perl::Appender::File, Log::Log4perl::Appender::TestFileCreeper, Log::Log4perl::Appender::TestArrayBuffer, Log::Log4perl::Appender::String, Log::Log4perl::Layout::PatternLayout, Log::Log4perl::Layout::SimpleLayout, Log::Log4perl::Layout::NoopLayout, Log::Log4perl::Layout::PatternLayout::Multiline
Source Code: Log::Log4perl::Config::BaseConfigurator
Mike Schilli, <m@perlmeister.com>, 2004 Kevin Goess, <cpan@goess.org> Jan-2003