com.protomatter.syslog.xml
Class LengthRolloverLog_Helper

java.lang.Object
  |
  +--com.protomatter.syslog.xml.BasicLogger_Helper
        |
        +--com.protomatter.syslog.xml.LengthRolloverLog_Helper

All Implemented Interfaces:

XMLConfigHelper

public class LengthRolloverLog_Helper

extends BasicLogger_Helper

XML configuration helper for LengthRolloverLog.

Constructor Summary

LengthRolloverLog_Helper()

Method Summary

void	configure(java.lang.Object o, org.jdom.Element e) Configure this logger given the XML element.
org.jdom.Element	getConfiguration(java.lang.Object o, org.jdom.Element element) Encode the given object's configuration into the given XML element.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LengthRolloverLog_Helper

public LengthRolloverLog_Helper()

Method Detail

configure

public void configure(java.lang.Object o,
                      org.jdom.Element e)
               throws SyslogInitException

Configure this logger given the XML element. The <Logger> element should look like this:

  <Logger class="com.protomatter.syslog.LengthRolloverLog" >

    <!--
     Config params from BasicLogger_Helper can
     get inserted here.
    -->

    <baseName>BaseFileName</baseName>
    <extension>FilenameExtension</extension>
    <rollsize>MaxFileSize</rollsize>
    <append>true|false</append>
    <autoFlush>true|false</autoFlush>

  </Logger>
  

Element

name	value	required
baseName	The base name of the file to write to.	yes
extension	The filename extension to use.	no
rollsize	The maximum number of bytes to write to any one file.	no (default is 1MB)
append	true or false -- decide if the file should be appended to (or overwritten).	no (default is true)
autoFlush	true or false -- decide if we should flush the output stream after each log write. If this is set to false (the default), log writing will be fast, but if it is set to true, the log will always be up-to-date.	no (default is false)

Overrides:

configure in class BasicLogger_Helper

Following copied from class: com.protomatter.syslog.xml.BasicLogger_Helper

See Also:

SimpleSyslogTextFormatter_Helper.configure(Object,Element), HTMLSyslogTextFormatter_Helper.configure(Object,Element), SimpleLogPolicy_Helper.configure(Object,Element), PerClassPolicy_Helper.configure(Object,Element)

getConfiguration

public org.jdom.Element getConfiguration(java.lang.Object o,
                                         org.jdom.Element element)

Description copied from interface: XMLConfigHelper

Encode the given object's configuration into the given XML element.

Overrides:

getConfiguration in class BasicLogger_Helper