mobile/android/thirdparty/ch/boye/httpclientandroidlib/impl/entity/EntitySerializer.java@6474c204b198 (annotated)
mobile/android/thirdparty/ch/boye/httpclientandroidlib/impl/entity/EntitySerializer.java
Wed, 31 Dec 2014 06:09:35 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 06:09:35 +0100
- changeset 0
- 6474c204b198
- permissions
- -rw-r--r--
Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.
| 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.impl.entity; |
| michael@0 | 29 | |
| michael@0 | 30 | import java.io.IOException; |
| michael@0 | 31 | import java.io.OutputStream; |
| michael@0 | 32 | |
| michael@0 | 33 | import ch.boye.httpclientandroidlib.HttpEntity; |
| michael@0 | 34 | import ch.boye.httpclientandroidlib.HttpException; |
| michael@0 | 35 | import ch.boye.httpclientandroidlib.HttpMessage; |
| michael@0 | 36 | import ch.boye.httpclientandroidlib.entity.ContentLengthStrategy; |
| michael@0 | 37 | import ch.boye.httpclientandroidlib.impl.io.ChunkedOutputStream; |
| michael@0 | 38 | import ch.boye.httpclientandroidlib.impl.io.ContentLengthOutputStream; |
| michael@0 | 39 | import ch.boye.httpclientandroidlib.impl.io.IdentityOutputStream; |
| michael@0 | 40 | import ch.boye.httpclientandroidlib.io.SessionOutputBuffer; |
| michael@0 | 41 | |
| michael@0 | 42 | /** |
| michael@0 | 43 | * HTTP entity serializer. |
| michael@0 | 44 | * <p> |
| michael@0 | 45 | * This entity serializer currently supports "chunked" and "identitiy" |
| michael@0 | 46 | * transfer-coding and content length delimited content. |
| michael@0 | 47 | * <p> |
| michael@0 | 48 | * This class relies on a specific implementation of |
| michael@0 | 49 | * {@link ContentLengthStrategy} to determine the content length or transfer |
| michael@0 | 50 | * encoding of the entity. |
| michael@0 | 51 | * <p> |
| michael@0 | 52 | * This class writes out the content of {@link HttpEntity} to the data stream |
| michael@0 | 53 | * using a transfer coding based on properties on the HTTP message. |
| michael@0 | 54 | * |
| michael@0 | 55 | * @since 4.0 |
| michael@0 | 56 | */ |
| michael@0 | 57 | public class EntitySerializer { |
| michael@0 | 58 | |
| michael@0 | 59 | private final ContentLengthStrategy lenStrategy; |
| michael@0 | 60 | |
| michael@0 | 61 | public EntitySerializer(final ContentLengthStrategy lenStrategy) { |
| michael@0 | 62 | super(); |
| michael@0 | 63 | if (lenStrategy == null) { |
| michael@0 | 64 | throw new IllegalArgumentException("Content length strategy may not be null"); |
| michael@0 | 65 | } |
| michael@0 | 66 | this.lenStrategy = lenStrategy; |
| michael@0 | 67 | } |
| michael@0 | 68 | |
| michael@0 | 69 | /** |
| michael@0 | 70 | * Creates a transfer codec based on properties of the given HTTP message |
| michael@0 | 71 | * and returns {@link OutputStream} instance that transparently encodes |
| michael@0 | 72 | * output data as it is being written out to the output stream. |
| michael@0 | 73 | * <p> |
| michael@0 | 74 | * This method is called by the public |
| michael@0 | 75 | * {@link #serialize(SessionOutputBuffer, HttpMessage, HttpEntity)}. |
| michael@0 | 76 | * |
| michael@0 | 77 | * @param outbuffer the session output buffer. |
| michael@0 | 78 | * @param message the HTTP message. |
| michael@0 | 79 | * @return output stream. |
| michael@0 | 80 | * @throws HttpException in case of HTTP protocol violation. |
| michael@0 | 81 | * @throws IOException in case of an I/O error. |
| michael@0 | 82 | */ |
| michael@0 | 83 | protected OutputStream doSerialize( |
| michael@0 | 84 | final SessionOutputBuffer outbuffer, |
| michael@0 | 85 | final HttpMessage message) throws HttpException, IOException { |
| michael@0 | 86 | long len = this.lenStrategy.determineLength(message); |
| michael@0 | 87 | if (len == ContentLengthStrategy.CHUNKED) { |
| michael@0 | 88 | return new ChunkedOutputStream(outbuffer); |
| michael@0 | 89 | } else if (len == ContentLengthStrategy.IDENTITY) { |
| michael@0 | 90 | return new IdentityOutputStream(outbuffer); |
| michael@0 | 91 | } else { |
| michael@0 | 92 | return new ContentLengthOutputStream(outbuffer, len); |
| michael@0 | 93 | } |
| michael@0 | 94 | } |
| michael@0 | 95 | |
| michael@0 | 96 | /** |
| michael@0 | 97 | * Writes out the content of the given HTTP entity to the session output |
| michael@0 | 98 | * buffer based on properties of the given HTTP message. |
| michael@0 | 99 | * |
| michael@0 | 100 | * @param outbuffer the output session buffer. |
| michael@0 | 101 | * @param message the HTTP message. |
| michael@0 | 102 | * @param entity the HTTP entity to be written out. |
| michael@0 | 103 | * @throws HttpException in case of HTTP protocol violation. |
| michael@0 | 104 | * @throws IOException in case of an I/O error. |
| michael@0 | 105 | */ |
| michael@0 | 106 | public void serialize( |
| michael@0 | 107 | final SessionOutputBuffer outbuffer, |
| michael@0 | 108 | final HttpMessage message, |
| michael@0 | 109 | final HttpEntity entity) throws HttpException, IOException { |
| michael@0 | 110 | if (outbuffer == null) { |
| michael@0 | 111 | throw new IllegalArgumentException("Session output buffer may not be null"); |
| michael@0 | 112 | } |
| michael@0 | 113 | if (message == null) { |
| michael@0 | 114 | throw new IllegalArgumentException("HTTP message may not be null"); |
| michael@0 | 115 | } |
| michael@0 | 116 | if (entity == null) { |
| michael@0 | 117 | throw new IllegalArgumentException("HTTP entity may not be null"); |
| michael@0 | 118 | } |
| michael@0 | 119 | OutputStream outstream = doSerialize(outbuffer, message); |
| michael@0 | 120 | entity.writeTo(outstream); |
| michael@0 | 121 | outstream.close(); |
| michael@0 | 122 | } |
| michael@0 | 123 | |
| michael@0 | 124 | } |
