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