domconfigurator.h

Go to the documentation of this file.

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef _LOG4CXX_XML_DOM_CONFIGURATOR_H
#define _LOG4CXX_XML_DOM_CONFIGURATOR_H
 
#include <log4cxx/logstring.h>
#include <log4cxx/spi/configurator.h>
#if LOG4CXX_ABI_VERSION <= 15
#include <log4cxx/appender.h>
#include <log4cxx/layout.h>
#include <log4cxx/logger.h>
#include <log4cxx/helpers/properties.h>
#include <log4cxx/helpers/charsetdecoder.h>
#include <log4cxx/spi/filter.h>
#include <log4cxx/rolling/triggeringpolicy.h>
#include <log4cxx/rolling/rollingpolicy.h>
#include <log4cxx/config/propertysetter.h>
#include <map>
#endif
#include <log4cxx/file.h>
 
#if LOG4CXX_HAS_DOMCONFIGURATOR
 
extern "C" {
    struct apr_xml_doc;
    struct apr_xml_elem;
}
 
namespace LOG4CXX_NS
{
 
namespace xml
{
class XMLWatchdog;

class LOG4CXX_EXPORT DOMConfigurator :
    virtual public spi::Configurator
{
    public:
        ~DOMConfigurator();
 
#if LOG4CXX_ABI_VERSION <= 15
    protected:
        typedef std::map<LogString, AppenderPtr> AppenderMap;
        AppenderPtr findAppenderByName(
            LOG4CXX_NS::helpers::Pool& p,
            LOG4CXX_NS::helpers::CharsetDecoderPtr& utf8Decoder,
            apr_xml_elem* elem,
            apr_xml_doc* doc,
            const LogString& appenderName,
            AppenderMap& appenders);

        AppenderPtr findAppenderByReference(
            LOG4CXX_NS::helpers::Pool& p,
            LOG4CXX_NS::helpers::CharsetDecoderPtr& utf8Decoder,
            apr_xml_elem* appenderRef,
            apr_xml_doc* doc,
            AppenderMap& appenders);

        AppenderPtr parseAppender(
            LOG4CXX_NS::helpers::Pool& p,
            LOG4CXX_NS::helpers::CharsetDecoderPtr& utf8Decoder,
            apr_xml_elem* appenderElement,
            apr_xml_doc* doc,
            AppenderMap& appenders);

        void parseErrorHandler(
            LOG4CXX_NS::helpers::Pool& p,
            LOG4CXX_NS::helpers::CharsetDecoderPtr& utf8Decoder,
            apr_xml_elem* element,
            AppenderPtr& appender,
            apr_xml_doc* doc,
            AppenderMap& appenders);

        void parseFilters(
            LOG4CXX_NS::helpers::Pool& p,
            LOG4CXX_NS::helpers::CharsetDecoderPtr& utf8Decoder,
            apr_xml_elem* element,
            std::vector<LOG4CXX_NS::spi::FilterPtr>& filters);

        void parseLogger(
            LOG4CXX_NS::helpers::Pool& p,
            LOG4CXX_NS::helpers::CharsetDecoderPtr& utf8Decoder,
            apr_xml_elem* loggerElement,
            apr_xml_doc* doc,
            AppenderMap& appenders);

        void parseLoggerFactory(
            LOG4CXX_NS::helpers::Pool& p,
            LOG4CXX_NS::helpers::CharsetDecoderPtr& utf8Decoder,
            apr_xml_elem* factoryElement);

        LOG4CXX_NS::helpers::ObjectPtr parseTriggeringPolicy(
            LOG4CXX_NS::helpers::Pool& p,
            LOG4CXX_NS::helpers::CharsetDecoderPtr& utf8Decoder,
            apr_xml_elem* factoryElement);

        LOG4CXX_NS::rolling::RollingPolicyPtr parseRollingPolicy(
            LOG4CXX_NS::helpers::Pool& p,
            LOG4CXX_NS::helpers::CharsetDecoderPtr& utf8Decoder,
            apr_xml_elem* factoryElement);

        void parseRoot(LOG4CXX_NS::helpers::Pool& p,
            LOG4CXX_NS::helpers::CharsetDecoderPtr& utf8Decoder,
            apr_xml_elem* rootElement, apr_xml_doc* doc, AppenderMap& appenders);

        void parseChildrenOfLoggerElement(
            LOG4CXX_NS::helpers::Pool& p,
            LOG4CXX_NS::helpers::CharsetDecoderPtr& utf8Decoder,
            apr_xml_elem* catElement,
            LoggerPtr logger, bool isRoot,
            apr_xml_doc* doc,
            AppenderMap& appenders );

        LayoutPtr parseLayout(
            LOG4CXX_NS::helpers::Pool& p,
            LOG4CXX_NS::helpers::CharsetDecoderPtr& utf8Decoder,
            apr_xml_elem* layout_element);

        void parseLevel(
            LOG4CXX_NS::helpers::Pool& p,
            LOG4CXX_NS::helpers::CharsetDecoderPtr& utf8Decoder,
            apr_xml_elem* element,
            LoggerPtr logger, bool isRoot);
 
        void setParameter(
            LOG4CXX_NS::helpers::Pool& p,
            LOG4CXX_NS::helpers::CharsetDecoderPtr& utf8Decoder,
            apr_xml_elem* elem,
            LOG4CXX_NS::config::PropertySetter& propSetter);

        void parse(
            LOG4CXX_NS::helpers::Pool& p,
            LOG4CXX_NS::helpers::CharsetDecoderPtr& utf8Decoder,
            apr_xml_elem* element,
            apr_xml_doc* doc,
            AppenderMap& appenders);
#endif // LOG4CXX_ABI_VERSION <= 15
 
    public:
        DOMConfigurator();
 
        DECLARE_LOG4CXX_OBJECT(DOMConfigurator)
        BEGIN_LOG4CXX_CAST_MAP()
        LOG4CXX_CAST_ENTRY(spi::Configurator)
        END_LOG4CXX_CAST_MAP()
 
#if LOG4CXX_ABI_VERSION <= 15
        DOMConfigurator(LOG4CXX_NS::helpers::Pool& p);

        static spi::ConfigurationStatus configure(const char* filename) { return configure(std::string(filename)); }
        static spi::ConfigurationStatus configure(const std::string& filename);
#if LOG4CXX_WCHAR_T_API
        static spi::ConfigurationStatus configure(const wchar_t* filename) { return configure(std::wstring(filename)); }
        static spi::ConfigurationStatus configure(const std::wstring& filename);
#endif
#if LOG4CXX_UNICHAR_API || LOG4CXX_LOGCHAR_IS_UNICHAR
        static spi::ConfigurationStatus configure(const std::basic_string<UniChar>& filename);
#endif
#if LOG4CXX_CFSTRING_API
        static spi::ConfigurationStatus configure(const CFStringRef& filename);
#endif
        static spi::ConfigurationStatus configureAndWatch(const std::string& configFilename);
#if LOG4CXX_WCHAR_T_API
        static spi::ConfigurationStatus configureAndWatch(const std::wstring& configFilename);
#endif
#if LOG4CXX_UNICHAR_API || LOG4CXX_LOGCHAR_IS_UNICHAR
        static spi::ConfigurationStatus configureAndWatch(const std::basic_string<UniChar>& configFilename);
#endif
#if LOG4CXX_CFSTRING_API
        static spi::ConfigurationStatus configureAndWatch(const CFStringRef& configFilename);
#endif
        static spi::ConfigurationStatus configureAndWatch(const std::string& configFilename,
            long delay);
#if LOG4CXX_WCHAR_T_API
        static spi::ConfigurationStatus configureAndWatch(const std::wstring& configFilename,
            long delay);
#endif
#if LOG4CXX_UNICHAR_API || LOG4CXX_LOGCHAR_IS_UNICHAR
        static spi::ConfigurationStatus configureAndWatch(const std::basic_string<UniChar>& configFilename,
            long delay);
#endif
#if LOG4CXX_CFSTRING_API
        static spi::ConfigurationStatus configureAndWatch(const CFStringRef& configFilename,
            long delay);
#endif
#endif // LOG4CXX_ABI_VERSION <= 15

        spi::ConfigurationStatus doConfigure
            ( const File&                     filename
#if LOG4CXX_ABI_VERSION <= 15
            , spi::LoggerRepositoryPtr        repository
#else
            , const spi::LoggerRepositoryPtr& repository = spi::LoggerRepositoryPtr()
#endif
            ) override;

        static spi::ConfigurationStatus configure(const File& configFilename);

        static spi::ConfigurationStatus configureAndWatch(const File& configFilename, long delay = 0);
 
#if LOG4CXX_ABI_VERSION <= 15
    protected:
        static LogString getAttribute(
            LOG4CXX_NS::helpers::CharsetDecoderPtr& utf8Decoder,
            apr_xml_elem*,
            const std::string& attrName);
 
        LogString subst(const LogString& value);
#endif
 
    private:
        //   prevent assignment or copy statements
        DOMConfigurator(const DOMConfigurator&);
        DOMConfigurator& operator=(const DOMConfigurator&);
 
        LOG4CXX_DECLARE_PRIVATE_MEMBER_PTR(DOMConfiguratorPrivate, m_priv)
};
LOG4CXX_PTR_DEF(DOMConfigurator);
}  // namespace xml
} // namespace log4cxx
 
#endif /* LOG4CXX_HAS_DOMCONFIGURATOR */
 
#endif // _LOG4CXX_XML_DOM_CONFIGURATOR_H