1 /*
2 * Copyright (C) 2009, 2013 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.InterruptedIOException;
48 import java.io.OutputStream;
49 import java.text.MessageFormat;
50
51 import org.eclipse.jgit.internal.JGitText;
52
53 /**
54 * OutputStream with a configurable timeout.
55 */
56 public class TimeoutOutputStream extends OutputStream {
57 private final OutputStream dst;
58
59 private final InterruptTimer myTimer;
60
61 private int timeout;
62
63 /**
64 * Wrap an output stream with a timeout on all write operations.
65 *
66 * @param destination
67 * base input stream (to write to). The stream must be
68 * interruptible (most socket streams are).
69 * @param timer
70 * timer to manage the timeouts during writes.
71 */
72 public TimeoutOutputStream(final OutputStream destination,
73 final InterruptTimer timer) {
74 dst = destination;
75 myTimer = timer;
76 }
77
78 /**
79 * Get number of milliseconds before aborting a write.
80 *
81 * @return number of milliseconds before aborting a write.
82 */
83 public int getTimeout() {
84 return timeout;
85 }
86
87 /**
88 * Set number of milliseconds before aborting a write.
89 *
90 * @param millis
91 * number of milliseconds before aborting a write. Must be >
92 * 0.
93 */
94 public void setTimeout(int millis) {
95 if (millis < 0)
96 throw new IllegalArgumentException(MessageFormat.format(
97 JGitText.get().invalidTimeout, Integer.valueOf(millis)));
98 timeout = millis;
99 }
100
101 /** {@inheritDoc} */
102 @Override
103 public void write(int b) throws IOException {
104 try {
105 beginWrite();
106 dst.write(b);
107 } catch (InterruptedIOException e) {
108 throw writeTimedOut();
109 } finally {
110 endWrite();
111 }
112 }
113
114 /** {@inheritDoc} */
115 @Override
116 public void write(byte[] buf) throws IOException {
117 write(buf, 0, buf.length);
118 }
119
120 /** {@inheritDoc} */
121 @Override
122 public void write(byte[] buf, int off, int len) throws IOException {
123 try {
124 beginWrite();
125 dst.write(buf, off, len);
126 } catch (InterruptedIOException e) {
127 throw writeTimedOut();
128 } finally {
129 endWrite();
130 }
131 }
132
133 /** {@inheritDoc} */
134 @Override
135 public void flush() throws IOException {
136 try {
137 beginWrite();
138 dst.flush();
139 } catch (InterruptedIOException e) {
140 throw writeTimedOut();
141 } finally {
142 endWrite();
143 }
144 }
145
146 /** {@inheritDoc} */
147 @Override
148 public void close() throws IOException {
149 try {
150 beginWrite();
151 dst.close();
152 } catch (InterruptedIOException e) {
153 throw writeTimedOut();
154 } finally {
155 endWrite();
156 }
157 }
158
159 private void beginWrite() {
160 myTimer.begin(timeout);
161 }
162
163 private void endWrite() {
164 myTimer.end();
165 }
166
167 private InterruptedIOException writeTimedOut() {
168 return new InterruptedIOException(MessageFormat.format(
169 JGitText.get().writeTimedOut, Integer.valueOf(timeout)));
170 }
171 }