propertyconfigurator.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_PROPERTY_CONFIGURATOR_H
#define _LOG4CXX_PROPERTY_CONFIGURATOR_H
 
#include <log4cxx/helpers/object.h>
#include <log4cxx/logstring.h>
#include <log4cxx/spi/configurator.h>
#include <map>
 
#include <log4cxx/file.h>
 
namespace LOG4CXX_NS
{
class Logger;
typedef std::shared_ptr<Logger> LoggerPtr;
 
class Appender;
typedef std::shared_ptr<Appender> AppenderPtr;
 
namespace helpers
{
class Properties;
}
 
 
namespace spi
{
class LoggerFactory;
typedef std::shared_ptr<LoggerFactory> LoggerFactoryPtr;
}
 
class PropertyWatchdog;
class LOG4CXX_EXPORT PropertyConfigurator :
    virtual public spi::Configurator,
    virtual public helpers::Object
{
#if 15 < LOG4CXX_ABI_VERSION
    private:
        struct PrivateData;
        LOG4CXX_DECLARE_PRIVATE_MEMBER_PTR(PrivateData, m_priv)
#else
    protected:

        std::map<LogString, AppenderPtr>* registry;

        LOG4CXX_DECLARE_PRIVATE_MEMBER(spi::LoggerFactoryPtr, loggerFactory)
#endif
    public:
        DECLARE_LOG4CXX_OBJECT(PropertyConfigurator)
        BEGIN_LOG4CXX_CAST_MAP()
#if 15 < LOG4CXX_ABI_VERSION
        LOG4CXX_CAST_ENTRY(PropertyConfigurator)
        LOG4CXX_CAST_ENTRY_CHAIN(spi::Configurator)
#else
        LOG4CXX_CAST_ENTRY(spi::Configurator)
#endif
        END_LOG4CXX_CAST_MAP()
 
        PropertyConfigurator();
        virtual ~PropertyConfigurator();
        spi::ConfigurationStatus doConfigure
            ( const File&                     configFileName
#if LOG4CXX_ABI_VERSION <= 15
            , spi::LoggerRepositoryPtr        repository
#else
            , const spi::LoggerRepositoryPtr& repository = spi::LoggerRepositoryPtr()
#endif
            ) override;

        static spi::ConfigurationStatus configure(const File& configFilename);
 
#if LOG4CXX_ABI_VERSION <= 15
        static spi::ConfigurationStatus configureAndWatch(const File& configFilename);
#endif
        static spi::ConfigurationStatus configureAndWatch(const File& configFilename,
            long delay = 0);

        static spi::ConfigurationStatus configure(helpers::Properties& properties);

        spi::ConfigurationStatus doConfigure(helpers::Properties& properties,
            spi::LoggerRepositoryPtr hierarchy);
 
        // --------------------------------------------------------------------------
        // Internal stuff
        // --------------------------------------------------------------------------
    protected:
        void configureLoggerFactory(helpers::Properties& props);
 
        void configureRootLogger(helpers::Properties& props,
            spi::LoggerRepositoryPtr& hierarchy);

        void parseCatsAndRenderers(helpers::Properties& props,
            spi::LoggerRepositoryPtr& hierarchy);

        bool parseAdditivityForLogger(helpers::Properties& props,
            LoggerPtr& cat, const LogString& loggerName);

        void parseLogger(
            helpers::Properties& props, LoggerPtr& logger,
            const LogString& optionKey, const LogString& loggerName,
            const LogString& value, bool additivity);
 
        AppenderPtr parseAppender(
            helpers::Properties& props, const LogString& appenderName);
 
        void registryPut(const AppenderPtr& appender);
        AppenderPtr registryGet(const LogString& name);
 
    private:
        PropertyConfigurator(const PropertyConfigurator&);
        PropertyConfigurator& operator=(const PropertyConfigurator&);
}; // class PropertyConfigurator
}  // namespace log4cxx
 
 
#endif //_LOG4CXX_PROPERTY_CONFIGURATOR_H