com.protomatter.syslog.xml
Class BasicLogger_Helper

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

All Implemented Interfaces:

XMLConfigHelper

Direct Known Subclasses:

DatabaseLog_Helper, FileLog_Helper, JMSLog_Helper, LengthRolloverLog_Helper, MailLog_Helper, OpenFileLog_Helper, PrintWriterLog_Helper, RemoteLog_Helper, SimpleSyslogMailSubjectFormatter_Helper, TimeRolloverLog_Helper, UNIXSyslogLog_Helper

public abstract class BasicLogger_Helper

extends java.lang.Object

implements XMLConfigHelper

XML configuration helper for BasicLogger.

Constructor Summary

BasicLogger_Helper()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicLogger_Helper

public BasicLogger_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
    name="LoggerName"
    class="LoggerClassName"
  >

    <!-- Logger subclass directives -->

    <Policy class="LogPolicyClass" >
      <!-- Policy directives -->
    </Policy>

    <Format class="LogFormatClass" >
      <!-- Formatter directives -->
    </Format>

  </Logger>
  

Attributes:

name	value	required
name	Symbolic name for the logger.	no
class	Full class name of the logger to load. Must be a class that implements the com.protomatter.syslog.Syslogger interface.	yes

If the logger is a subclass of this class (BasicLogger), then the optional <Policy> and <Format> elements are processed. If each is present, it is passed to the configure() method of the LogPolicy or SyslogTextFormatter object specified so they can configure themselves. It is assumed that each of those elements contains other configuration information that the individual policy or format class would understand.

Specified by:

configure in interface XMLConfigHelper

See Also:

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

configure

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

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

getConfiguration

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