• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/entity/BufferedHttpEntity.java $
3  * $Revision: 496070 $
4  * $Date: 2007-01-14 04:18:34 -0800 (Sun, 14 Jan 2007) $
5  *
6  * ====================================================================
7  * Licensed to the Apache Software Foundation (ASF) under one
8  * or more contributor license agreements.  See the NOTICE file
9  * distributed with this work for additional information
10  * regarding copyright ownership.  The ASF licenses this file
11  * to you under the Apache License, Version 2.0 (the
12  * "License"); you may not use this file except in compliance
13  * with the License.  You may obtain a copy of the License at
14  *
15  *   http://www.apache.org/licenses/LICENSE-2.0
16  *
17  * Unless required by applicable law or agreed to in writing,
18  * software distributed under the License is distributed on an
19  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
20  * KIND, either express or implied.  See the License for the
21  * specific language governing permissions and limitations
22  * under the License.
23  * ====================================================================
24  *
25  * This software consists of voluntary contributions made by many
26  * individuals on behalf of the Apache Software Foundation.  For more
27  * information on the Apache Software Foundation, please see
28  * <http://www.apache.org/>.
29  *
30  */
31 
32 package org.apache.http.entity;
33 
34 import java.io.ByteArrayInputStream;
35 import java.io.IOException;
36 import java.io.InputStream;
37 import java.io.OutputStream;
38 
39 import org.apache.http.HttpEntity;
40 import org.apache.http.util.EntityUtils;
41 
42 /**
43  * A wrapping entity that buffers it content if necessary.
44  * The buffered entity is always repeatable.
45  * If the wrapped entity is repeatable itself, calls are passed through.
46  * If the wrapped entity is not repeatable, the content is read into a
47  * buffer once and provided from there as often as required.
48  *
49  * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
50  *
51  * @version $Revision: 496070 $
52  *
53  * @since 4.0
54  *
55  * @deprecated Please use {@link java.net.URL#openConnection} instead.
56  *     Please visit <a href="http://android-developers.blogspot.com/2011/09/androids-http-clients.html">this webpage</a>
57  *     for further details.
58  */
59 @Deprecated
60 public class BufferedHttpEntity extends HttpEntityWrapper {
61 
62     private final byte[] buffer;
63 
BufferedHttpEntity(final HttpEntity entity)64     public BufferedHttpEntity(final HttpEntity entity) throws IOException {
65         super(entity);
66         if (!entity.isRepeatable() || entity.getContentLength() < 0) {
67             this.buffer = EntityUtils.toByteArray(entity);
68         } else {
69             this.buffer = null;
70         }
71     }
72 
getContentLength()73     public long getContentLength() {
74         if (this.buffer != null) {
75             return this.buffer.length;
76         } else {
77             return wrappedEntity.getContentLength();
78         }
79     }
80 
getContent()81     public InputStream getContent() throws IOException {
82         if (this.buffer != null) {
83             return new ByteArrayInputStream(this.buffer);
84         } else {
85             return wrappedEntity.getContent();
86         }
87     }
88 
89     /**
90      * Tells that this entity does not have to be chunked.
91      *
92      * @return  <code>false</code>
93      */
isChunked()94     public boolean isChunked() {
95         return (buffer == null) && wrappedEntity.isChunked();
96     }
97 
98     /**
99      * Tells that this entity is repeatable.
100      *
101      * @return  <code>true</code>
102      */
isRepeatable()103     public boolean isRepeatable() {
104         return true;
105     }
106 
107 
writeTo(final OutputStream outstream)108     public void writeTo(final OutputStream outstream) throws IOException {
109         if (outstream == null) {
110             throw new IllegalArgumentException("Output stream may not be null");
111         }
112         if (this.buffer != null) {
113             outstream.write(this.buffer);
114         } else {
115             wrappedEntity.writeTo(outstream);
116         }
117     }
118 
119 
120     // non-javadoc, see interface HttpEntity
isStreaming()121     public boolean isStreaming() {
122         return (buffer == null) && wrappedEntity.isStreaming();
123     }
124 
125 } // class BufferedHttpEntity
126