1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/mobile/android/thirdparty/ch/boye/httpclientandroidlib/entity/BasicHttpEntity.java Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,137 @@
1.4 +/*
1.5 + * ====================================================================
1.6 + * Licensed to the Apache Software Foundation (ASF) under one
1.7 + * or more contributor license agreements. See the NOTICE file
1.8 + * distributed with this work for additional information
1.9 + * regarding copyright ownership. The ASF licenses this file
1.10 + * to you under the Apache License, Version 2.0 (the
1.11 + * "License"); you may not use this file except in compliance
1.12 + * with the License. You may obtain a copy of the License at
1.13 + *
1.14 + * http://www.apache.org/licenses/LICENSE-2.0
1.15 + *
1.16 + * Unless required by applicable law or agreed to in writing,
1.17 + * software distributed under the License is distributed on an
1.18 + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
1.19 + * KIND, either express or implied. See the License for the
1.20 + * specific language governing permissions and limitations
1.21 + * under the License.
1.22 + * ====================================================================
1.23 + *
1.24 + * This software consists of voluntary contributions made by many
1.25 + * individuals on behalf of the Apache Software Foundation. For more
1.26 + * information on the Apache Software Foundation, please see
1.27 + * <http://www.apache.org/>.
1.28 + *
1.29 + */
1.30 +
1.31 +package ch.boye.httpclientandroidlib.entity;
1.32 +
1.33 +import java.io.IOException;
1.34 +import java.io.InputStream;
1.35 +import java.io.OutputStream;
1.36 +
1.37 +/**
1.38 + * A generic streamed, non-repeatable entity that obtains its content
1.39 + * from an {@link InputStream}.
1.40 + *
1.41 + * @since 4.0
1.42 + */
1.43 +public class BasicHttpEntity extends AbstractHttpEntity {
1.44 +
1.45 + private InputStream content;
1.46 + private long length;
1.47 +
1.48 + /**
1.49 + * Creates a new basic entity.
1.50 + * The content is initially missing, the content length
1.51 + * is set to a negative number.
1.52 + */
1.53 + public BasicHttpEntity() {
1.54 + super();
1.55 + this.length = -1;
1.56 + }
1.57 +
1.58 + public long getContentLength() {
1.59 + return this.length;
1.60 + }
1.61 +
1.62 + /**
1.63 + * Obtains the content, once only.
1.64 + *
1.65 + * @return the content, if this is the first call to this method
1.66 + * since {@link #setContent setContent} has been called
1.67 + *
1.68 + * @throws IllegalStateException
1.69 + * if the content has not been provided
1.70 + */
1.71 + public InputStream getContent() throws IllegalStateException {
1.72 + if (this.content == null) {
1.73 + throw new IllegalStateException("Content has not been provided");
1.74 + }
1.75 + return this.content;
1.76 +
1.77 + }
1.78 +
1.79 + /**
1.80 + * Tells that this entity is not repeatable.
1.81 + *
1.82 + * @return <code>false</code>
1.83 + */
1.84 + public boolean isRepeatable() {
1.85 + return false;
1.86 + }
1.87 +
1.88 + /**
1.89 + * Specifies the length of the content.
1.90 + *
1.91 + * @param len the number of bytes in the content, or
1.92 + * a negative number to indicate an unknown length
1.93 + */
1.94 + public void setContentLength(long len) {
1.95 + this.length = len;
1.96 + }
1.97 +
1.98 + /**
1.99 + * Specifies the content.
1.100 + *
1.101 + * @param instream the stream to return with the next call to
1.102 + * {@link #getContent getContent}
1.103 + */
1.104 + public void setContent(final InputStream instream) {
1.105 + this.content = instream;
1.106 + }
1.107 +
1.108 + public void writeTo(final OutputStream outstream) throws IOException {
1.109 + if (outstream == null) {
1.110 + throw new IllegalArgumentException("Output stream may not be null");
1.111 + }
1.112 + InputStream instream = getContent();
1.113 + try {
1.114 + int l;
1.115 + byte[] tmp = new byte[2048];
1.116 + while ((l = instream.read(tmp)) != -1) {
1.117 + outstream.write(tmp, 0, l);
1.118 + }
1.119 + } finally {
1.120 + instream.close();
1.121 + }
1.122 + }
1.123 +
1.124 + public boolean isStreaming() {
1.125 + return this.content != null;
1.126 + }
1.127 +
1.128 + /**
1.129 + * Closes the content InputStream.
1.130 + *
1.131 + * @deprecated Either use {@link #getContent()} and call {@link java.io.InputStream#close()} on that;
1.132 + * otherwise call {@link #writeTo(OutputStream)} which is required to free the resources.
1.133 + */
1.134 + public void consumeContent() throws IOException {
1.135 + if (content != null) {
1.136 + content.close(); // reads to the end of the entity
1.137 + }
1.138 + }
1.139 +
1.140 +}
