1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package org.apache.tools.ant.taskdefs;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
/**
* Copies standard output and error of subprocesses to standard output and
* error of the parent process.
*
* @since Ant 1.2
*/
public class PumpStreamHandler implements ExecuteStreamHandler {
private Thread outputThread;
private Thread errorThread;
private Thread inputThread;
private OutputStream out;
private OutputStream err;
private InputStream input;
private final boolean nonBlockingRead;
/**
* Construct a new <code>PumpStreamHandler</code>.
* @param out the output <code>OutputStream</code>.
* @param err the error <code>OutputStream</code>.
* @param input the input <code>InputStream</code>.
* @param nonBlockingRead set it to <code>true</code> if the input should be
* read with simulated non blocking IO.
*/
public PumpStreamHandler(OutputStream out, OutputStream err,
InputStream input, boolean nonBlockingRead) {
this.out = out;
this.err = err;
this.input = input;
this.nonBlockingRead = nonBlockingRead;
}
/**
* Construct a new <code>PumpStreamHandler</code>.
* @param out the output <code>OutputStream</code>.
* @param err the error <code>OutputStream</code>.
* @param input the input <code>InputStream</code>.
*/
public PumpStreamHandler(OutputStream out, OutputStream err,
InputStream input) {
this(out, err, input, false);
}
/**
* Construct a new <code>PumpStreamHandler</code>.
* @param out the output <code>OutputStream</code>.
* @param err the error <code>OutputStream</code>.
*/
public PumpStreamHandler(OutputStream out, OutputStream err) {
this(out, err, null);
}
/**
* Construct a new <code>PumpStreamHandler</code>.
* @param outAndErr the output/error <code>OutputStream</code>.
*/
public PumpStreamHandler(OutputStream outAndErr) {
this(outAndErr, outAndErr);
}
/**
* Construct a new <code>PumpStreamHandler</code>.
*/
public PumpStreamHandler() {
this(System.out, System.err);
}
/**
* Set the <code>InputStream</code> from which to read the
* standard output of the process.
* @param is the <code>InputStream</code>.
*/
public void setProcessOutputStream(InputStream is) {
createProcessOutputPump(is, out);
}
/**
* Set the <code>InputStream</code> from which to read the
* standard error of the process.
* @param is the <code>InputStream</code>.
*/
public void setProcessErrorStream(InputStream is) {
if (err != null) {
createProcessErrorPump(is, err);
}
}
/**
* Set the <code>OutputStream</code> by means of which
* input can be sent to the process.
* @param os the <code>OutputStream</code>.
*/
public void setProcessInputStream(OutputStream os) {
if (input != null) {
inputThread = createPump(input, os, true, nonBlockingRead);
} else {
try {
os.close();
} catch (IOException e) {
//ignore
}
}
}
/**
* Start the <code>Thread</code>s.
*/
public void start() {
outputThread.start();
errorThread.start();
if (inputThread != null) {
inputThread.start();
}
}
/**
* Stop pumping the streams.
*/
public void stop() {
finish(inputThread);
try {
err.flush();
} catch (IOException e) {
// ignore
}
try {
out.flush();
} catch (IOException e) {
// ignore
}
finish(outputThread);
finish(errorThread);
}
private static final long JOIN_TIMEOUT = 200;
/**
* Waits for a thread to finish while trying to make it finish
* quicker by stopping the pumper (if the thread is a {@link
* ThreadWithPumper ThreadWithPumper} instance) or interrupting
* the thread.
*
* @since Ant 1.8.0
*/
protected final void finish(Thread t) {
if (t == null) {
// nothing to terminate
return;
}
try {
StreamPumper s = null;
if (t instanceof ThreadWithPumper) {
s = ((ThreadWithPumper) t).getPumper();
}
if (s != null && s.isFinished()) {
return;
}
if (!t.isAlive()) {
return;
}
if (s != null && !s.isFinished()) {
s.stop();
}
t.join(JOIN_TIMEOUT);
while ((s == null || !s.isFinished()) && t.isAlive()) {
t.interrupt();
t.join(JOIN_TIMEOUT);
}
} catch (InterruptedException e) {
// ignore
}
}
/**
* Get the error stream.
* @return <code>OutputStream</code>.
*/
protected OutputStream getErr() {
return err;
}
/**
* Get the output stream.
* @return <code>OutputStream</code>.
*/
protected OutputStream getOut() {
return out;
}
/**
* Create the pump to handle process output.
* @param is the <code>InputStream</code>.
* @param os the <code>OutputStream</code>.
*/
protected void createProcessOutputPump(InputStream is, OutputStream os) {
outputThread = createPump(is, os);
}
/**
* Create the pump to handle error output.
* @param is the input stream to copy from.
* @param os the output stream to copy to.
*/
protected void createProcessErrorPump(InputStream is, OutputStream os) {
errorThread = createPump(is, os);
}
/**
* Creates a stream pumper to copy the given input stream to the
* given output stream.
* @param is the input stream to copy from.
* @param os the output stream to copy to.
* @return a thread object that does the pumping.
*/
protected Thread createPump(InputStream is, OutputStream os) {
return createPump(is, os, false);
}
/**
* Creates a stream pumper to copy the given input stream to the
* given output stream.
* @param is the input stream to copy from.
* @param os the output stream to copy to.
* @param closeWhenExhausted if true close the inputstream.
* @return a thread object that does the pumping, subclasses
* should return an instance of {@link ThreadWithPumper
* ThreadWithPumper}.
*/
protected Thread createPump(InputStream is, OutputStream os,
boolean closeWhenExhausted) {
return createPump(is, os, closeWhenExhausted, true);
}
/**
* Creates a stream pumper to copy the given input stream to the
* given output stream.
* @param is the input stream to copy from.
* @param os the output stream to copy to.
* @param closeWhenExhausted if true close the inputstream.
* @param nonBlockingIO set it to <code>true</code> to use simulated non
* blocking IO.
* @return a thread object that does the pumping, subclasses
* should return an instance of {@link ThreadWithPumper
* ThreadWithPumper}.
* @since Ant 1.8.2
*/
protected Thread createPump(InputStream is, OutputStream os,
boolean closeWhenExhausted, boolean nonBlockingIO) {
StreamPumper pumper = new StreamPumper(is, os, closeWhenExhausted, nonBlockingIO);
pumper.setAutoflush(true);
final Thread result = new ThreadWithPumper(pumper);
result.setDaemon(true);
return result;
}
/**
* Specialized subclass that allows access to the running StreamPumper.
*
* @since Ant 1.8.0
*/
protected static class ThreadWithPumper extends Thread {
private final StreamPumper pumper;
public ThreadWithPumper(StreamPumper p) {
super(p);
pumper = p;
}
protected StreamPumper getPumper() {
return pumper;
}
}
}
|
