hudson.console
Class ConsoleLogFilter

java.lang.Object
  hudson.console.ConsoleLogFilter

All Implemented Interfaces:

ExtensionPoint

public abstract class ConsoleLogFilter
extends Object
implements ExtensionPoint

A hook to allow filtering of information that is written to the console log. Unlike ConsoleAnnotator and ConsoleNote, this class provides direct access to the underlying OutputStream so it's possible to suppress data, which isn't possible from the other interfaces. (ArgumentListBuilder.add(String, boolean) is a simpler way to suppress a single password.)

Since:

1.383

Author:

dty

See Also:

BuildWrapper.decorateLogger(hudson.model.AbstractBuild, java.io.OutputStream)

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

ConsoleLogFilter()

Method Summary

static ExtensionList<ConsoleLogFilter>	all() All the registered ConsoleLogFilters.
abstract OutputStream	decorateLogger(AbstractBuild build, OutputStream logger) Called on the start of each build, giving extensions a chance to intercept the data that is written to the log.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConsoleLogFilter

public ConsoleLogFilter()

Method Detail

decorateLogger

public abstract OutputStream decorateLogger(AbstractBuild build,
                                            OutputStream logger)
                                     throws IOException,
                                            InterruptedException

Called on the start of each build, giving extensions a chance to intercept the data that is written to the log.

Throws:

IOException

InterruptedException

all

public static ExtensionList<ConsoleLogFilter> all()

All the registered ConsoleLogFilters.