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
|
/*
* ====================================================================
* 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.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
*/
package ch.boye.httpclientandroidlib.entity;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import ch.boye.httpclientandroidlib.annotation.NotThreadSafe;
import ch.boye.httpclientandroidlib.util.Args;
/**
* A streamed, non-repeatable entity that obtains its content from
* an {@link InputStream}.
*
* @since 4.0
*/
@NotThreadSafe
public class InputStreamEntity extends AbstractHttpEntity {
private final InputStream content;
private final long length;
/**
* Creates an entity with an unknown length.
* Equivalent to {@code new InputStreamEntity(instream, -1)}.
*
* @param instream input stream
* @throws IllegalArgumentException if {@code instream} is {@code null}
* @since 4.3
*/
public InputStreamEntity(final InputStream instream) {
this(instream, -1);
}
/**
* Creates an entity with a specified content length.
*
* @param instream input stream
* @param length of the input stream, {@code -1} if unknown
* @throws IllegalArgumentException if {@code instream} is {@code null}
*/
public InputStreamEntity(final InputStream instream, final long length) {
this(instream, length, null);
}
/**
* Creates an entity with a content type and unknown length.
* Equivalent to {@code new InputStreamEntity(instream, -1, contentType)}.
*
* @param instream input stream
* @param contentType content type
* @throws IllegalArgumentException if {@code instream} is {@code null}
* @since 4.3
*/
public InputStreamEntity(final InputStream instream, final ContentType contentType) {
this(instream, -1, contentType);
}
/**
* @param instream input stream
* @param length of the input stream, {@code -1} if unknown
* @param contentType for specifying the {@code Content-Type} header, may be {@code null}
* @throws IllegalArgumentException if {@code instream} is {@code null}
* @since 4.2
*/
public InputStreamEntity(final InputStream instream, final long length, final ContentType contentType) {
super();
this.content = Args.notNull(instream, "Source input stream");
this.length = length;
if (contentType != null) {
setContentType(contentType.toString());
}
}
public boolean isRepeatable() {
return false;
}
/**
* @return the content length or {@code -1} if unknown
*/
public long getContentLength() {
return this.length;
}
public InputStream getContent() throws IOException {
return this.content;
}
/**
* Writes bytes from the {@code InputStream} this entity was constructed
* with to an {@code OutputStream}. The content length
* determines how many bytes are written. If the length is unknown ({@code -1}), the
* stream will be completely consumed (to the end of the stream).
*
*/
public void writeTo(final OutputStream outstream) throws IOException {
Args.notNull(outstream, "Output stream");
final InputStream instream = this.content;
try {
final byte[] buffer = new byte[OUTPUT_BUFFER_SIZE];
int l;
if (this.length < 0) {
// consume until EOF
while ((l = instream.read(buffer)) != -1) {
outstream.write(buffer, 0, l);
}
} else {
// consume no more than length
long remaining = this.length;
while (remaining > 0) {
l = instream.read(buffer, 0, (int)Math.min(OUTPUT_BUFFER_SIZE, remaining));
if (l == -1) {
break;
}
outstream.write(buffer, 0, l);
remaining -= l;
}
}
} finally {
instream.close();
}
}
public boolean isStreaming() {
return true;
}
}
|
