mobile/android/thirdparty/ch/boye/httpclientandroidlib/entity/BasicHttpEntity.java

Wed, 31 Dec 2014 07:22:50 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Wed, 31 Dec 2014 07:22:50 +0100
branch
TOR_BUG_3246
changeset 4
fc2d59ddac77
permissions
-rw-r--r--

Correct previous dual key logic pending first delivery installment.

michael@0 1 /*
michael@0 2 * ====================================================================
michael@0 3 * Licensed to the Apache Software Foundation (ASF) under one
michael@0 4 * or more contributor license agreements. See the NOTICE file
michael@0 5 * distributed with this work for additional information
michael@0 6 * regarding copyright ownership. The ASF licenses this file
michael@0 7 * to you under the Apache License, Version 2.0 (the
michael@0 8 * "License"); you may not use this file except in compliance
michael@0 9 * with the License. You may obtain a copy of the License at
michael@0 10 *
michael@0 11 * http://www.apache.org/licenses/LICENSE-2.0
michael@0 12 *
michael@0 13 * Unless required by applicable law or agreed to in writing,
michael@0 14 * software distributed under the License is distributed on an
michael@0 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
michael@0 16 * KIND, either express or implied. See the License for the
michael@0 17 * specific language governing permissions and limitations
michael@0 18 * under the License.
michael@0 19 * ====================================================================
michael@0 20 *
michael@0 21 * This software consists of voluntary contributions made by many
michael@0 22 * individuals on behalf of the Apache Software Foundation. For more
michael@0 23 * information on the Apache Software Foundation, please see
michael@0 24 * <http://www.apache.org/>.
michael@0 25 *
michael@0 26 */
michael@0 27
michael@0 28 package ch.boye.httpclientandroidlib.entity;
michael@0 29
michael@0 30 import java.io.IOException;
michael@0 31 import java.io.InputStream;
michael@0 32 import java.io.OutputStream;
michael@0 33
michael@0 34 /**
michael@0 35 * A generic streamed, non-repeatable entity that obtains its content
michael@0 36 * from an {@link InputStream}.
michael@0 37 *
michael@0 38 * @since 4.0
michael@0 39 */
michael@0 40 public class BasicHttpEntity extends AbstractHttpEntity {
michael@0 41
michael@0 42 private InputStream content;
michael@0 43 private long length;
michael@0 44
michael@0 45 /**
michael@0 46 * Creates a new basic entity.
michael@0 47 * The content is initially missing, the content length
michael@0 48 * is set to a negative number.
michael@0 49 */
michael@0 50 public BasicHttpEntity() {
michael@0 51 super();
michael@0 52 this.length = -1;
michael@0 53 }
michael@0 54
michael@0 55 public long getContentLength() {
michael@0 56 return this.length;
michael@0 57 }
michael@0 58
michael@0 59 /**
michael@0 60 * Obtains the content, once only.
michael@0 61 *
michael@0 62 * @return the content, if this is the first call to this method
michael@0 63 * since {@link #setContent setContent} has been called
michael@0 64 *
michael@0 65 * @throws IllegalStateException
michael@0 66 * if the content has not been provided
michael@0 67 */
michael@0 68 public InputStream getContent() throws IllegalStateException {
michael@0 69 if (this.content == null) {
michael@0 70 throw new IllegalStateException("Content has not been provided");
michael@0 71 }
michael@0 72 return this.content;
michael@0 73
michael@0 74 }
michael@0 75
michael@0 76 /**
michael@0 77 * Tells that this entity is not repeatable.
michael@0 78 *
michael@0 79 * @return <code>false</code>
michael@0 80 */
michael@0 81 public boolean isRepeatable() {
michael@0 82 return false;
michael@0 83 }
michael@0 84
michael@0 85 /**
michael@0 86 * Specifies the length of the content.
michael@0 87 *
michael@0 88 * @param len the number of bytes in the content, or
michael@0 89 * a negative number to indicate an unknown length
michael@0 90 */
michael@0 91 public void setContentLength(long len) {
michael@0 92 this.length = len;
michael@0 93 }
michael@0 94
michael@0 95 /**
michael@0 96 * Specifies the content.
michael@0 97 *
michael@0 98 * @param instream the stream to return with the next call to
michael@0 99 * {@link #getContent getContent}
michael@0 100 */
michael@0 101 public void setContent(final InputStream instream) {
michael@0 102 this.content = instream;
michael@0 103 }
michael@0 104
michael@0 105 public void writeTo(final OutputStream outstream) throws IOException {
michael@0 106 if (outstream == null) {
michael@0 107 throw new IllegalArgumentException("Output stream may not be null");
michael@0 108 }
michael@0 109 InputStream instream = getContent();
michael@0 110 try {
michael@0 111 int l;
michael@0 112 byte[] tmp = new byte[2048];
michael@0 113 while ((l = instream.read(tmp)) != -1) {
michael@0 114 outstream.write(tmp, 0, l);
michael@0 115 }
michael@0 116 } finally {
michael@0 117 instream.close();
michael@0 118 }
michael@0 119 }
michael@0 120
michael@0 121 public boolean isStreaming() {
michael@0 122 return this.content != null;
michael@0 123 }
michael@0 124
michael@0 125 /**
michael@0 126 * Closes the content InputStream.
michael@0 127 *
michael@0 128 * @deprecated Either use {@link #getContent()} and call {@link java.io.InputStream#close()} on that;
michael@0 129 * otherwise call {@link #writeTo(OutputStream)} which is required to free the resources.
michael@0 130 */
michael@0 131 public void consumeContent() throws IOException {
michael@0 132 if (content != null) {
michael@0 133 content.close(); // reads to the end of the entity
michael@0 134 }
michael@0 135 }
michael@0 136
michael@0 137 }

mercurial