Package org.apache.log4j.xml

Class LogFileXMLReceiver

  • All Implemented Interfaces:
    Plugin, Component, org.apache.log4j.spi.OptionHandler, Thresholdable
    public class LogFileXMLReceiver
extends Receiver
    LogFileXMLReceiver will read an xml-formated log file and make the events in the log file available to the log4j framework.

    This receiver supports log files created using log4j's XMLLayout, as well as java.util.logging XMLFormatter (via the org.apache.log4j.spi.Decoder interface).

    By default, log4j's XMLLayout is supported (no need to specify a decoder in that case).

    To configure this receiver to support java.util.logging's XMLFormatter, specify a 'decoder' param of org.apache.log4j.xml.UtilLoggingXMLDecoder.

    Tailing -may- work, but not in all cases (try using a file:// URL). If a process has a log file open, the receiver may be able to read and tail the file. If the process closes the file and reopens the file, the receiver may not be able to continue tailing the file.

    An expressionFilter may be specified. Only events passing the expression will be forwarded to the log4j framework.

    Once the event has been "posted", it will be handled by the appenders currently configured in the LoggerRespository.

    Since:
    1.3
    Author:
    Scott Deboy <sdeboy@apache.org>

    • Constructor Detail

      • LogFileXMLReceiver

        public LogFileXMLReceiver()

    • Method Detail

      • getFileURL

        public String getFileURL()
        Accessor
        Returns:
        file URL

      • setFileURL

        public void setFileURL​(String fileURL)
        Specify the URL of the XML-formatted file to process.
        Parameters:
        fileURL -

      • getDecoder

        public String getDecoder()
        Accessor
        Returns:

      • setDecoder

        public void setDecoder​(String _decoder)
        Specify the class name implementing org.apache.log4j.spi.Decoder that can process the file.
        Parameters:
        _decoder -

      • getFilterExpression

        public String getFilterExpression()
        Accessor
        Returns:
        filter expression

      • isTailing

        public boolean isTailing()
        Accessor
        Returns:
        tailing flag

      • setTailing

        public void setTailing​(boolean tailing)
        Set the 'tailing' flag - may only work on file:// URLs and may stop tailing if the writing process closes the file and reopens.
        Parameters:
        tailing -

      • setFilterExpression

        public void setFilterExpression​(String filterExpression)
        Set the filter expression that will cause only events which pass the filter to be forwarded to the log4j framework.
        Parameters:
        filterExpression -

      • main

        public static void main​(String[] args)

      • shutdown

        public void shutdown()
        Close the receiver, release any resources that are accessing the file.

      • activateOptions

        public void activateOptions()
        Process the file

      • isUseCurrentThread

        public final boolean isUseCurrentThread()
        When true, this property uses the current Thread to perform the import, otherwise when false (the default), a new Thread is created and started to manage the import.
        Returns:

      • setUseCurrentThread

        public final void setUseCurrentThread​(boolean useCurrentThread)
        Sets whether the current Thread or a new Thread is created to perform the import, the default being false (new Thread created).
        Parameters:
        useCurrentThread -