Package ch.qos.logback.core.net

Class SyslogAppenderBase<E>

java.lang.Object
ch.qos.logback.core.spi.ContextAwareBase
ch.qos.logback.core.AppenderBase<E>
ch.qos.logback.core.net.SyslogAppenderBase<E>
Type Parameters:
E -
All Implemented Interfaces:
Appender<E>, ContextAware, FilterAttachable<E>, LifeCycle
public abstract class SyslogAppenderBase<E> extends AppenderBase<E>
Base class for SyslogAppender.
Author:
Ceki Gülcü

  • Field Details

    • suffixPattern

      protected String suffixPattern

  • Constructor Details

    • SyslogAppenderBase

      public SyslogAppenderBase()

  • Method Details

    • start

      public void start()
      Specified by:
      start in interface LifeCycle
      Overrides:
      start in class AppenderBase<E>

    • createOutputStream

      public abstract SyslogOutputStream createOutputStream() throws UnknownHostException, SocketException
      Throws:
      UnknownHostException
      SocketException

    • buildLayout

      public abstract Layout<E> buildLayout()

    • getSeverityForEvent

      public abstract int getSeverityForEvent(Object eventObject)

    • append

      protected void append(E eventObject)
      Specified by:
      append in class AppenderBase<E>

    • postProcess

      protected void postProcess(Object event, OutputStream sw)

    • facilityStringToint

      public static int facilityStringToint(String facilityStr)
      Returns the integer value corresponding to the named syslog facility.
      Throws:
      IllegalArgumentException - if the facility string is not recognized

    • getSyslogHost

      public String getSyslogHost()
      Returns the value of the SyslogHost option.

    • setSyslogHost

      public void setSyslogHost(String syslogHost)
      The SyslogHost option is the name of the syslog host where log output should go. WARNING If the SyslogHost is not set, then this appender will fail.

    • getFacility

      public String getFacility()
      Returns the string value of the Facility option. See setFacility(java.lang.String) for the set of allowed values.

    • setFacility

      public void setFacility(String facilityStr)
      The Facility option must be set one of the strings KERN, USER, MAIL, DAEMON, AUTH, SYSLOG, LPR, NEWS, UUCP, CRON, AUTHPRIV, FTP, NTP, AUDIT, ALERT, CLOCK, LOCAL0, LOCAL1, LOCAL2, LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7. Case is not important.

      See SyslogConstants and RFC 3164 for more information about the Facility option.

    • getPort

      public int getPort()
      Returns:

    • setPort

      public void setPort(int port)
      The port number on the syslog server to connect to. Normally, you would not want to change the default value, that is 514.

    • getMaxMessageSize

      public int getMaxMessageSize()

    • setMaxMessageSize

      public void setMaxMessageSize(int maxMessageSize)
      Maximum size for the syslog message (in characters); messages longer than this are truncated. The default value is 65400 (which is near the maximum for syslog-over-UDP). Note that the value is characters; the number of bytes may vary if non-ASCII characters are present.

    • getLayout

      public Layout<E> getLayout()

    • setLayout

      public void setLayout(Layout<E> layout)

    • stop

      public void stop()
      Specified by:
      stop in interface LifeCycle
      Overrides:
      stop in class AppenderBase<E>

    • getSuffixPattern

      public String getSuffixPattern()
      See #setSuffixPattern(String).
      Returns:

    • setSuffixPattern

      public void setSuffixPattern(String suffixPattern)
      The suffixPattern option specifies the format of the non-standardized part of the message sent to the syslog server.
      Parameters:
      suffixPattern -

    • getCharset

      public Charset getCharset()
      Returns the Charset used to encode String messages into byte sequences when writing to syslog.

    • setCharset

      public void setCharset(Charset charset)
      The Charset to use when encoding messages into byte sequences.
      Parameters:
      charset -