Files
spring-net/lib/Net/2.0/Common.Logging.Log4Net1211.xml
2014-11-08 12:15:10 +02:00

245 lines
13 KiB
XML

<?xml version="1.0"?>
<doc>
<assembly>
<name>Common.Logging.Log4Net1211</name>
</assembly>
<members>
<member name="T:Common.Logging.Log4Net.CommonLoggingAppender">
<summary>
Routes log events to Common.Logging infrastructure.
</summary>
<example>
To route all events logged using log4net to Common.Logging, you need to configure this appender as shown below:
<code>
&lt;log4net&gt;
&lt;appender name=&quot;CommonLoggingAppender&quot;
type=&quot;Common.Logging.Log4Net.CommonLoggingAppender, Common.Logging.Log4Net129&quot;&gt;
&lt;layout type=&quot;log4net.Layout.PatternLayout, log4net&quot;&gt;
&lt;param name=&quot;ConversionPattern&quot; value=&quot;%level - %class.%method: %message&quot; /&gt;
&lt;/layout&gt;
&lt;/appender&gt;
&lt;root&gt;
&lt;level value=&quot;ALL&quot; /&gt;
&lt;appender-ref ref=&quot;CommonLoggingAppender&quot; /&gt;
&lt;/root&gt;
&lt;/log4net&gt;
</code>
</example>
<author>Erich Eichinger</author>
</member>
<member name="M:Common.Logging.Log4Net.CommonLoggingAppender.GetClosestLevel(log4net.Core.Level)">
<summary>
Gets the closest level supported by Common.Logging of the given log4net level
</summary>
</member>
<member name="M:Common.Logging.Log4Net.CommonLoggingAppender.Append(log4net.Core.LoggingEvent)">
<summary>
Sends the given log event to Common.Logging
</summary>
</member>
<member name="P:Common.Logging.Log4Net.CommonLoggingAppender.Layout">
<summary>
Get or set the layout for this appender
</summary>
</member>
<member name="T:Common.Logging.Log4Net.CommonLoggingAppender.ExceptionAwareLayout">
<summary>
Wrapper class that prevents exceptions from being rendered in the message
</summary>
</member>
<member name="T:Common.Logging.Log4Net.Log4NetLogger">
<summary>
Concrete implementation of <see cref="T:Common.Logging.ILog"/> interface specific to log4net 1.2.9-1.2.11.
</summary>
<remarks>
Log4net is capable of outputting extended debug information about where the current
message was generated: class name, method name, file, line, etc. Log4net assumes that the location
information should be gathered relative to where Debug() was called.
When using Common.Logging, Debug() is called in Common.Logging.Log4Net.Log4NetLogger. This means that
the location information will indicate that Common.Logging.Log4Net.Log4NetLogger always made
the call to Debug(). We need to know where Common.Logging.ILog.Debug()
was called. To do this we need to use the log4net.ILog.Logger.Log method and pass in a Type telling
log4net where in the stack to begin looking for location information.
</remarks>
<author>Gilles Bayon</author>
<author>Erich Eichinger</author>
</member>
<member name="M:Common.Logging.Log4Net.Log4NetLogger.#ctor(log4net.Core.ILoggerWrapper)">
<summary>
Constructor
</summary>
<param name="log"></param>
</member>
<member name="M:Common.Logging.Log4Net.Log4NetLogger.WriteInternal(Common.Logging.LogLevel,System.Object,System.Exception)">
<summary>
Actually sends the message to the underlying log system.
</summary>
<param name="logLevel">the level of this log event.</param>
<param name="message">the message to log</param>
<param name="exception">the exception to log (may be null)</param>
</member>
<member name="M:Common.Logging.Log4Net.Log4NetLogger.GetLevel(Common.Logging.LogLevel)">
<summary>
Maps <see cref="T:Common.Logging.LogLevel"/> to log4net's <see cref="T:log4net.Core.Level"/>
</summary>
<param name="logLevel"></param>
</member>
<member name="P:Common.Logging.Log4Net.Log4NetLogger.IsTraceEnabled">
<summary>
</summary>
</member>
<member name="P:Common.Logging.Log4Net.Log4NetLogger.IsDebugEnabled">
<summary>
</summary>
</member>
<member name="P:Common.Logging.Log4Net.Log4NetLogger.IsInfoEnabled">
<summary>
</summary>
</member>
<member name="P:Common.Logging.Log4Net.Log4NetLogger.IsWarnEnabled">
<summary>
</summary>
</member>
<member name="P:Common.Logging.Log4Net.Log4NetLogger.IsErrorEnabled">
<summary>
</summary>
</member>
<member name="P:Common.Logging.Log4Net.Log4NetLogger.IsFatalEnabled">
<summary>
</summary>
</member>
<member name="T:Common.Logging.Log4Net.Log4NetLoggerFactoryAdapter">
<summary>
Concrete subclass of ILoggerFactoryAdapter specific to log4net 1.2.9-1.2.11.
</summary>
<remarks>
The following configuration property values may be configured:
<list type="bullet">
<item><c>configType</c>: <c>INLINE|FILE|FILE-WATCH|EXTERNAL</c></item>
<item><c>configFile</c>: log4net configuration file path in case of FILE or FILE-WATCH</item>
</list>
The configType values have the following implications:
<list type="bullet">
<item>INLINE: simply calls <c>XmlConfigurator.Configure()</c></item>
<item>FILE: calls <c>XmlConfigurator.Configure(System.IO.FileInfo)</c> using <c>configFile</c>.</item>
<item>FILE-WATCH: calls <c>XmlConfigurator.ConfigureAndWatch(System.IO.FileInfo)</c> using <c>configFile</c>.</item>
<item>EXTERNAL: does nothing and expects log4net to be configured elsewhere.</item>
<item>&lt;any&gt;: calls <c>BasicConfigurator.Configure()</c></item>
</list>
</remarks>
<example>
The following snippet shows an example of how to configure log4net with Common.Logging:
<code>
&lt;configuration&gt;
&lt;configSections&gt;
&lt;sectionGroup name=&quot;common&quot;&gt;
&lt;section name=&quot;logging&quot;
type=&quot;Common.Logging.ConfigurationSectionHandler, Common.Logging&quot;
requirePermission=&quot;false&quot; /&gt;
&lt;/sectionGroup&gt;
&lt;section name=&quot;log4net&quot;
type=&quot;log4net.Config.Log4NetConfigurationSectionHandler&quot;
requirePermission=&quot;false&quot; /&gt;
&lt;/configSections&gt;
&lt;common&gt;
&lt;logging&gt;
&lt;factoryAdapter type=&quot;Common.Logging.Log4Net.Log4NetLoggerFactoryAdapter, Common.Logging.Log4Net129&quot;&gt;
&lt;arg key=&quot;level&quot; value=&quot;ALL&quot; /&gt;
&lt;arg key=&quot;configType&quot; value=&quot;INLINE&quot; /&gt;
&lt;/factoryAdapter&gt;
&lt;/logging&gt;
&lt;/common&gt;
&lt;log4net debug=&quot;false&quot;&gt;
&lt;appender name=&quot;RollingLogFileAppender&quot; type=&quot;log4net.Appender.RollingFileAppender, log4net&quot;&gt;
&lt;param name=&quot;File&quot; value=&quot;./Web.log&quot; /&gt;
&lt;param name=&quot;AppendToFile&quot; value=&quot;true&quot; /&gt;
&lt;param name=&quot;MaxSizeRollBackups&quot; value=&quot;1&quot; /&gt;
&lt;param name=&quot;MaximumFileSize&quot; value=&quot;1GB&quot; /&gt;
&lt;param name=&quot;RollingStyle&quot; value=&quot;Date&quot; /&gt;
&lt;param name=&quot;StaticLogFileName&quot; value=&quot;false&quot; /&gt;
&lt;layout type=&quot;log4net.Layout.PatternLayout, log4net&quot;&gt;
&lt;param name=&quot;ConversionPattern&quot; value=&quot;%d [%t] %-5p %c - %m%n&quot; /&gt;
&lt;/layout&gt;
&lt;/appender&gt;
&lt;appender name=&quot;TraceAppender&quot; type=&quot;log4net.Appender.TraceAppender&quot;&gt;
&lt;layout type=&quot;log4net.Layout.PatternLayout&quot;&gt;
&lt;param name=&quot;ConversionPattern&quot; value=&quot;%-5p: %m&quot; /&gt;
&lt;/layout&gt;
&lt;/appender&gt;
&lt;root&gt;
&lt;level value=&quot;ALL&quot; /&gt;
&lt;appender-ref ref=&quot;TraceAppender&quot; /&gt;
&lt;appender-ref ref=&quot;RollingLogFileAppender&quot; /&gt;
&lt;/root&gt;
&lt;/log4net&gt;
&lt;/configuration&gt;
</code>
</example>
<author>Gilles Bayon</author>
<author>Erich Eichinger</author>
</member>
<member name="M:Common.Logging.Log4Net.Log4NetLoggerFactoryAdapter.#ctor(Common.Logging.Configuration.NameValueCollection)">
<summary>
Constructor
</summary>
<param name="properties">configuration properties, see <see cref="T:Common.Logging.Log4Net.Log4NetLoggerFactoryAdapter"/> for more.</param>
</member>
<member name="M:Common.Logging.Log4Net.Log4NetLoggerFactoryAdapter.#ctor(System.Collections.Specialized.NameValueCollection)">
<summary>
Constructor for binary backwards compatibility with non-portableversions
</summary>
<param name="properties">The properties.</param>
</member>
<member name="M:Common.Logging.Log4Net.Log4NetLoggerFactoryAdapter.#ctor(Common.Logging.Configuration.NameValueCollection,Common.Logging.Log4Net.Log4NetLoggerFactoryAdapter.ILog4NetRuntime)">
<summary>
Constructor accepting configuration properties and an arbitrary
<see cref="T:Common.Logging.Log4Net.Log4NetLoggerFactoryAdapter.ILog4NetRuntime"/> instance.
</summary>
<param name="properties">configuration properties, see <see cref="T:Common.Logging.Log4Net.Log4NetLoggerFactoryAdapter"/> for more.</param>
<param name="runtime">a log4net runtime adapter</param>
</member>
<member name="M:Common.Logging.Log4Net.Log4NetLoggerFactoryAdapter.CreateLogger(System.String)">
<summary>
Create a ILog instance by name
</summary>
<param name="name"></param>
<returns></returns>
</member>
<member name="T:Common.Logging.Log4Net.Log4NetLoggerFactoryAdapter.ILog4NetRuntime">
<summary>
Abstract interface to the underlying log4net runtime
</summary>
</member>
<member name="M:Common.Logging.Log4Net.Log4NetLoggerFactoryAdapter.ILog4NetRuntime.XmlConfiguratorConfigure">
<summary>Calls <see cref="M:log4net.Config.XmlConfigurator.Configure"/></summary>
</member>
<member name="M:Common.Logging.Log4Net.Log4NetLoggerFactoryAdapter.ILog4NetRuntime.XmlConfiguratorConfigure(System.String)">
<summary>Calls <see cref="M:log4net.Config.XmlConfigurator.Configure(System.IO.FileInfo)"/></summary>
</member>
<member name="M:Common.Logging.Log4Net.Log4NetLoggerFactoryAdapter.ILog4NetRuntime.XmlConfiguratorConfigureAndWatch(System.String)">
<summary>Calls <see cref="M:log4net.Config.XmlConfigurator.ConfigureAndWatch(System.IO.FileInfo)"/></summary>
</member>
<member name="M:Common.Logging.Log4Net.Log4NetLoggerFactoryAdapter.ILog4NetRuntime.BasicConfiguratorConfigure">
<summary>Calls <see cref="M:log4net.Config.BasicConfigurator.Configure"/></summary>
</member>
<member name="M:Common.Logging.Log4Net.Log4NetLoggerFactoryAdapter.ILog4NetRuntime.GetLogger(System.String)">
<summary>Calls <see cref="M:Common.Logging.LogManager.GetLogger(System.String)"/></summary>
</member>
</members>
</doc>