Syslog: White Paper FAQ Examples JavaDoc
Protomatter Classes v1.1.6

com.protomatter.syslog.xml
Class SimpleSyslogTextFormatter_Helper

java.lang.Object
  |
  +--com.protomatter.syslog.xml.SimpleSyslogTextFormatter_Helper
All Implemented Interfaces:
XMLConfigHelper
Direct Known Subclasses:
HTMLSyslogTextFormatter_Helper, JDK14SyslogTextFormatter_Helper, SyslogHTMLMailFormatter_Helper, Wl6SyslogTextFormatter_Helper, WlSyslogTextFormatter_Helper

public class SimpleSyslogTextFormatter_Helper
extends java.lang.Object
implements XMLConfigHelper

XML configuration helper for SimpleSyslogTextFormatter.


Constructor Summary
SimpleSyslogTextFormatter_Helper()
           
 
Method Summary
 void configure(java.lang.Object o, org.jdom.Element e)
          Configure this text formatter 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

SimpleSyslogTextFormatter_Helper

public SimpleSyslogTextFormatter_Helper()
Method Detail

configure

public void configure(java.lang.Object o,
                      org.jdom.Element e)
               throws SyslogInitException
Configure this text formatter given the XML element. The <Format> element should look like this:



  <Format class="com.protomatter.syslog.SimpleSyslogTextFormatter" >

    <showChannel>true|false</showChannel>
    <showThreadName>true|false</showThreadName>
    <showHostName>true|false</showHostName>
    <dateFormat>DateFormat</dateFormat>
    <dateFormatTimeZone>TimeZoneName</dateFormatTimeZone>
    <dateFormatCacheTime>CacheTimeout</dateFormatCacheTime>

    <classWidth>field-width</classWidth>
    <channelWidth>field-width</channelWidth>
    <threadWidth>field-width</threadWidth>
    <hostWidth>field-width</hostWidth>

  </Format>
  

Element
name value required
showChannel true or false -- decide if the channel name should appear in the log. no (default is false)
showThreadName true or false -- decide if the thread name should appear in the log. no (default is false)
showHostName true or false -- decide if the host name name should appear in the log. no (default is false)
dateFormat A date format that can be understood by the java.text.SimpleDateFormat format class. no (default is "HH:mm:ss MM/dd")
dateFormatTimeZone The name of the timezone to use for formatting timestamps. no (default is the current time zone)
dateFormatCacheTime How long (in milliseconds) to cache a created timestamp formatting object no (default is 1000)
classWidth Field width in characters for the class section. no (default is 20)
channelWidth Field width in characters for the channel section. no (default is 15)
hostWidth Field width in characters for the host name section. no (default is 15)
threadWidth Field width in characters for the thread name section. no (default is 15)

Specified by:
configure in interface XMLConfigHelper

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.
Specified by:
getConfiguration in interface XMLConfigHelper

Protomatter Classes v1.1.6
Copyright 1998-2001 Nate Sammons

Protomatter Classes v1.1.6 http://protomatter.sourceforge.net/1.1.6