Syslog4jAppender.java

package org.graylog2.syslog4j.impl.log4j;

import org.apache.log4j.helpers.LogLog;

/**
 * Syslog4jAppender provides a Log4j Appender wrapper for Syslog4j.
 * <p/>
 * <p>Note: Syslog4jAppender does NOT extend Log4j's SyslogAppender.</p>
 * <p/>
 * <p>Example log4j.xml configuration:</p>
 * <p/>
 * <pre>
 * <code>
 * <appender name="Syslog4j" class="org.graylog2.syslog4j.impl.log4j.Syslog4jAppender">
 * <param name="Facility" value="user"/>
 * <param name="Protocol" value="tcp"/>
 * <param name="Host" value="192.168.0.1"/>
 * <layout class="org.apache.log4j.PatternLayout">
 * <param name="ConversionPattern" value="%d{ABSOLUTE} %-5p [%c{1}] %m"/>
 * </layout>
 * </appender>
 * </code>
 * </pre>
 * <p/>
 * <p>All available parameters are:</p>
 * <p/>
 * <ul>
 * <li>ident</li>
 * <li>localName</li>
 * <li>protocol</li>
 * <li>facility</li>
 * <li>host</li>
 * <li>port</li>
 * <li>charSet</li>
 * <li>threaded</li>
 * <li>threadLoopInterval</li>
 * <li>splitMessageBeginText</li>
 * <li>splitMessageEndText</li>
 * <li>maxMessageLength</li>
 * <li>maxShutdownWait</li>
 * <li>writeRetries</li>
 * <li>truncateMessage</li>
 * <li>useStructuredData</li>
 * </ul>
 * <p/>
 * <p>Syslog4j is licensed under the Lesser GNU Public License v2.1.  A copy
 * of the LGPL license is available in the META-INF folder in all
 * distributions of Syslog4j and in the base directory of the "doc" ZIP.</p>
 *
 * @author <syslog4j@productivity.org>
 * @version $Id: Syslog4jAppender.java,v 1.2 2011/01/23 20:49:12 cvs Exp $
 */
public class Syslog4jAppender extends Syslog4jAppenderSkeleton {
    private static final long serialVersionUID = -6072552977605816670L;

    public String initialize() {
        if (this.protocol == null) {
            this.protocol = UDP;
        }

        return this.protocol;
    }

    public boolean getHeader() {
        return false;
    }

    public void setHeader(boolean header) {
        LogLog.warn("Syslog4jAppender ignores the \"Header\" parameter.");
    }

    public String getSyslogHost() {
        return this.host;
    }

    public void setSyslogHost(String host) {
        this.host = host;
    }
}