SyslogHandler (JBoss Log Manager 1.5.5.Final API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

JBoss Log Manager 1.5.5.Final

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jboss.logmanager.handlers
Class SyslogHandler

java.lang.Object
  java.util.logging.Handler
      org.jboss.logmanager.ExtHandler
          org.jboss.logmanager.handlers.SyslogHandler

All Implemented Interfaces:: Closeable, Flushable, FlushableCloseable, Protectable

public class SyslogHandler
extends ExtHandler
extends ExtHandler

A syslog handler for logging to syslogd.

This handler can write to syslog servers that accept the RFC3164 and RFC5424 formats. Writes can be done via TCP, SSL over TCP or UDP protocols. You can also override the output stream if a custom protocol is needed.

 
  
      
          Configuration Properties:
      
  
  
      
          Property
          Description
          Type
          Default
      
      
          serverHostname
          The address of the syslog server
          String
          localhost
      
      
          port
          The port of the syslog server
          int
          514
      
      
          facility
          The facility used to calculate the priority of the log message
          Facility
          USER_LEVEL
      
      
          appName
          The name of the application that is logging
          String
          java
      
      
          hostname
          The name of the host the messages are being sent from. See setHostname(String) for more
 details
          String
          null
      
      
          syslogType
          The type of the syslog used to format the message
          SyslogType
          RFC5424
      
      
          protocol
          The protocol to send the message over
          Protocol
          UDP
      
      
          delimiter
          The delimiter to use at the end of the message if useDelimiter
 is set to true
          String
          For UDP null - For TCP or SSL_TCP \n
      
      
          useDelimiter
          Whether or not the message should be appended with a delimiter
          boolean
          For UDP false - For TCP or SSL_TCP true
      
      
          useCountingFraming
          Prefixes the size of the message, mainly used for TCP or SSL_TCP, connections to the message being sent to the syslog server. See http://tools.ietf.org/html/rfc6587
 for more details on framing types.
          boolean
          false
      
      
          truncate
          Whether or not a message, including the header, should truncate the message if the length in bytes is
 greater than the maximum length. If set to false messages will be split and sent
 with the same header values.
          boolean
          true
      
      
          maxLength
          The maximum length a log message, including the header, is allowed to be.
          int
          For RFC3164 1024 (1k) - For RFC5424 2048
 (2k)

Configuration Properties:
Property	Description	Type	Default
serverHostname	The address of the syslog server	`String`	localhost
port	The port of the syslog server	int	514
facility	The facility used to calculate the priority of the log message	`Facility`	`USER_LEVEL`
appName	The name of the application that is logging	`String`	java
hostname	The name of the host the messages are being sent from. See `setHostname(String)` for more details	`String`	`null`
syslogType	The type of the syslog used to format the message	`SyslogType`	`RFC5424`
protocol	The protocol to send the message over	`Protocol`	`UDP`
delimiter	The delimiter to use at the end of the message if `useDelimiter` is set to `true`	`String`	For `UDP` `null` - For `TCP` or `SSL_TCP` `\n`
useDelimiter	Whether or not the message should be appended with a `delimiter`	`boolean`	For `UDP` `false` - For `TCP` or `SSL_TCP` `true`
useCountingFraming	Prefixes the size of the message, mainly used for `TCP` or `SSL_TCP`, connections to the message being sent to the syslog server. See http://tools.ietf.org/html/rfc6587 for more details on framing types.	`boolean`	`false`
truncate	Whether or not a message, including the header, should truncate the message if the length in bytes is greater than the `maximum length`. If set to `false` messages will be split and sent with the same header values.	`boolean`	`true`
maxLength	The maximum length a log message, including the header, is allowed to be.	`int`	For `RFC3164` 1024 (1k) - For `RFC5424` 2048 (2k)

Author:: James R. Perkins

Nested Class Summary
`static class`	`SyslogHandler.Facility` Facility as defined by RFC-5424 (http://tools.ietf.org/html/rfc5424) and RFC-3164 (http://tools.ietf.org/html/rfc3164).
`static class`	`SyslogHandler.Protocol` The type of socket the syslog should write to
`static class`	`SyslogHandler.Severity` Severity as defined by RFC-5424 (http://tools.ietf.org/html/rfc5424) and RFC-3164 (http://tools.ietf.org/html/rfc3164).
`static class`	`SyslogHandler.SyslogType` The syslog type used for formatting the message.

Field Summary
`static InetAddress`	`DEFAULT_ADDRESS`
`static String`	`DEFAULT_ENCODING`
`static SyslogHandler.Facility`	`DEFAULT_FACILITY`
`static int`	`DEFAULT_PORT`
`static int`	`DEFAULT_SECURE_PORT`
`static String`	`NILVALUE_SP`

Fields inherited from class org.jboss.logmanager.ExtHandler
`handlers, handlersUpdater`

Constructor Summary
`SyslogHandler()` The default class constructor.
`SyslogHandler(InetAddress serverAddress, int port)` Creates a new syslog handler that sends the messages to the server represented by the `serverAddress` parameter on the port represented by the `port` parameter.
`SyslogHandler(InetAddress serverAddress, int port, SyslogHandler.Facility facility, String hostname)` Creates a new syslog handler that sends the messages to the server represented by the `serverAddress` parameter on the port represented by the `port` parameter.
`SyslogHandler(InetAddress serverAddress, int port, SyslogHandler.Facility facility, SyslogHandler.SyslogType syslogType, String hostname)` Creates a new syslog handler that sends the messages to the server represented by the `serverAddress` parameter on the port represented by the `port` parameter.
`SyslogHandler(InetAddress serverAddress, int port, SyslogHandler.Facility facility, SyslogHandler.SyslogType syslogType, SyslogHandler.Protocol protocol, String hostname)` Creates a new syslog handler that sends the messages to the server represented by the `serverAddress` parameter on the port represented by the `port` parameter.
`SyslogHandler(String serverHostname, int port)` Creates a new syslog handler that sends the messages to the server represented by the `serverHostname` parameter on the port represented by the `port` parameter.
`SyslogHandler(String serverHostname, int port, SyslogHandler.Facility facility, String hostname)` Creates a new syslog handler that sends the messages to the server represented by the `serverAddress` parameter on the port represented by the `port` parameter.
`SyslogHandler(String serverHostname, int port, SyslogHandler.Facility facility, SyslogHandler.SyslogType syslogType, String hostname)` Creates a new syslog handler that sends the messages to the server represented by the `serverAddress` parameter on the port represented by the `port` parameter.
`SyslogHandler(String serverHostname, int port, SyslogHandler.Facility facility, SyslogHandler.SyslogType syslogType, SyslogHandler.Protocol protocol, String hostname)` Creates a new syslog handler that sends the messages to the server represented by the `serverAddress` parameter on the port represented by the `port` parameter.

Method Summary
`protected int`	`calculatePriority(Level level, SyslogHandler.Facility facility)`
`void`	`close()` Close all child handlers.
`protected byte[]`	`createRFC3164Header(ExtLogRecord record)`
`protected byte[]`	`createRFC5424Header(ExtLogRecord record)`
`void`	`doPublish(ExtLogRecord record)` Do the actual work of publication; the record will have been filtered already.
`void`	`flush()` Flush all child handlers.
`String`	`getAppName()` Gets app name used when formatting the message in RFC5424 format.
`SyslogHandler.Facility`	`getFacility()` Returns the facility used for calculating the priority of the message.
`String`	`getHostname()` Returns the host name which is used when sending the message to the syslog.
`int`	`getMaxLength()` Returns the maximum length, in bytes, of the message allowed to be sent.
`String`	`getMessageDelimiter()` Returns the delimiter being used for the message if `use message delimiter` is set to `true`.
`String`	`getPid()` Returns the pid being used as the PROCID for RFC5424 messages.
`int`	`getPort()` Returns the port the syslogd is listening on.
`SyslogHandler.Protocol`	`getProtocol()` The protocol used to connect to the syslog server
`InetAddress`	`getServerAddress()` Returns the server address the messages are being sent to.
`SyslogHandler.SyslogType`	`getSyslogType()` Returns the `syslog type` this handler is using to format the message sent.
`boolean`	`isBlockOnReconnect()` Indicates whether or not a `TCP` or `SSL TCP` connection should block when attempting to reconnect.
`boolean`	`isEscapeEnabled()` Deprecated. escaping message values is not required per RFC5424 and is no longer supported in this handler
`boolean`	`isTruncate()` Checks if the message should truncated if the total length exceeds the `maximum length`.
`boolean`	`isUseCountingFraming()` Returns `true` if the message size should be prefixed to the message being sent.
`boolean`	`isUseMessageDelimiter()` Checks whether to append the message with a delimiter or not.
`void`	`setAppName(String appName)` Sets app name used when formatting the message in RFC5424 format.
`void`	`setBlockOnReconnect(boolean blockOnReconnect)` Enables or disables blocking when attempting to reconnect a `TCP` or `SSL TCP` protocol.
`void`	`setEscapeEnabled(boolean escapeEnabled)` Deprecated. escaping message values is not required per RFC5424 and is no longer supported in this handler
`void`	`setFacility(SyslogHandler.Facility facility)` Sets the facility used when calculating the priority of the message.
`void`	`setHostname(String hostname)` Sets the host name which is used when sending the message to the syslog.
`void`	`setMaxLength(int maxLen)` Sets the maximum length, in bytes, of the message allowed to tbe sent.
`void`	`setMessageDelimiter(String delimiter)` Sets the message delimiter to be used if `use message delimiter` is set to `true`.
`void`	`setOutputStream(OutputStream out)` Sets the output stream for the syslog handler to write to.
`void`	`setPort(int port)` Sets the port the syslogd server is listening on.
`void`	`setProtocol(SyslogHandler.Protocol type)` Sets the protocol used to connect to the syslog server
`void`	`setServerAddress(InetAddress serverAddress)` Sets the server address the messages should be sent to.
`void`	`setServerHostname(String hostname)` Sets the server address the messages should be sent to.
`void`	`setSyslogType(SyslogHandler.SyslogType syslogType)` Set the `syslog type` this handler should use to format the message sent.
`void`	`setTruncate(boolean truncate)` Set to `true` if the message should be truncated if the total length the `maximum length`.
`void`	`setUseCountingFraming(boolean useCountingFraming)` Set to `true` if the message being sent should be prefixed with the size of the message.
`void`	`setUseMessageDelimiter(boolean useDelimiter)` Whether to append the message with a delimiter or not.

Methods inherited from class org.jboss.logmanager.ExtHandler
`addHandler, checkAccess, checkAccess, clearHandlers, disableAccess, enableAccess, getHandlers, isAutoFlush, isEnabled, protect, publish, publish, removeHandler, setAutoFlush, setEnabled, setEncoding, setErrorManager, setFilter, setFormatter, setHandlers, setLevel, unprotect`

Methods inherited from class java.util.logging.Handler
`getEncoding, getErrorManager, getFilter, getFormatter, getLevel, isLoggable, reportError`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

DEFAULT_ADDRESS

public static final InetAddress DEFAULT_ADDRESS

DEFAULT_PORT

public static final int DEFAULT_PORT

See Also:: Constant Field Values

DEFAULT_SECURE_PORT

public static final int DEFAULT_SECURE_PORT

See Also:: Constant Field Values

DEFAULT_ENCODING

public static final String DEFAULT_ENCODING

See Also:: Constant Field Values

DEFAULT_FACILITY

public static final SyslogHandler.Facility DEFAULT_FACILITY

NILVALUE_SP

public static final String NILVALUE_SP

See Also:: Constant Field Values

Constructor Detail

SyslogHandler

public SyslogHandler()
              throws IOException

The default class constructor.

Throws:: IOException - if an error occurs creating the UDP socket

SyslogHandler

public SyslogHandler(String serverHostname,
                     int port)
              throws IOException

Creates a new syslog handler that sends the messages to the server represented by the serverHostname parameter on the port represented by the port parameter.

Parameters:: serverHostname - the server to send the messages to; port - the port the syslogd is listening on
Throws:: IOException - if an error occurs creating the UDP socket