com.protomatter.syslog.xml
Class TimeRolloverLog_Helper

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

All Implemented Interfaces:

XMLConfigHelper

public class TimeRolloverLog_Helper

extends BasicLogger_Helper

XML configuration helper for TimeRolloverLog.

Constructor Summary

TimeRolloverLog_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 com.protomatter.syslog.xml.BasicLogger_Helper

configure, getConfiguration

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeRolloverLog_Helper

public TimeRolloverLog_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.TimeRolloverLog" >

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

    <baseName>BaseFileName</baseName>
    <extension>FilenameExtension</extension>
    <nameFormat>FileDateFormat</nameFormat>
    <append>true|false</append>
    <autoFlush>true|false</autoFlush>
    <roll>RollConstant</roll>
    <weeklyRollDay>RollDayConstant</weeklyRollDay>

  </Logger>
  

Element

name	value	required
baseName	The base name of the file to write to.	yes
extension	The filename extension to use.	no
nameFormat	A date format that can be understood by the java.text.SimpleDateFormat formatting class.	no (default is "yyyy.MM.dd-HH.mm.ss")
roll	The roll interval. Must be ROLL_MINUTELY, ROLL_HOURLY, ROLL_DAILY, ROLL_WEEKLY or ROLL_MONTHLY	yes
weeklyRollDay	The day of week to roll if the roll setting is ROLL_WEEKLY. Must be MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY or SUNDAY.	no (default is "MONDAY"
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 always flush the stream every time it's written or not. Setting this to false (the default) will make things fast, and setting it to true will make the log always 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