hierarchy.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_HIERARCHY_H
#define _LOG4CXX_HIERARCHY_H

#if defined(_MSC_VER)
    #pragma warning (push)
    #pragma warning ( disable: 4231 4251 4275 4786 )
#endif

#include <log4cxx/spi/loggerrepository.h>
#include <log4cxx/spi/loggerfactory.h>
#include <vector>
#include <map>
#include <log4cxx/provisionnode.h>
#include <log4cxx/helpers/object.h>
#include <log4cxx/spi/hierarchyeventlistener.h>
#include <log4cxx/helpers/pool.h>

namespace log4cxx
{

class Hierarchy;
LOG4CXX_PTR_DEF(Hierarchy);

class LOG4CXX_EXPORT Hierarchy :
    public virtual spi::LoggerRepository,
    public virtual helpers::Object,
    public std::enable_shared_from_this<Hierarchy>
{
    private:
        log4cxx::helpers::Pool pool;
        mutable std::mutex mutex;
        bool configured;

        spi::LoggerFactoryPtr defaultFactory;
        spi::HierarchyEventListenerList listeners;

        typedef std::map<LogString, LoggerPtr> LoggerMap;
        std::unique_ptr<LoggerMap> loggers;

        typedef std::map<LogString, ProvisionNode> ProvisionNodeMap;
        std::unique_ptr<ProvisionNodeMap> provisionNodes;

        LoggerPtr root;

        int thresholdInt;
        LevelPtr threshold;

        bool emittedNoAppenderWarning;
        bool emittedNoResourceBundleWarning;

    public:
        DECLARE_ABSTRACT_LOG4CXX_OBJECT(Hierarchy)
        BEGIN_LOG4CXX_CAST_MAP()
        LOG4CXX_CAST_ENTRY(spi::LoggerRepository)
        END_LOG4CXX_CAST_MAP()

    private:
        Hierarchy();

    public:
        static HierarchyPtr create();

        ~Hierarchy();

        void addHierarchyEventListener(const spi::HierarchyEventListenerPtr& listener);

        void clear();

        void emitNoAppenderWarning(const Logger* logger);

        LoggerPtr exists(const LogString& name);

        void setThreshold(const LogString& levelStr);

        void setThreshold(const LevelPtr& l);

        void fireAddAppenderEvent(const Logger* logger, const Appender* appender);

        void fireRemoveAppenderEvent(const Logger* logger,
            const Appender* appender);

        const LevelPtr& getThreshold() const;

        LoggerPtr getLogger(const LogString& name);

        LoggerPtr getLogger(const LogString& name,
            const spi::LoggerFactoryPtr& factory);

        LoggerList getCurrentLoggers() const;

        LoggerPtr getRootLogger() const;

        bool isDisabled(int level) const;

        void resetConfiguration();

        void shutdown();


        virtual bool isConfigured();
        virtual void setConfigured(bool configured);


    private:

        void setThresholdInternal(const LevelPtr& l);

        void shutdownInternal();

        void updateParents(LoggerPtr logger);

        Hierarchy(const Hierarchy&);
        Hierarchy& operator=(const Hierarchy&);

        void updateChildren(ProvisionNode& pn, LoggerPtr logger);

        void configureRoot();
};

}  //namespace log4cxx


#if defined(_MSC_VER)
    #pragma warning (pop)
#endif

#endif //_LOG4CXX_HIERARCHY_H