Overview  Package   Class  Use  Help 
Syslog: White Paper FAQ Examples JavaDoc
Protomatter Classes v1.1.6
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

com.protomatter.syslog.xml
Class MailLog_Helper

java.lang.Object
  |
  +--com.protomatter.syslog.xml.BasicLogger_Helper
        |
        +--com.protomatter.syslog.xml.MailLog_Helper
All Implemented Interfaces:
XMLConfigHelper
public class MailLog_Helper
extends BasicLogger_Helper

XML configuration helper for MailLog.

Constructor Summary
MailLog_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

MailLog_Helper

public MailLog_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.MailLog" >

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

    <SubjectFormat class="MessageSubjectFormatClass" >
      <!-- message subject formatter elements -->
    </Format>

    <workQueue>queueName</workQueue>
    <server>hostname</server>
    <port>port</port>
    <html>true|false</html>
    <to>to-address-list</to>
    <cc>cc-address-list</cc>
    <bcc>bcc-address-list</bcc>
    <from>from-address</from>
    <fromName>from-name</fromName>

  </Logger>

Element
name value required
workQueue The symbolic name of a work queue to use for sending messages. yes
server The SMTP server hostname or IP address. yes
port The port number on the SMTP server to connect to. no (default is 25)
html Should the message be sent as a MIME message? true or false. If this is set to true, it is expected that the message formatter will actually produce HTML. no (default is false)
to A comma-separated list of email addresses to send messages to. yes
cc A comma-separated list of email addresses to include in the CC (carbon-copy) list. no
bcc A comma-separated list of email addresses to include in the BCC (blind carbon-copy) list. no
from The email address that the mail should appear to be from. yes
fromName The name (not address) that the mail should appear to be from. no

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
Overview  Package   Class  Use  Help 
Protomatter Classes v1.1.6
Copyright 1998-2001 Nate Sammons
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD
Protomatter Classes v1.1.6 http://protomatter.sourceforge.net/1.1.6