org.wildfly.swarm.config.logging

Class PeriodicRotatingFileHandler

java.lang.Object

org.wildfly.swarm.config.logging.PeriodicRotatingFileHandler

public class PeriodicRotatingFileHandler
extends Object

Defines a handler which writes to a file, rotating the log after a time period derived from the given suffix string, which should be in a format understood by java.text.SimpleDateFormat.

Constructor Summary

Constructors

Constructor and Description
PeriodicRotatingFileHandler(String key)

Method Summary

Modifier and Type	Method and Description
Boolean	append() Specify whether to append to the target file.
PeriodicRotatingFileHandler	append(Boolean value) Specify whether to append to the target file.
Boolean	autoflush() Automatically flush after each write.
PeriodicRotatingFileHandler	autoflush(Boolean value) Automatically flush after each write.
Boolean	enabled() If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.
PeriodicRotatingFileHandler	enabled(Boolean value) If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.
String	encoding() The character encoding used by this Handler.
PeriodicRotatingFileHandler	encoding(String value) The character encoding used by this Handler.
Map	file() The file description consisting of the path and optional relative to path.
PeriodicRotatingFileHandler	file(Map value) The file description consisting of the path and optional relative to path.
String	filterSpec() A filter expression value to define a filter.
PeriodicRotatingFileHandler	filterSpec(String value) A filter expression value to define a filter.
String	formatter() Defines a pattern for the formatter.
PeriodicRotatingFileHandler	formatter(String value) Defines a pattern for the formatter.
String	getKey()
String	level() The log level specifying which message levels will be logged by this logger.
PeriodicRotatingFileHandler	level(String value) The log level specifying which message levels will be logged by this logger.
String	namedFormatter() The name of the defined formatter to be used on the handler.
PeriodicRotatingFileHandler	namedFormatter(String value) The name of the defined formatter to be used on the handler.
String	suffix() Set the suffix string.
PeriodicRotatingFileHandler	suffix(String value) Set the suffix string.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PeriodicRotatingFileHandler

public PeriodicRotatingFileHandler(String key)

Method Detail

getKey

public String getKey()

append

public Boolean append()

Specify whether to append to the target file.

append

public PeriodicRotatingFileHandler append(Boolean value)

Specify whether to append to the target file.

autoflush

public Boolean autoflush()

Automatically flush after each write.

autoflush

public PeriodicRotatingFileHandler autoflush(Boolean value)

Automatically flush after each write.

enabled

public Boolean enabled()

If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.

enabled

public PeriodicRotatingFileHandler enabled(Boolean value)

If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.

encoding

public String encoding()

The character encoding used by this Handler.

encoding

public PeriodicRotatingFileHandler encoding(String value)

The character encoding used by this Handler.

file

public Map file()

The file description consisting of the path and optional relative to path.

file

public PeriodicRotatingFileHandler file(Map value)

The file description consisting of the path and optional relative to path.

filterSpec

public String filterSpec()

A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match("JBAS.*"))

filterSpec

public PeriodicRotatingFileHandler filterSpec(String value)

A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match("JBAS.*"))

formatter

public String formatter()

Defines a pattern for the formatter.

formatter

public PeriodicRotatingFileHandler formatter(String value)

Defines a pattern for the formatter.

level

public String level()

The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.

level

public PeriodicRotatingFileHandler level(String value)

The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.

namedFormatter

public String namedFormatter()

The name of the defined formatter to be used on the handler.

namedFormatter

public PeriodicRotatingFileHandler namedFormatter(String value)

The name of the defined formatter to be used on the handler.

suffix

public String suffix()

Set the suffix string. The string is in a format which can be understood by java.text.SimpleDateFormat. The period of the rotation is automatically calculated based on the suffix.

suffix

public PeriodicRotatingFileHandler suffix(String value)

Set the suffix string. The string is in a format which can be understood by java.text.SimpleDateFormat. The period of the rotation is automatically calculated based on the suffix.