File D:\maven-qcr-plugin-testsunitaires\qcr4java\jenkins-master\target\site\qc\core\src\main\java\hudson\console\ConsoleLogFilter.java.html

1 /*
2 * The MIT License
3 *
4 * Copyright 2010 Yahoo! Inc.
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
24
25 package hudson.console;
26
27 import hudson.ExtensionList;
28 import hudson.ExtensionPoint;
29 import hudson.model.AbstractBuild;
30 import hudson.tasks.BuildWrapper;
31 import hudson.util.ArgumentListBuilder;
32 import jenkins.model.Jenkins;
33
34 import java.io.IOException;
35 import java.io.OutputStream;
36
37 /**
38 * A hook to allow filtering of information that is written to the console log.
39 * Unlike {@link ConsoleAnnotator} and {@link ConsoleNote}, this class provides
40 * direct access to the underlying {@link OutputStream} so it's possible to suppress
41 * data, which isn't possible from the other interfaces.
42 * ({@link ArgumentListBuilder#add(String, boolean)} is a simpler way to suppress a single password.)
43 * @author dty
44 * @since 1.383
45 * @see BuildWrapper#decorateLogger
46 */
47 public abstract class ConsoleLogFilter implements ExtensionPoint {
48 /**
49 * Called on the start of each build, giving extensions a chance to intercept
50 * the data that is written to the log.
51 */
52 public abstract OutputStream decorateLogger(AbstractBuild build, OutputStream logger) throws IOException, InterruptedException;
53
54 /**
55 * All the registered {@link ConsoleLogFilter}s.
56 */
57 public static ExtensionList<ConsoleLogFilter> all() {
58 return Jenkins.getInstance().getExtensionList(ConsoleLogFilter.class);
59 }
60 }
61