This is an automated email from the ASF dual-hosted git repository.
swebb2066 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/logging-log4cxx.git
The following commit(s) were added to refs/heads/master by this push:
new b9de415c Simplify the DOMConfigurator interface in the next ABI
version (#404)
b9de415c is described below
commit b9de415c392908e826c592ae40511f70f5fe9492
Author: Stephen Webb <[email protected]>
AuthorDate: Sun Aug 4 13:26:05 2024 +1000
Simplify the DOMConfigurator interface in the next ABI version (#404)
---
src/main/cpp/domconfigurator.cpp | 31 +++++++++--
src/main/cpp/propertyconfigurator.cpp | 17 ++++--
src/main/include/log4cxx/helpers/filewatchdog.h | 6 +--
src/main/include/log4cxx/propertyconfigurator.h | 52 ++++++++++--------
src/main/include/log4cxx/spi/configurator.h | 12 +++--
src/main/include/log4cxx/xml/domconfigurator.h | 71 +++++++++++++++++++------
6 files changed, 137 insertions(+), 52 deletions(-)
diff --git a/src/main/cpp/domconfigurator.cpp b/src/main/cpp/domconfigurator.cpp
index 954a8bb2..b734b6f6 100644
--- a/src/main/cpp/domconfigurator.cpp
+++ b/src/main/cpp/domconfigurator.cpp
@@ -811,10 +811,17 @@ void
DOMConfigurator::setParameter(LOG4CXX_NS::helpers::Pool& p,
propSetter.setProperty(name, value, p);
}
-spi::ConfigurationStatus DOMConfigurator::doConfigure(const File& filename,
spi::LoggerRepositoryPtr repository1)
+spi::ConfigurationStatus DOMConfigurator::doConfigure
+ ( const File& filename
+#if LOG4CXX_ABI_VERSION <= 15
+ , spi::LoggerRepositoryPtr repository
+#else
+ , const spi::LoggerRepositoryPtr& repository
+#endif
+ )
{
- repository1->setConfigured(true);
- m_priv->repository = repository1;
+ m_priv->repository = repository ? repository :
LogManager::getLoggerRepository();
+ m_priv->repository->setConfigured(true);
if (LogLog::isDebugEnabled())
{
LogString msg(LOG4CXX_STR("DOMConfigurator configuring file "));
@@ -893,6 +900,13 @@ spi::ConfigurationStatus
DOMConfigurator::doConfigure(const File& filename, spi:
return spi::ConfigurationStatus::Configured;
}
+// Read configuration options from \c filename.
+spi::ConfigurationStatus DOMConfigurator::configure(const File& filename)
+{
+ return DOMConfigurator().doConfigure(filename,
LogManager::getLoggerRepository());
+}
+
+#if LOG4CXX_ABI_VERSION <= 15
spi::ConfigurationStatus DOMConfigurator::configure(const std::string&
filename)
{
File file(filename);
@@ -952,7 +966,12 @@ spi::ConfigurationStatus
DOMConfigurator::configureAndWatch(const CFStringRef& f
spi::ConfigurationStatus DOMConfigurator::configureAndWatch(const std::string&
filename, long delay)
{
- File file(filename);
+ return configureAndWatch(File(filename), delay);
+}
+#endif // LOG4CXX_ABI_VERSION <= 15
+
+spi::ConfigurationStatus DOMConfigurator::configureAndWatch(const File& file,
long delay)
+{
if ( xdog )
{
APRInitializer::unregisterCleanup(xdog);
@@ -963,12 +982,13 @@ spi::ConfigurationStatus
DOMConfigurator::configureAndWatch(const std::string& f
xdog = new XMLWatchdog(file);
APRInitializer::registerCleanup(xdog);
- xdog->setDelay(delay);
+ xdog->setDelay(0 < delay ? delay : FileWatchdog::DEFAULT_DELAY);
xdog->start();
return status;
}
+#if LOG4CXX_ABI_VERSION <= 15
#if LOG4CXX_WCHAR_T_API
spi::ConfigurationStatus DOMConfigurator::configureAndWatch(const
std::wstring& filename, long delay)
{
@@ -1031,6 +1051,7 @@ spi::ConfigurationStatus
DOMConfigurator::configureAndWatch(const CFStringRef& f
return status;
}
#endif
+#endif // LOG4CXX_ABI_VERSION <= 15
void DOMConfigurator::parse(
Pool& p,
diff --git a/src/main/cpp/propertyconfigurator.cpp
b/src/main/cpp/propertyconfigurator.cpp
index c174ad16..922edac5 100644
--- a/src/main/cpp/propertyconfigurator.cpp
+++ b/src/main/cpp/propertyconfigurator.cpp
@@ -89,9 +89,16 @@ PropertyConfigurator::~PropertyConfigurator()
delete registry;
}
-spi::ConfigurationStatus PropertyConfigurator::doConfigure(const File&
configFileName,
- spi::LoggerRepositoryPtr hierarchy)
+spi::ConfigurationStatus PropertyConfigurator::doConfigure
+ ( const File& configFileName
+#if LOG4CXX_ABI_VERSION <= 15
+ , spi::LoggerRepositoryPtr repository
+#else
+ , const spi::LoggerRepositoryPtr& repository
+#endif
+ )
{
+ auto hierarchy = repository ? repository :
LogManager::getLoggerRepository();
hierarchy->setConfigured(true);
Properties props;
@@ -138,12 +145,12 @@ spi::ConfigurationStatus
PropertyConfigurator::configure(helpers::Properties& pr
return PropertyConfigurator().doConfigure(properties,
LogManager::getLoggerRepository());
}
+#if LOG4CXX_ABI_VERSION <= 15
spi::ConfigurationStatus PropertyConfigurator::configureAndWatch(const File&
configFilename)
{
return configureAndWatch(configFilename, FileWatchdog::DEFAULT_DELAY);
}
-
-
+#endif
spi::ConfigurationStatus PropertyConfigurator::configureAndWatch(
const File& configFilename, long delay)
@@ -158,7 +165,7 @@ spi::ConfigurationStatus
PropertyConfigurator::configureAndWatch(
pdog = new PropertyWatchdog(configFilename);
APRInitializer::registerCleanup(pdog);
- pdog->setDelay(delay);
+ pdog->setDelay(0 < delay ? delay : FileWatchdog::DEFAULT_DELAY);
pdog->start();
return stat;
diff --git a/src/main/include/log4cxx/helpers/filewatchdog.h
b/src/main/include/log4cxx/helpers/filewatchdog.h
index 3e5d5ae3..cbfc7b69 100644
--- a/src/main/include/log4cxx/helpers/filewatchdog.h
+++ b/src/main/include/log4cxx/helpers/filewatchdog.h
@@ -42,7 +42,7 @@ class LOG4CXX_EXPORT FileWatchdog
/**
The default delay between every file modification check, set to
60
seconds. */
- static long DEFAULT_DELAY /*= 60000*/;
+ static long DEFAULT_DELAY /*= 60000 ms*/;
protected:
FileWatchdog(const File& filename);
@@ -52,9 +52,9 @@ class LOG4CXX_EXPORT FileWatchdog
public:
/**
- Set the delay to observe between each check of the file changes.
+ Use \c delay as the number of milliseconds to wait between each
check for file changes.
*/
- void setDelay(long delay1);
+ void setDelay(long delay);
/**
Create a thread that periodically checks for a file change
after first calling doOnChange() on the current thread.
diff --git a/src/main/include/log4cxx/propertyconfigurator.h
b/src/main/include/log4cxx/propertyconfigurator.h
index 5b9bf219..6f85d2b8 100644
--- a/src/main/include/log4cxx/propertyconfigurator.h
+++ b/src/main/include/log4cxx/propertyconfigurator.h
@@ -275,24 +275,33 @@ class LOG4CXX_EXPORT PropertyConfigurator :
PropertyConfigurator();
virtual ~PropertyConfigurator();
/**
- Read configuration from a file. <b>The existing configuration is
- not cleared nor reset.</b> If you require a different behavior,
- then call {@link LogManager#resetConfiguration
- resetConfiguration} method before calling
- <code>doConfigure</code>.
-
- @param configFileName The name of the configuration file where
the
- configuration information is stored.
- @param hierarchy The hierarchy to operation upon.
+ Read configuration from \c configFileName.
+ If \c repository is not provided,
+ the spi::LoggerRepository held by LogManager is used.
+ <b>The existing configuration is not cleared nor reset.</b>
+ If you require a different behavior,
+ call {@link spi::LoggerRepository::resetConfiguration
resetConfiguration}
+ before calling <code>doConfigure</code>.
+
+ @param configFileName The file to parse.
+ @param repository Where the Logger instances reside.
*/
- spi::ConfigurationStatus doConfigure(const File& configFileName,
- spi::LoggerRepositoryPtr hierarchy) override;
+ spi::ConfigurationStatus doConfigure
+ ( const File& configFileName
+#if LOG4CXX_ABI_VERSION <= 15
+ , spi::LoggerRepositoryPtr repository
+#else
+ , const spi::LoggerRepositoryPtr& repository =
spi::LoggerRepositoryPtr()
+#endif
+ ) override;
/**
Read configuration options from file
<code>configFilename</code>.
+ Stores Logger instances in the spi::LoggerRepository held by
LogManager.
*/
static spi::ConfigurationStatus configure(const File&
configFilename);
+#if LOG4CXX_ABI_VERSION <= 15
/**
Like {@link #configureAndWatch(const File& configFilename, long
delay)}
except that the
@@ -301,27 +310,28 @@ class LOG4CXX_EXPORT PropertyConfigurator :
@param configFilename A file in key=value format.
*/
static spi::ConfigurationStatus configureAndWatch(const File&
configFilename);
-
+#endif
/**
- Read the configuration file <code>configFilename</code> if it
- exists. Moreover, a thread will be created that will
periodically
- check if <code>configFilename</code> has been created or
- modified. The period is determined by the <code>delay</code>
- argument. If a change or file creation is detected, then
- <code>configFilename</code> is read to configure Log4cxx.
+ Read configuration options from \c configFilename (if it
exists).
+ Stores Logger instances in the spi::LoggerRepository held by
LogManager.
+ A thread will be created that periodically checks
+ whether \c configFilename has been created or modified.
+ A period of log4cxx::helpers::FileWatchdog#DEFAULT_DELAY
+ is used if \c delay is not a positive number.
+ If a change or file creation is detected,
+ then \c configFilename is read to configure Log4cxx.
The thread will be stopped by a LogManager::shutdown call.
- Failure to call LogManager::shutdown may result in a fault
- when the process exits.
@param configFilename A file in key=value format.
@param delay The delay in milliseconds to wait between each
check.
*/
static spi::ConfigurationStatus configureAndWatch(const File&
configFilename,
- long delay);
+ long delay = 0);
/**
Read configuration options from <code>properties</code>.
+ Stores Logger instances in the spi::LoggerRepository held by
LogManager.
See the \ref PropertyConfigurator_details "detailed description"
for the expected format.
*/
diff --git a/src/main/include/log4cxx/spi/configurator.h
b/src/main/include/log4cxx/spi/configurator.h
index 30448b8d..d4dae180 100644
--- a/src/main/include/log4cxx/spi/configurator.h
+++ b/src/main/include/log4cxx/spi/configurator.h
@@ -52,10 +52,16 @@ class LOG4CXX_EXPORT Configurator : virtual public
helpers::Object
parameter.
@param configFileName The file to parse
- @param repository The hierarchy to operation upon.
+ @param repository Where the Logger instances reside.
*/
- virtual ConfigurationStatus doConfigure(const File&
configFileName,
- spi::LoggerRepositoryPtr repository) = 0;
+ virtual ConfigurationStatus doConfigure
+ ( const File& configFileName
+#if LOG4CXX_ABI_VERSION <= 15
+ , spi::LoggerRepositoryPtr repository
+#else
+ , const spi::LoggerRepositoryPtr& repository =
spi::LoggerRepositoryPtr()
+#endif
+ ) = 0;
protected:
Configurator();
diff --git a/src/main/include/log4cxx/xml/domconfigurator.h
b/src/main/include/log4cxx/xml/domconfigurator.h
index 856569ec..beea5953 100644
--- a/src/main/include/log4cxx/xml/domconfigurator.h
+++ b/src/main/include/log4cxx/xml/domconfigurator.h
@@ -216,11 +216,20 @@ class LOG4CXX_EXPORT DOMConfigurator :
DOMConfigurator(LOG4CXX_NS::helpers::Pool& p);
+#if LOG4CXX_ABI_VERSION <= 15
+ /**
+ A static version of #doConfigure.
+ */
+ static spi::ConfigurationStatus configure(const char* filename)
{ return configure(std::string(filename)); }
/**
A static version of #doConfigure.
*/
static spi::ConfigurationStatus configure(const std::string&
filename);
#if LOG4CXX_WCHAR_T_API
+ /**
+ A static version of #doConfigure.
+ */
+ static spi::ConfigurationStatus configure(const wchar_t*
filename) { return configure(std::wstring(filename)); }
/**
A static version of #doConfigure.
*/
@@ -239,7 +248,7 @@ class LOG4CXX_EXPORT DOMConfigurator :
static spi::ConfigurationStatus configure(const CFStringRef&
filename);
#endif
/**
- Like #configureAndWatch(const std::string& configFilename, long
delay)
+ Like #configureAndWatch(const File& filename, long delay)
except that the default delay as defined by
log4cxx::helpers::FileWatchdog#DEFAULT_DELAY is used.
@param configFilename A configuration file in XML format.
@@ -247,7 +256,7 @@ class LOG4CXX_EXPORT DOMConfigurator :
static spi::ConfigurationStatus configureAndWatch(const
std::string& configFilename);
#if LOG4CXX_WCHAR_T_API
/**
- Like #configureAndWatch(const std::string& configFilename, long
delay)
+ Like #configureAndWatch(const File& filename, long delay)
except that the default delay as defined by
log4cxx::helpers::FileWatchdog#DEFAULT_DELAY is used.
@param configFilename A configuration file in XML format.
@@ -256,7 +265,7 @@ class LOG4CXX_EXPORT DOMConfigurator :
#endif
#if LOG4CXX_UNICHAR_API || LOG4CXX_LOGCHAR_IS_UNICHAR
/**
- Like #configureAndWatch(const std::string& configFilename, long
delay)
+ Like #configureAndWatch(const File& filename, long delay)
except that the default delay as defined by
log4cxx::helpers::FileWatchdog#DEFAULT_DELAY is used.
@param configFilename A configuration file in XML format.
@@ -265,7 +274,7 @@ class LOG4CXX_EXPORT DOMConfigurator :
#endif
#if LOG4CXX_CFSTRING_API
/**
- Like #configureAndWatch(const std::string& configFilename, long
delay)
+ Like #configureAndWatch(const File& filename, long delay)
except that the default delay as defined by
log4cxx::helpers::FileWatchdog#DEFAULT_DELAY is used.
@param configFilename A configuration file in XML format.
@@ -281,8 +290,6 @@ class LOG4CXX_EXPORT DOMConfigurator :
<code>configFilename</code> is read to configure log4cxx.
The thread will be stopped by a LogManager::shutdown call.
- Failure to call LogManager::shutdown may result in a fault
- when the process exits.
@param configFilename A configuration file in XML format.
@param delay The delay in milliseconds to wait between each
check.
@@ -291,35 +298,69 @@ class LOG4CXX_EXPORT DOMConfigurator :
long delay);
#if LOG4CXX_WCHAR_T_API
/**
- Refer #configureAndWatch(const std::string& configFilename,
long delay)
+ Refer #configureAndWatch(const File& filename, long delay)
*/
static spi::ConfigurationStatus configureAndWatch(const
std::wstring& configFilename,
long delay);
#endif
#if LOG4CXX_UNICHAR_API || LOG4CXX_LOGCHAR_IS_UNICHAR
/**
- Refer #configureAndWatch(const std::string& configFilename,
long delay)
+ Refer #configureAndWatch(const File& filename, long delay)
*/
static spi::ConfigurationStatus configureAndWatch(const
std::basic_string<UniChar>& configFilename,
long delay);
#endif
#if LOG4CXX_CFSTRING_API
/**
- Refer #configureAndWatch(const std::string& configFilename,
long delay)
+ Refer #configureAndWatch(const File& filename, long delay)
*/
static spi::ConfigurationStatus configureAndWatch(const
CFStringRef& configFilename,
long delay);
#endif
+#endif // LOG4CXX_ABI_VERSION <= 15
/**
- Interpret the XML file pointed by <code>filename</code> and set
up
- log4cxx accordingly.
- <p>The configuration is done relative to the hierarchy
parameter.
+ Interpret \c filename as an XML file and set up Log4cxx
accordingly.
+ If \c repository is not provided,
+ the spi::LoggerRepository held by LogManager is used.
+ <b>The existing configuration is not cleared nor reset.</b>
+ If you require a different behavior,
+ call {@link spi::LoggerRepository::resetConfiguration
resetConfiguration}
+ before calling <code>doConfigure</code>.
+
@param filename The file to parse.
- @param repository The hierarchy to operation upon.
+ @param repository Where the Logger instances reside.
+ */
+ spi::ConfigurationStatus doConfigure
+ ( const File& filename
+#if LOG4CXX_ABI_VERSION <= 15
+ , spi::LoggerRepositoryPtr repository
+#else
+ , const spi::LoggerRepositoryPtr& repository =
spi::LoggerRepositoryPtr()
+#endif
+ ) override;
+
+ /**
+ Read configuration options from \c configFilename.
+ Stores Logger instances in the spi::LoggerRepository held by
LogManager.
+ */
+ static spi::ConfigurationStatus configure(const File&
configFilename);
+
+ /**
+ Read configuration options from \c configFilename (if it
exists).
+ A thread will be created that periodically checks
+ whether \c configFilename has been created or modified.
+ A period of log4cxx::helpers::FileWatchdog#DEFAULT_DELAY
+ is used if \c delay is not a positive number.
+ If a change or file creation is detected,
+ then \c configFilename is read to configure Log4cxx.
+
+ The thread will be stopped by a LogManager::shutdown call.
+
+ @param configFilename A XML format file.
+ @param delay The delay in milliseconds to wait between each
check.
*/
- spi::ConfigurationStatus doConfigure(const File& filename,
- spi::LoggerRepositoryPtr repository) override;
+ static spi::ConfigurationStatus configureAndWatch(const File&
configFilename, long delay = 0);
protected:
static LogString getAttribute(
