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
 
 
#include <log4cxx/spi/loggerrepository.h>
#include <log4cxx/spi/loggerfactory.h>
#include <log4cxx/provisionnode.h>
#include <log4cxx/spi/hierarchyeventlistener.h>
 
namespace LOG4CXX_NS
{
 
class Hierarchy;
LOG4CXX_PTR_DEF(Hierarchy);
 
class LOG4CXX_EXPORT Hierarchy : public spi::LoggerRepository
{
    private:
        LOG4CXX_DECLARE_PRIVATE_MEMBER_PTR(HierarchyPrivate, m_priv)
 
    public:
        DECLARE_ABSTRACT_LOG4CXX_OBJECT(Hierarchy)
        BEGIN_LOG4CXX_CAST_MAP()
#if 15 < LOG4CXX_ABI_VERSION
        LOG4CXX_CAST_ENTRY(Hierarchy)
        LOG4CXX_CAST_ENTRY_CHAIN(spi::LoggerRepository)
#else
        LOG4CXX_CAST_ENTRY(spi::LoggerRepository)
#endif
        END_LOG4CXX_CAST_MAP()
 
    private:
        Hierarchy();
 
    public:
        static HierarchyPtr create();
 
        ~Hierarchy();
 
        void addHierarchyEventListener(const spi::HierarchyEventListenerPtr& listener) override;
 
#if LOG4CXX_ABI_VERSION <= 15
        void removeHierarchyEventListener(const spi::HierarchyEventListenerPtr& listener);
#else
        void removeHierarchyEventListener(const spi::HierarchyEventListenerPtr& listener) override;
#endif
 
        void ensureIsConfigured(std::function<void()> configurator) override;
 
        void clear();
 
        void emitNoAppenderWarning(const Logger* logger) override;
 
        LoggerPtr exists(const LogString& name) override;
 
        void setThreshold(const LogString& levelStr) override;
 
        void setThreshold(const LevelPtr& newLevel) override;
 
        void fireAddAppenderEvent(const Logger* logger, const Appender* appender) override;
 
        void fireRemoveAppenderEvent(const Logger* logger, const Appender* appender) override;
 
        LevelPtr getThreshold() const override;
 
        LoggerPtr getLogger(const LogString& name) override;
 
        LoggerPtr getLogger(const LogString& name,
            const spi::LoggerFactoryPtr& factory) override;
 
        LoggerList getCurrentLoggers() const override;
 
        LoggerPtr getRootLogger() const override;
 
        bool isDisabled(int level) const override;
 
        void resetConfiguration() override;
 
        void shutdown() override;
 
 
        virtual bool isConfigured() override;
        virtual void setConfigured(bool configured) override;
 
        void updateChildren(const Logger* parent);
 
#if LOG4CXX_ABI_VERSION <= 15
        [[ deprecated( "Storing appenders is longer supported" ) ]]
        void clearAppenders();
 
        [[ deprecated( "Storing appenders is longer supported" ) ]]
        void addAppender(AppenderPtr appender);
#endif
#if LOG4CXX_ABI_VERSION <= 15
        bool removeLogger(const LogString& name, bool ifNotUsed = true);
#else
        bool removeLogger(const LogString& name, bool ifNotUsed = true) override;
#endif
 
    private:
 
        void setThresholdInternal(const LevelPtr& l);
 
        void shutdownInternal();
 
        void updateParents(const LoggerPtr& logger, const LoggerPtr& root);
 
        void updateChildren(ProvisionNode& pn, const LoggerPtr& logger);
 
        Hierarchy(const Hierarchy&);
        Hierarchy& operator=(const Hierarchy&);
 
};
 
}  //namespace log4cxx
 
#endif //_LOG4CXX_HIERARCHY_H