com.protomatter.syslog.xml
Class SimpleSyslogMailSubjectFormatter_Helper

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

All Implemented Interfaces:

XMLConfigHelper

public class SimpleSyslogMailSubjectFormatter_Helper

extends BasicLogger_Helper

XML configuration helper for SimpleSyslogMailSubjectFormatter.

Constructor Summary

SimpleSyslogMailSubjectFormatter_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 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

SimpleSyslogMailSubjectFormatter_Helper

public SimpleSyslogMailSubjectFormatter_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 <SubjectFormat> element should look like this:

  <SubjectFormat class="com.protomatter.syslog.SimpleSyslogMailSubjectFormatter" >

    <showCaller>true|false</showCaller>
    <showChannel>true|false</showChannel>
    <showThreadName>true|false</showThreadName>
    <showHostName>true|false</showHostName>

  </SubjectFormat>
  

Element

name	value	required
showCaller	true or false -- decide if the caller name should appear in the log.	no (default is true)
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)

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