Module org.glassfish.main.jul

Package org.glassfish.main.jul.handler

Enum Class SyslogHandlerProperty

java.lang.Object

java.lang.Enum<SyslogHandlerProperty>

org.glassfish.main.jul.handler.SyslogHandlerProperty

All Implemented Interfaces:

Serializable, Comparable<SyslogHandlerProperty>, java.lang.constant.Constable, LogProperty

public enum SyslogHandlerProperty
extends Enum<SyslogHandlerProperty>
implements LogProperty

Configuration property set of this handler.

Author:

David Matejcek

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BUFFER_CAPACITY	LogRecord buffer size.
BUFFER_TIMEOUT	LogRecord buffer timeout for adding new records if the buffer is full.
ENABLED	False means that handler will stay in logging structure, but will ignore incoming records
ENCODING	Charset
FORMATTER	Class of the Formatter used with this handler
HOST	Syslog host name or ip address
LEVEL	Minimal acceptable level of the incoming log record
PORT	Syslog port; on current systems usually disabled by default.

Method Summary

Modifier and Type	Method	Description
String	getPropertyFullName()
String	getPropertyName()
static SyslogHandlerProperty	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SyslogHandlerProperty[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.glassfish.main.jul.cfg.LogProperty

getPropertyFullName, getPropertyFullName

Enum Constant Details

ENABLED

public static final SyslogHandlerProperty ENABLED

False means that handler will stay in logging structure, but will ignore incoming records

LEVEL

public static final SyslogHandlerProperty LEVEL

Minimal acceptable level of the incoming log record

HOST

public static final SyslogHandlerProperty HOST

Syslog host name or ip address

PORT

public static final SyslogHandlerProperty PORT

Syslog port; on current systems usually disabled by default.

ENCODING

public static final SyslogHandlerProperty ENCODING

Charset

FORMATTER

public static final SyslogHandlerProperty FORMATTER

Class of the Formatter used with this handler

BUFFER_CAPACITY

public static final SyslogHandlerProperty BUFFER_CAPACITY

LogRecord buffer size. If the buffer is full and it is not possible to add new record for BUFFER_TIMEOUT seconds, buffer will reset and replace all records with just one severe LogRecord explaining what happened.

BUFFER_TIMEOUT

public static final SyslogHandlerProperty BUFFER_TIMEOUT

LogRecord buffer timeout for adding new records if the buffer is full. If the buffer is full and it is not possible to add new record for this count of seconds, buffer will reset and replace all records with just one severe LogRecord explaining what happened.

0 means wait forever.

Method Details

values

public static SyslogHandlerProperty[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static SyslogHandlerProperty valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getPropertyName

public String getPropertyName()

Specified by:

getPropertyName in interface LogProperty

Returns:

a name of the property, used as a last part of property name in logging.properties

getPropertyFullName

public String getPropertyFullName()

Returns:

full name using the SyslogHandler class.