Module org.glassfish.main.jul

Package org.glassfish.main.jul.handler

Enum Class GlassFishLogHandlerProperty

java.lang.Object

java.lang.Enum<GlassFishLogHandlerProperty>

org.glassfish.main.jul.handler.GlassFishLogHandlerProperty

All Implemented Interfaces:

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

public enum GlassFishLogHandlerProperty
extends Enum<GlassFishLogHandlerProperty>
implements LogProperty

Configuration property set of this handler.

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
FLUSH_FREQUENCY	Count of records processed until handler flushes the output
FORMATTER	Class of the Formatter used with this handler
LEVEL	Minimal acceptable level of the incoming log record
OUTPUT_FILE	Absolute path to the output file
REDIRECT_STANDARD_STREAMS	Log STDOUT and STDERR to the log file too
ROTATION_COMPRESS	Compress rolled file to a zio file
ROTATION_LIMIT_SIZE	File containing more megabytes (1 000 000 B) will be rotated
ROTATION_LIMIT_TIME	File will be rotated after given count of minutes
ROTATION_MAX_HISTORY	Maximal count of archived files
ROTATION_ON_DATE_CHANGE	File will be rotated after mignight

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_BUFFER_CAPACITY
static final int	DEFAULT_BUFFER_TIMEOUT
static final int	DEFAULT_ROTATION_LIMIT_MB
static final int	MINIMUM_ROTATION_LIMIT_MB

Method Summary

Modifier and Type	Method	Description
String	getPropertyFullName()
String	getPropertyName()
static GlassFishLogHandlerProperty	valueOf(String name)	Returns the enum constant of this class with the specified name.
static GlassFishLogHandlerProperty[]	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 GlassFishLogHandlerProperty ENABLED

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

LEVEL

public static final GlassFishLogHandlerProperty LEVEL

Minimal acceptable level of the incoming log record

OUTPUT_FILE

public static final GlassFishLogHandlerProperty OUTPUT_FILE

Absolute path to the output file

ENCODING

public static final GlassFishLogHandlerProperty ENCODING

Charset

FORMATTER

public static final GlassFishLogHandlerProperty FORMATTER

Class of the Formatter used with this handler

BUFFER_CAPACITY

public static final GlassFishLogHandlerProperty 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 GlassFishLogHandlerProperty 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.

FLUSH_FREQUENCY

public static final GlassFishLogHandlerProperty FLUSH_FREQUENCY

Count of records processed until handler flushes the output

REDIRECT_STANDARD_STREAMS

public static final GlassFishLogHandlerProperty REDIRECT_STANDARD_STREAMS

Log STDOUT and STDERR to the log file too

ROTATION_COMPRESS

public static final GlassFishLogHandlerProperty ROTATION_COMPRESS

Compress rolled file to a zio file

ROTATION_ON_DATE_CHANGE

public static final GlassFishLogHandlerProperty ROTATION_ON_DATE_CHANGE

File will be rotated after mignight

ROTATION_LIMIT_SIZE

public static final GlassFishLogHandlerProperty ROTATION_LIMIT_SIZE

File containing more megabytes (1 000 000 B) will be rotated

ROTATION_LIMIT_TIME

public static final GlassFishLogHandlerProperty ROTATION_LIMIT_TIME

File will be rotated after given count of minutes

ROTATION_MAX_HISTORY

public static final GlassFishLogHandlerProperty ROTATION_MAX_HISTORY

Maximal count of archived files

Field Details

MINIMUM_ROTATION_LIMIT_MB

public static final int MINIMUM_ROTATION_LIMIT_MB

See Also:

• Constant Field Values

DEFAULT_ROTATION_LIMIT_MB

public static final int DEFAULT_ROTATION_LIMIT_MB

See Also:

• Constant Field Values

DEFAULT_BUFFER_CAPACITY

public static final int DEFAULT_BUFFER_CAPACITY

See Also:

• Constant Field Values

DEFAULT_BUFFER_TIMEOUT

public static final int DEFAULT_BUFFER_TIMEOUT

See Also:

• Constant Field Values

Method Details

values

public static GlassFishLogHandlerProperty[] 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 GlassFishLogHandlerProperty 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 GlassFishLogHandler class.