1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * https://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19
20 package org.apache.commons.exec;
21
22 import java.io.IOException;
23 import java.io.InputStream;
24 import java.io.OutputStream;
25
26 /**
27 * Handles stream of subprocesses for {@link Executor}s.
28 */
29 public interface ExecuteStreamHandler {
30
31 /**
32 * Sets a handler for the error stream of the subprocess.
33 *
34 * @param inputStream input stream to read from the error stream from the subprocess.
35 * @throws IOException thrown when an I/O exception occurs.
36 */
37 void setProcessErrorStream(InputStream inputStream) throws IOException;
38
39 /**
40 * Sets a handler for the input stream of the subprocess.
41 *
42 * @param outputStream output stream to write to the standard input stream of the subprocess.
43 * @throws IOException thrown when an I/O exception occurs.
44 */
45 void setProcessInputStream(OutputStream outputStream) throws IOException;
46
47 /**
48 * Sets a handler for the output stream of the subprocess.
49 *
50 * @param inputStream input stream to read from the error stream from the subprocess.
51 * @throws IOException thrown when an I/O exception occurs.
52 */
53 void setProcessOutputStream(InputStream inputStream) throws IOException;
54
55 /**
56 * Starts handling of the streams.
57 *
58 * @throws IOException thrown when an I/O exception occurs.
59 */
60 void start() throws IOException;
61
62 /**
63 * Stops handling of the streams - will not be restarted. Will wait for pump threads to complete.
64 *
65 * @throws IOException thrown when an I/O exception occurs.
66 */
67 void stop() throws IOException;
68 }