Apache Log4cxx  Version 1.3.1
domconfigurator.h
Go to the documentation of this file.
1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements. See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 
18 #ifndef _LOG4CXX_XML_DOM_CONFIGURATOR_H
19 #define _LOG4CXX_XML_DOM_CONFIGURATOR_H
20 
21 #include <log4cxx/logstring.h>
22 #include <map>
23 #include <log4cxx/appender.h>
24 #include <log4cxx/layout.h>
25 #include <log4cxx/logger.h>
29 #include <log4cxx/spi/filter.h>
32 #include <log4cxx/file.h>
34 
35 #if LOG4CXX_HAS_DOMCONFIGURATOR
36 
37 extern "C" {
38  struct apr_xml_doc;
39  struct apr_xml_elem;
40 }
41 
42 namespace LOG4CXX_NS
43 {
44 
45 namespace xml
46 {
47 class XMLWatchdog;
48 
64 class LOG4CXX_EXPORT DOMConfigurator :
65  virtual public spi::Configurator
66 {
67  public:
69 
70  protected:
71  typedef std::map<LogString, AppenderPtr> AppenderMap;
76  LOG4CXX_NS::helpers::Pool& p,
77  LOG4CXX_NS::helpers::CharsetDecoderPtr& utf8Decoder,
78  apr_xml_elem* elem,
79  apr_xml_doc* doc,
80  const LogString& appenderName,
81  AppenderMap& appenders);
82 
87  LOG4CXX_NS::helpers::Pool& p,
88  LOG4CXX_NS::helpers::CharsetDecoderPtr& utf8Decoder,
89  apr_xml_elem* appenderRef,
90  apr_xml_doc* doc,
91  AppenderMap& appenders);
92 
97  LOG4CXX_NS::helpers::Pool& p,
98  LOG4CXX_NS::helpers::CharsetDecoderPtr& utf8Decoder,
99  apr_xml_elem* appenderElement,
100  apr_xml_doc* doc,
101  AppenderMap& appenders);
102 
107  LOG4CXX_NS::helpers::Pool& p,
108  LOG4CXX_NS::helpers::CharsetDecoderPtr& utf8Decoder,
109  apr_xml_elem* element,
110  AppenderPtr& appender,
111  apr_xml_doc* doc,
112  AppenderMap& appenders);
113 
118  LOG4CXX_NS::helpers::Pool& p,
119  LOG4CXX_NS::helpers::CharsetDecoderPtr& utf8Decoder,
120  apr_xml_elem* element,
121  std::vector<LOG4CXX_NS::spi::FilterPtr>& filters);
122 
127  LOG4CXX_NS::helpers::Pool& p,
128  LOG4CXX_NS::helpers::CharsetDecoderPtr& utf8Decoder,
129  apr_xml_elem* loggerElement,
130  apr_xml_doc* doc,
131  AppenderMap& appenders);
132 
137  LOG4CXX_NS::helpers::Pool& p,
138  LOG4CXX_NS::helpers::CharsetDecoderPtr& utf8Decoder,
139  apr_xml_elem* factoryElement);
140 
145  LOG4CXX_NS::helpers::Pool& p,
146  LOG4CXX_NS::helpers::CharsetDecoderPtr& utf8Decoder,
147  apr_xml_elem* factoryElement);
148 
152  LOG4CXX_NS::rolling::RollingPolicyPtr parseRollingPolicy(
153  LOG4CXX_NS::helpers::Pool& p,
154  LOG4CXX_NS::helpers::CharsetDecoderPtr& utf8Decoder,
155  apr_xml_elem* factoryElement);
156 
160  void parseRoot(LOG4CXX_NS::helpers::Pool& p,
161  LOG4CXX_NS::helpers::CharsetDecoderPtr& utf8Decoder,
162  apr_xml_elem* rootElement, apr_xml_doc* doc, AppenderMap& appenders);
163 
168  LOG4CXX_NS::helpers::Pool& p,
169  LOG4CXX_NS::helpers::CharsetDecoderPtr& utf8Decoder,
170  apr_xml_elem* catElement,
171  LoggerPtr logger, bool isRoot,
172  apr_xml_doc* doc,
173  AppenderMap& appenders );
174 
179  LOG4CXX_NS::helpers::Pool& p,
180  LOG4CXX_NS::helpers::CharsetDecoderPtr& utf8Decoder,
181  apr_xml_elem* layout_element);
182 
187  LOG4CXX_NS::helpers::Pool& p,
188  LOG4CXX_NS::helpers::CharsetDecoderPtr& utf8Decoder,
189  apr_xml_elem* element,
190  LoggerPtr logger, bool isRoot);
191 
193  LOG4CXX_NS::helpers::Pool& p,
194  LOG4CXX_NS::helpers::CharsetDecoderPtr& utf8Decoder,
195  apr_xml_elem* elem,
196  LOG4CXX_NS::config::PropertySetter& propSetter);
197 
202  void parse(
203  LOG4CXX_NS::helpers::Pool& p,
204  LOG4CXX_NS::helpers::CharsetDecoderPtr& utf8Decoder,
205  apr_xml_elem* element,
206  apr_xml_doc* doc,
207  AppenderMap& appenders);
208 
209  public:
211 
214  LOG4CXX_CAST_ENTRY(spi::Configurator)
216 
217  DOMConfigurator(LOG4CXX_NS::helpers::Pool& p);
218 
219 #if LOG4CXX_ABI_VERSION <= 15
223  static spi::ConfigurationStatus configure(const char* filename) { return configure(std::string(filename)); }
227  static spi::ConfigurationStatus configure(const std::string& filename);
228 #if LOG4CXX_WCHAR_T_API
232  static spi::ConfigurationStatus configure(const wchar_t* filename) { return configure(std::wstring(filename)); }
236  static spi::ConfigurationStatus configure(const std::wstring& filename);
237 #endif
238 #if LOG4CXX_UNICHAR_API || LOG4CXX_LOGCHAR_IS_UNICHAR
242  static spi::ConfigurationStatus configure(const std::basic_string<UniChar>& filename);
243 #endif
244 #if LOG4CXX_CFSTRING_API
249 #endif
256  static spi::ConfigurationStatus configureAndWatch(const std::string& configFilename);
257 #if LOG4CXX_WCHAR_T_API
264  static spi::ConfigurationStatus configureAndWatch(const std::wstring& configFilename);
265 #endif
266 #if LOG4CXX_UNICHAR_API || LOG4CXX_LOGCHAR_IS_UNICHAR
273  static spi::ConfigurationStatus configureAndWatch(const std::basic_string<UniChar>& configFilename);
274 #endif
275 #if LOG4CXX_CFSTRING_API
283 #endif
297  static spi::ConfigurationStatus configureAndWatch(const std::string& configFilename,
298  long delay);
299 #if LOG4CXX_WCHAR_T_API
303  static spi::ConfigurationStatus configureAndWatch(const std::wstring& configFilename,
304  long delay);
305 #endif
306 #if LOG4CXX_UNICHAR_API || LOG4CXX_LOGCHAR_IS_UNICHAR
310  static spi::ConfigurationStatus configureAndWatch(const std::basic_string<UniChar>& configFilename,
311  long delay);
312 #endif
313 #if LOG4CXX_CFSTRING_API
318  long delay);
319 #endif
320 #endif // LOG4CXX_ABI_VERSION <= 15
321 
335  ( const File& filename
336 #if LOG4CXX_ABI_VERSION <= 15
337  , spi::LoggerRepositoryPtr repository
338 #else
339  , const spi::LoggerRepositoryPtr& repository = spi::LoggerRepositoryPtr()
340 #endif
341  ) override;
342 
347  static spi::ConfigurationStatus configure(const File& configFilename);
348 
363  static spi::ConfigurationStatus configureAndWatch(const File& configFilename, long delay = 0);
364 
365  protected:
367  LOG4CXX_NS::helpers::CharsetDecoderPtr& utf8Decoder,
368  apr_xml_elem*,
369  const std::string& attrName);
370 
371  LogString subst(const LogString& value);
372 
373  private:
374  // prevent assignment or copy statements
376  DOMConfigurator& operator=(const DOMConfigurator&);
377  static XMLWatchdog* xdog;
378 
379  LOG4CXX_DECLARE_PRIVATE_MEMBER_PTR(DOMConfiguratorPrivate, m_priv)
380 };
382 } // namespace xml
383 } // namespace log4cxx
384 
385 #endif /* LOG4CXX_HAS_DOMCONFIGURATOR */
386 
387 #endif // _LOG4CXX_XML_DOM_CONFIGURATOR_H
An abstract representation of file and directory path names.
Definition: file.h:41
Implemented by classes capable of configuring log4j using a URL.
Definition: configurator.h:39
Use this class to initialize the log4cxx environment using a DOM tree.
Definition: domconfigurator.h:66
spi::ConfigurationStatus doConfigure(const File &filename, spi::LoggerRepositoryPtr repository) override
Interpret filename as an XML file and set up Log4cxx accordingly.
void parseErrorHandler(log4cxx::helpers::Pool &p, log4cxx::helpers::CharsetDecoderPtr &utf8Decoder, apr_xml_elem *element, AppenderPtr &appender, apr_xml_doc *doc, AppenderMap &appenders)
Used internally to parse an ErrorHandler element.
void parseLevel(log4cxx::helpers::Pool &p, log4cxx::helpers::CharsetDecoderPtr &utf8Decoder, apr_xml_elem *element, LoggerPtr logger, bool isRoot)
Used internally to parse a level element.
static spi::ConfigurationStatus configure(const std::basic_string< UniChar > &filename)
A static version of doConfigure.
static spi::ConfigurationStatus configure(const std::wstring &filename)
A static version of doConfigure.
void parseLoggerFactory(log4cxx::helpers::Pool &p, log4cxx::helpers::CharsetDecoderPtr &utf8Decoder, apr_xml_elem *factoryElement)
Used internally to parse the logger factory element.
AppenderPtr parseAppender(log4cxx::helpers::Pool &p, log4cxx::helpers::CharsetDecoderPtr &utf8Decoder, apr_xml_elem *appenderElement, apr_xml_doc *doc, AppenderMap &appenders)
Used internally to parse an appender element.
static spi::ConfigurationStatus configureAndWatch(const File &configFilename, long delay=0)
Read configuration options from configFilename (if it exists).
static spi::ConfigurationStatus configure(const char *filename)
A static version of doConfigure.
Definition: domconfigurator.h:223
void parseRoot(log4cxx::helpers::Pool &p, log4cxx::helpers::CharsetDecoderPtr &utf8Decoder, apr_xml_elem *rootElement, apr_xml_doc *doc, AppenderMap &appenders)
Used internally to parse the root logger element.
static spi::ConfigurationStatus configure(const CFStringRef &filename)
A static version of doConfigure.
log4cxx::helpers::ObjectPtr parseTriggeringPolicy(log4cxx::helpers::Pool &p, log4cxx::helpers::CharsetDecoderPtr &utf8Decoder, apr_xml_elem *factoryElement)
Used internally to parse the logger factory element.
AppenderPtr findAppenderByReference(log4cxx::helpers::Pool &p, log4cxx::helpers::CharsetDecoderPtr &utf8Decoder, apr_xml_elem *appenderRef, apr_xml_doc *doc, AppenderMap &appenders)
Used internally to parse appenders by IDREF element.
static spi::ConfigurationStatus configureAndWatch(const CFStringRef &configFilename, long delay)
Refer configureAndWatch(const File& filename, long delay)
static spi::ConfigurationStatus configureAndWatch(const CFStringRef &configFilename)
Like configureAndWatch(const File& filename, long delay) except that the default delay as defined by ...
static spi::ConfigurationStatus configure(const wchar_t *filename)
A static version of doConfigure.
Definition: domconfigurator.h:232
static spi::ConfigurationStatus configureAndWatch(const std::basic_string< UniChar > &configFilename)
Like configureAndWatch(const File& filename, long delay) except that the default delay as defined by ...
std::map< LogString, AppenderPtr > AppenderMap
Definition: domconfigurator.h:71
LayoutPtr parseLayout(log4cxx::helpers::Pool &p, log4cxx::helpers::CharsetDecoderPtr &utf8Decoder, apr_xml_elem *layout_element)
Used internally to parse a layout element.
void setParameter(log4cxx::helpers::Pool &p, log4cxx::helpers::CharsetDecoderPtr &utf8Decoder, apr_xml_elem *elem, log4cxx::config::PropertySetter &propSetter)
void parseFilters(log4cxx::helpers::Pool &p, log4cxx::helpers::CharsetDecoderPtr &utf8Decoder, apr_xml_elem *element, std::vector< log4cxx::spi::FilterPtr > &filters)
Used internally to parse a filter element.
static spi::ConfigurationStatus configure(const File &configFilename)
Read configuration options from configFilename.
static spi::ConfigurationStatus configureAndWatch(const std::string &configFilename)
Like configureAndWatch(const File& filename, long delay) except that the default delay as defined by ...
static spi::ConfigurationStatus configureAndWatch(const std::string &configFilename, long delay)
Read the configuration file configFilename if it exists.
void parseChildrenOfLoggerElement(log4cxx::helpers::Pool &p, log4cxx::helpers::CharsetDecoderPtr &utf8Decoder, apr_xml_elem *catElement, LoggerPtr logger, bool isRoot, apr_xml_doc *doc, AppenderMap &appenders)
Used internally to parse the children of a logger element.
LogString subst(const LogString &value)
AppenderPtr findAppenderByName(log4cxx::helpers::Pool &p, log4cxx::helpers::CharsetDecoderPtr &utf8Decoder, apr_xml_elem *elem, apr_xml_doc *doc, const LogString &appenderName, AppenderMap &appenders)
Used internally to parse appenders by IDREF name.
void parseLogger(log4cxx::helpers::Pool &p, log4cxx::helpers::CharsetDecoderPtr &utf8Decoder, apr_xml_elem *loggerElement, apr_xml_doc *doc, AppenderMap &appenders)
Used internally to parse a logger element.
static spi::ConfigurationStatus configure(const std::string &filename)
A static version of doConfigure.
log4cxx::rolling::RollingPolicyPtr parseRollingPolicy(log4cxx::helpers::Pool &p, log4cxx::helpers::CharsetDecoderPtr &utf8Decoder, apr_xml_elem *factoryElement)
Used internally to parse the logger factory element.
static LogString getAttribute(log4cxx::helpers::CharsetDecoderPtr &utf8Decoder, apr_xml_elem *, const std::string &attrName)
static spi::ConfigurationStatus configureAndWatch(const std::wstring &configFilename, long delay)
Refer configureAndWatch(const File& filename, long delay)
static spi::ConfigurationStatus configureAndWatch(const std::basic_string< UniChar > &configFilename, long delay)
Refer configureAndWatch(const File& filename, long delay)
void parse(log4cxx::helpers::Pool &p, log4cxx::helpers::CharsetDecoderPtr &utf8Decoder, apr_xml_elem *element, apr_xml_doc *doc, AppenderMap &appenders)
Used internally to configure the log4cxx framework from an in-memory representation of an XML documen...
static spi::ConfigurationStatus configureAndWatch(const std::wstring &configFilename)
Like configureAndWatch(const File& filename, long delay) except that the default delay as defined by ...
const struct __CFString * CFStringRef
Definition: logstring.h:30
std::shared_ptr< Object > ObjectPtr
Definition: optionconverter.h:40
std::shared_ptr< LoggerRepository > LoggerRepositoryPtr
Definition: optionconverter.h:32
ConfigurationStatus
Definition: configurator.h:30
LOG4CXX_PTR_DEF(DOMConfigurator)
std::basic_string< logchar > LogString
Definition: logstring.h:60
std::shared_ptr< Layout > LayoutPtr
Definition: appender.h:41
std::shared_ptr< Appender > AppenderPtr
Definition: basicconfigurator.h:28
std::shared_ptr< Logger > LoggerPtr
Definition: defaultloggerfactory.h:26
#define LOG4CXX_CAST_ENTRY(Interface)
Definition: object.h:158
#define END_LOG4CXX_CAST_MAP()
Definition: object.h:152
#define DECLARE_LOG4CXX_OBJECT(object)
Definition: object.h:43
#define BEGIN_LOG4CXX_CAST_MAP()
Definition: object.h:146