View Javadoc
1   /*
2    * Copyright (C) 2009-2010, Google Inc.
3    * and other copyright owners as documented in the project's IP log.
4    *
5    * This program and the accompanying materials are made available
6    * under the terms of the Eclipse Distribution License v1.0 which
7    * accompanies this distribution, is reproduced below, and is
8    * available at http://www.eclipse.org/org/documents/edl-v10.php
9    *
10   * All rights reserved.
11   *
12   * Redistribution and use in source and binary forms, with or
13   * without modification, are permitted provided that the following
14   * conditions are met:
15   *
16   * - Redistributions of source code must retain the above copyright
17   *   notice, this list of conditions and the following disclaimer.
18   *
19   * - Redistributions in binary form must reproduce the above
20   *   copyright notice, this list of conditions and the following
21   *   disclaimer in the documentation and/or other materials provided
22   *   with the distribution.
23   *
24   * - Neither the name of the Eclipse Foundation, Inc. nor the
25   *   names of its contributors may be used to endorse or promote
26   *   products derived from this software without specific prior
27   *   written permission.
28   *
29   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
30   * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
31   * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
34   * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
36   * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
37   * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
38   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41   * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42   */
43  
44  package org.eclipse.jgit.util.io;
45  
46  import java.io.IOException;
47  import java.io.InputStream;
48  import java.io.InterruptedIOException;
49  import java.io.OutputStream;
50  
51  /**
52   * Thread to copy from an input stream to an output stream.
53   */
54  public class StreamCopyThread extends Thread {
55  	private static final int BUFFER_SIZE = 1024;
56  
57  	private final InputStream src;
58  
59  	private final OutputStream dst;
60  
61  	private volatile boolean done;
62  
63  	/** Lock held by flush to avoid interrupting a write. */
64  	private final Object writeLock;
65  
66  	/**
67  	 * Create a thread to copy data from an input stream to an output stream.
68  	 *
69  	 * @param i
70  	 *            stream to copy from. The thread terminates when this stream
71  	 *            reaches EOF. The thread closes this stream before it exits.
72  	 * @param o
73  	 *            stream to copy into. The destination stream is automatically
74  	 *            closed when the thread terminates.
75  	 */
76  	public StreamCopyThread(InputStream i, OutputStream o) {
77  		setName(Thread.currentThread().getName() + "-StreamCopy"); //$NON-NLS-1$
78  		src = i;
79  		dst = o;
80  		writeLock = new Object();
81  	}
82  
83  	/**
84  	 * Request that the thread terminate, and wait for it.
85  	 * <p>
86  	 * This method signals to the copy thread that it should stop as soon as
87  	 * there is no more IO occurring.
88  	 *
89  	 * @throws java.lang.InterruptedException
90  	 *             the calling thread was interrupted.
91  	 */
92  	public void halt() throws InterruptedException {
93  		for (;;) {
94  			join(250 /* milliseconds */);
95  			if (isAlive()) {
96  				done = true;
97  				interrupt();
98  			} else
99  				break;
100 		}
101 	}
102 
103 	/** {@inheritDoc} */
104 	@Override
105 	public void run() {
106 		try {
107 			final byte[] buf = new byte[BUFFER_SIZE];
108 			boolean readInterrupted = false;
109 			for (;;) {
110 				try {
111 					if (readInterrupted) {
112 						synchronized (writeLock) {
113 							boolean interruptedAgain = Thread.interrupted();
114 							dst.flush();
115 							if (interruptedAgain) {
116 								interrupt();
117 							}
118 						}
119 						readInterrupted = false;
120 					}
121 
122 					if (done)
123 						break;
124 
125 					final int n;
126 					try {
127 						n = src.read(buf);
128 					} catch (InterruptedIOException wakey) {
129 						readInterrupted = true;
130 						continue;
131 					}
132 					if (n < 0)
133 						break;
134 
135 					synchronized (writeLock) {
136 						boolean writeInterrupted = Thread.interrupted();
137 						dst.write(buf, 0, n);
138 						if (writeInterrupted) {
139 							interrupt();
140 						}
141 					}
142 				} catch (IOException e) {
143 					break;
144 				}
145 			}
146 		} finally {
147 			try {
148 				src.close();
149 			} catch (IOException e) {
150 				// Ignore IO errors on close
151 			}
152 			try {
153 				dst.close();
154 			} catch (IOException e) {
155 				// Ignore IO errors on close
156 			}
157 		}
158 	}
159 }