Apache Log4cxx  Version 1.3.1
loggerrepository.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_SPI_LOG_REPOSITORY_H
19 #define _LOG4CXX_SPI_LOG_REPOSITORY_H
20 
21 #include <log4cxx/appender.h>
23 #include <log4cxx/level.h>
25 #include <functional>
26 
27 namespace LOG4CXX_NS
28 {
29 namespace spi
30 {
31 
42 class LOG4CXX_EXPORT LoggerRepository : public virtual helpers::Object
43 {
44  public:
46 #if 15 < LOG4CXX_ABI_VERSION
50 #endif
51  virtual ~LoggerRepository() {}
52 
57  virtual void addHierarchyEventListener(const HierarchyEventListenerPtr&
58  listener) = 0;
59 
60 #if 15 < LOG4CXX_ABI_VERSION
65  virtual void removeHierarchyEventListener(const spi::HierarchyEventListenerPtr& listener) = 0;
66 #endif
67 
71  virtual void ensureIsConfigured(std::function<void()> configurator) = 0;
72 
77  virtual bool isDisabled(int level) const = 0;
78 
83  virtual void setThreshold(const LevelPtr& level) = 0;
84 
89  virtual void setThreshold(const LogString& val) = 0;
90 
91  virtual void emitNoAppenderWarning(const Logger* logger) = 0;
92 
98  virtual LevelPtr getThreshold() const = 0;
99 
103  virtual LoggerPtr getLogger(const LogString& name) = 0;
104 
115  virtual LoggerPtr getLogger(const LogString& name,
116  const spi::LoggerFactoryPtr& factory) = 0;
117 
118 #if 15 < LOG4CXX_ABI_VERSION
130  virtual bool removeLogger(const LogString& name, bool ifNotUsed = true) = 0;
131 #endif
132 
133  virtual LoggerPtr getRootLogger() const = 0;
134 
135  virtual LoggerPtr exists(const LogString& name) = 0;
136 
137  virtual void shutdown() = 0;
138 
139  virtual LoggerList getCurrentLoggers() const = 0;
140 
141  virtual void fireAddAppenderEvent(const Logger* logger, const Appender* appender) {};
142 
143  virtual void fireRemoveAppenderEvent(const Logger* logger, const Appender* appender) {};
144 
145  virtual void resetConfiguration() = 0;
146 
147  virtual bool isConfigured() = 0;
148  virtual void setConfigured(bool configured) = 0;
149 }; // class LoggerRepository
150 
151 } // namespace spi
152 } // namespace log4cxx
153 
154 #endif //_LOG4CXX_SPI_LOG_REPOSITORY_H
Implement this interface for your own strategies for outputting log statements.
Definition: appender.h:51
This is the central class in the log4cxx package.
Definition: log4cxx/logger.h:51
base class for java-like objects.
Definition: object.h:106
A LoggerRepository is used to create and retrieve Loggers.
Definition: loggerrepository.h:43
virtual LoggerPtr getRootLogger() const =0
virtual LoggerPtr getLogger(const LogString &name)=0
Retrieve the name Logger instance.
virtual LoggerList getCurrentLoggers() const =0
virtual void ensureIsConfigured(std::function< void()> configurator)=0
Call configurator if not yet configured.
virtual void setThreshold(const LogString &val)=0
Another form of setThreshold accepting a string parameter instead of a Level.
virtual void fireAddAppenderEvent(const Logger *logger, const Appender *appender)
Definition: loggerrepository.h:141
virtual void emitNoAppenderWarning(const Logger *logger)=0
virtual ~LoggerRepository()
Definition: loggerrepository.h:51
virtual void setConfigured(bool configured)=0
virtual LoggerPtr exists(const LogString &name)=0
virtual void resetConfiguration()=0
virtual void fireRemoveAppenderEvent(const Logger *logger, const Appender *appender)
Definition: loggerrepository.h:143
virtual void addHierarchyEventListener(const HierarchyEventListenerPtr &listener)=0
Add a HierarchyEventListener event to the repository.
virtual void setThreshold(const LevelPtr &level)=0
Set the repository-wide threshold.
virtual bool isDisabled(int level) const =0
Is the repository disabled for a given level? The answer depends on the repository threshold and the ...
virtual LoggerPtr getLogger(const LogString &name, const spi::LoggerFactoryPtr &factory)=0
Retrieve the name Logger instance.
virtual LevelPtr getThreshold() const =0
Get the repository-wide threshold.
std::shared_ptr< LoggerFactory > LoggerFactoryPtr
Definition: logmanager.h:33
std::basic_string< logchar > LogString
Definition: logstring.h:60
std::shared_ptr< Level > LevelPtr
Definition: optionconverter.h:27
std::shared_ptr< Logger > LoggerPtr
Definition: defaultloggerfactory.h:26
std::vector< LoggerPtr > LoggerList
Definition: logmanager.h:29
#define LOG4CXX_CAST_ENTRY(Interface)
Definition: object.h:158
#define DECLARE_ABSTRACT_LOG4CXX_OBJECT(object)
Definition: object.h:39
#define END_LOG4CXX_CAST_MAP()
Definition: object.h:152
#define BEGIN_LOG4CXX_CAST_MAP()
Definition: object.h:146