com.nesscomputing.syslog4j.impl.log4j.Syslog4jAppender Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ness-syslog4j Show documentation

Syslog4j provides client and server implementations of the BSD Syslog protocol (RFC 3164) and the structured syslog" protocol (RFC5424).

There is a newer version: 0.9.47-NESS-8

Show newest version

/**
 *
 * (C) Copyright 2008-2011 syslog4j.org
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the GNU Lesser General Public License
 * (LGPL) version 2.1 which accompanies this distribution, and is available at
 * http://www.gnu.org/licenses/lgpl-2.1.html
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 */
package com.nesscomputing.syslog4j.impl.log4j;

import static com.nesscomputing.syslog4j.SyslogConstants.UDP;

import org.apache.log4j.helpers.LogLog;
/**
 * Syslog4jAppender provides a Log4j Appender wrapper for Syslog4j.
 *
 * Note: Syslog4jAppender does NOT extend Log4j's SyslogAppender.
 *
 * Example log4j.xml configuration:
 *
 *  * 
   <appender name="Syslog4j" class="com.nesscomputing.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>
 * 
 * 
 *
 * All available parameters are:
 *
 * 
 * 	ident
 * 	localName
 * 	protocol
 * 	facility
 * 	host
 * 	port
 * 	charSet
 * 	threaded
 * 	threadLoopInterval
 * 	splitMessageBeginText
 * 	splitMessageEndText
 * 	maxMessageLength
 * 	maxShutdownWait
 * 	writeRetries
 * 	truncateMessage
 * 	useStructuredData
 * 
 *
 * 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.
 *
 * @author <[email protected]>
 * @version $Id: Syslog4jAppender.java,v 1.2 2011/01/23 20:49:12 cvs Exp $
 */
public class Syslog4jAppender extends Syslog4jAppenderSkeleton {
    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;
    }
}