Module ch.qos.logback.core

Package ch.qos.logback.core

Class ConsoleAppender<E>

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

ch.qos.logback.core.UnsynchronizedAppenderBase<E>

ch.qos.logback.core.OutputStreamAppender<E>

ch.qos.logback.core.ConsoleAppender<E>

All Implemented Interfaces:

Appender<E>, ContextAware, FilterAttachable<E>, LifeCycle

Direct Known Subclasses:

JansiConsoleAppender

public class ConsoleAppender<E>
extends OutputStreamAppender<E>

ConsoleAppender appends log events to System.out or System.err using a layout specified by the user. The default target is System.out.

For more information about this appender, please refer to the online manual at http://logback.qos.ch/manual/appenders.html#ConsoleAppender

This appender does not own the console streams it writes to. On stop it flushes those streams but does not close them, so process-wide stdout/stderr (and Jansi streams wrapping them) remain usable after reconfiguration.

Author:

Ceki Gülcü, Tom SH Liu, Ruediger Dohna

See Also:

logback issue #1063

Field Summary

Fields

Modifier and Type	Field	Description
static String	FUSESOURCE_JANSI_ANSI_CONSOLE_CLASS_NAME
static String	JLINE_JANSI_ANSI_CONSOLE_CLASS_NAME
protected String	preferredJansiClassName
protected ConsoleTarget	target
protected boolean	withJansi

Fields inherited from class ch.qos.logback.core.OutputStreamAppender

encoder, streamWriteLock

Fields inherited from class ch.qos.logback.core.UnsynchronizedAppenderBase

name, started

Fields inherited from class ch.qos.logback.core.spi.ContextAwareBase

context

Constructor Summary

Constructors

Constructor	Description
ConsoleAppender()

Method Summary

Modifier and Type	Method	Description
protected ReentryGuard	buildReentryGuard()	Create a ThreadLocal ReentryGuard to prevent recursive appender invocations.
protected void	closeOutputStream()	Flush the console target without closing it.
String	getPreferredJansiClassName()
String	getTarget()	Returns the current value of the target property.
boolean	isWithJansi()	Deprecated. Use JansiConsoleAppender instead of withJansi on ConsoleAppender.
void	setPreferredJansiClassName(String preferredJansiClassName)	It allows to force Jansi class name used for probing.
void	setTarget(String value)	Sets the value of the Target option.
void	setWithJansi(boolean withJansi)	Deprecated. Use JansiConsoleAppender instead.
void	start()	Checks that requires parameters are set and if everything is in order, activates this appender.
protected OutputStream	wrapTarget(OutputStream targetStream)	Optionally wraps the raw console target stream before it is used for logging.
protected OutputStream	wrapWithJansi(OutputStream targetStream)	Deprecated. Use JansiConsoleAppender / override wrapTarget(OutputStream).

Methods inherited from class ch.qos.logback.core.OutputStreamAppender

append, getEncoder, getOutputStream, isImmediateFlush, setEncoder, setImmediateFlush, setLayout, setOutputStream, stop, subAppend, updateByteCount, writeByteArrayToOutputStreamWithPossibleFlush, writeOut

Methods inherited from class ch.qos.logback.core.UnsynchronizedAppenderBase

addFilter, clearAllFilters, doAppend, getCopyOfAttachedFiltersList, getFilterChainDecision, getName, isStarted, setName, toString

Methods inherited from class ch.qos.logback.core.spi.ContextAwareBase

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, getDeclaredOrigin, getStatusManager, setContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ch.qos.logback.core.spi.ContextAware

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, setContext

Field Detail

target

protected ConsoleTarget target

withJansi

protected boolean withJansi

JLINE_JANSI_ANSI_CONSOLE_CLASS_NAME

public static final String JLINE_JANSI_ANSI_CONSOLE_CLASS_NAME

See Also:

Constant Field Values

FUSESOURCE_JANSI_ANSI_CONSOLE_CLASS_NAME

public static final String FUSESOURCE_JANSI_ANSI_CONSOLE_CLASS_NAME

See Also:

Constant Field Values

preferredJansiClassName

protected String preferredJansiClassName

Constructor Detail

ConsoleAppender

public ConsoleAppender()

Method Detail

setTarget

public void setTarget(String value)

Sets the value of the Target option. Recognized values are "System.out" and "System.err". Any other value will be ignored.

getTarget

public String getTarget()

Returns the current value of the target property. The default value of the option is "System.out".

See also setTarget(java.lang.String).

getPreferredJansiClassName

public String getPreferredJansiClassName()

Returns:

the preferred Jansi class name

setPreferredJansiClassName

public void setPreferredJansiClassName(String preferredJansiClassName)

It allows to force Jansi class name used for probing.

Used for testing purposes.

Valid values are JLINE_JANSI_ANSI_CONSOLE_CLASS_NAME and FUSESOURCE_JANSI_ANSI_CONSOLE_CLASS_NAME.

Parameters:

preferredJansiClassName - the preferred Jansi class name

Since:

1.6.1

start

public void start()

Description copied from class: OutputStreamAppender

Checks that requires parameters are set and if everything is in order, activates this appender.

Specified by:

start in interface LifeCycle

Overrides:

start in class OutputStreamAppender<E>

closeOutputStream

protected void closeOutputStream()

Flush the console target without closing it.

System.out, System.err, and Jansi streams built on FileDescriptor.out/err are process-wide resources. Closing them from OutputStreamAppender.stop() would poison stdout for the rest of the JVM (see issue #1063). The non-Jansi ConsoleTarget streams already no-op on close(); this override keeps the same contract when Jansi is used.

Overrides:

closeOutputStream in class OutputStreamAppender<E>

buildReentryGuard

protected ReentryGuard buildReentryGuard()

Create a ThreadLocal ReentryGuard to prevent recursive appender invocations.

Overrides:

buildReentryGuard in class UnsynchronizedAppenderBase<E>

Returns:

a ReentryGuard instance of type THREAD_LOCAL.

wrapTarget

protected OutputStream wrapTarget(OutputStream targetStream)

Optionally wraps the raw console target stream before it is used for logging.

The default implementation applies the deprecated withJansi reflection path when withJansi is true. Subclasses such as JansiConsoleAppender should override this method to supply an alternate stream (without relying on withJansi).

Parameters:

targetStream - the raw stream for target

Returns:

the stream to use as this appender's output stream

Since:

1.6.3

wrapWithJansi

@Deprecated
protected OutputStream wrapWithJansi(OutputStream targetStream)

Deprecated.

Use JansiConsoleAppender / override wrapTarget(OutputStream).

Wraps the console target stream with a Jansi ANSI-aware stream using reflection.

This path is deprecated. Prefer JansiConsoleAppender, which overrides wrapTarget(OutputStream) and calls org.jline.jansi.AnsiConsole directly.

Parameters:

targetStream - the raw console target stream

Returns:

a Jansi-backed stream, or targetStream on failure

isWithJansi

@Deprecated
public boolean isWithJansi()

Deprecated.

Use JansiConsoleAppender instead of withJansi on ConsoleAppender.

Returns:

whether to use JANSI or not.

setWithJansi

@Deprecated
public void setWithJansi(boolean withJansi)

Deprecated.

Use JansiConsoleAppender instead.

If true, this appender will output to a stream provided by the JANSI library via reflection.

This option is deprecated. Use JansiConsoleAppender, which talks to org.jline.jansi.AnsiConsole directly, instead of <withJansi>true</withJansi> on a plain ConsoleAppender.

Parameters:

withJansi - whether to use JANSI or not.

Since:

1.0.5