org.wildfly.swarm.config.logging

Class PeriodicRotatingFileHandler<T extends PeriodicRotatingFileHandler<T>>

java.lang.Object

org.wildfly.swarm.config.logging.PeriodicRotatingFileHandler<T>

@Addresses(value={"/subsystem=logging/periodic-rotating-file-handler=*","/subsystem=logging/logging-profile=*/periodic-rotating-file-handler=*"})
public class PeriodicRotatingFileHandler<T extends PeriodicRotatingFileHandler<T>>
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
void	addPropertyChangeListener(PropertyChangeListener listener) Adds a property change listener
Boolean	append() Specify whether to append to the target file.
T	append(Boolean value) Specify whether to append to the target file.
Boolean	autoflush() Automatically flush after each write.
T	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.
T	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.
T	encoding(String value) The character encoding used by this Handler.
Map	file() The file description consisting of the path and optional relative to path.
T	file(Map value) The file description consisting of the path and optional relative to path.
T	file(String key, Object value) The file description consisting of the path and optional relative to path.
String	filterSpec() A filter expression value to define a filter.
T	filterSpec(String value) A filter expression value to define a filter.
String	formatter() Defines a pattern for the formatter.
T	formatter(String value) Defines a pattern for the formatter.
String	getKey()
Level	level() The log level specifying which message levels will be logged by this logger.
T	level(Level 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.
T	namedFormatter(String value) The name of the defined formatter to be used on the handler.
void	removePropertyChangeListener(PropertyChangeListener listener) Removes a property change listener
String	suffix() Set the suffix string.
T	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()

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

Adds a property change listener

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

Removes a property change listener

append

@ModelNodeBinding(detypedName="append")
public Boolean append()

Specify whether to append to the target file.

append

public T append(Boolean value)

Specify whether to append to the target file.

autoflush

@ModelNodeBinding(detypedName="autoflush")
public Boolean autoflush()

Automatically flush after each write.

autoflush

public T autoflush(Boolean value)

Automatically flush after each write.

enabled

@ModelNodeBinding(detypedName="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 T 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

@ModelNodeBinding(detypedName="encoding")
public String encoding()

The character encoding used by this Handler.

encoding

public T encoding(String value)

The character encoding used by this Handler.

file

@ModelNodeBinding(detypedName="file")
public Map file()

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

file

public T file(Map value)

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

file

public T file(String key,
              Object value)

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

filterSpec

@ModelNodeBinding(detypedName="filter-spec")
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 T 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

@ModelNodeBinding(detypedName="formatter")
public String formatter()

Defines a pattern for the formatter.

formatter

public T formatter(String value)

Defines a pattern for the formatter.

level

@ModelNodeBinding(detypedName="level")
public Level 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 T level(Level value)

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

namedFormatter

@ModelNodeBinding(detypedName="named-formatter")
public String namedFormatter()

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

namedFormatter

public T namedFormatter(String value)

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

suffix

@ModelNodeBinding(detypedName="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 T 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.