1 /*
2 * ====================================================================
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements. See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership. The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License. You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied. See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 * ====================================================================
20 *
21 * This software consists of voluntary contributions made by many
22 * individuals on behalf of the Apache Software Foundation. For more
23 * information on the Apache Software Foundation, please see
24 * <http://www.apache.org/>.
25 *
26 */
27
28 package org.apache.http.protocol;
29
30 import java.io.IOException;
31
32 import org.apache.http.HttpEntity;
33 import org.apache.http.HttpEntityEnclosingRequest;
34 import org.apache.http.HttpException;
35 import org.apache.http.HttpRequest;
36 import org.apache.http.HttpRequestInterceptor;
37 import org.apache.http.HttpVersion;
38 import org.apache.http.ProtocolException;
39 import org.apache.http.ProtocolVersion;
40 import org.apache.http.annotation.Immutable;
41 import org.apache.http.util.Args;
42
43 /**
44 * RequestContent is the most important interceptor for outgoing requests.
45 * It is responsible for delimiting content length by adding
46 * <code>Content-Length</code> or <code>Transfer-Content</code> headers based
47 * on the properties of the enclosed entity and the protocol version.
48 * This interceptor is required for correct functioning of client side protocol
49 * processors.
50 *
51 * @since 4.0
52 */
53 @Immutable
54 public class RequestContent implements HttpRequestInterceptor {
55
56 private final boolean overwrite;
57
58 /**
59 * Default constructor. The <code>Content-Length</code> or <code>Transfer-Encoding</code>
60 * will cause the interceptor to throw {@link ProtocolException} if already present in the
61 * response message.
62 */
63 public RequestContent() {
64 this(false);
65 }
66
67 /**
68 * Constructor that can be used to fine-tune behavior of this interceptor.
69 *
70 * @param overwrite If set to <code>true</code> the <code>Content-Length</code> and
71 * <code>Transfer-Encoding</code> headers will be created or updated if already present.
72 * If set to <code>false</code> the <code>Content-Length</code> and
73 * <code>Transfer-Encoding</code> headers will cause the interceptor to throw
74 * {@link ProtocolException} if already present in the response message.
75 *
76 * @since 4.2
77 */
78 public RequestContent(final boolean overwrite) {
79 super();
80 this.overwrite = overwrite;
81 }
82
83 public void process(final HttpRequest request, final HttpContext context)
84 throws HttpException, IOException {
85 Args.notNull(request, "HTTP request");
86 if (request instanceof HttpEntityEnclosingRequest) {
87 if (this.overwrite) {
88 request.removeHeaders(HTTP.TRANSFER_ENCODING);
89 request.removeHeaders(HTTP.CONTENT_LEN);
90 } else {
91 if (request.containsHeader(HTTP.TRANSFER_ENCODING)) {
92 throw new ProtocolException("Transfer-encoding header already present");
93 }
94 if (request.containsHeader(HTTP.CONTENT_LEN)) {
95 throw new ProtocolException("Content-Length header already present");
96 }
97 }
98 final ProtocolVersion ver = request.getRequestLine().getProtocolVersion();
99 final HttpEntity entity = ((HttpEntityEnclosingRequest)request).getEntity();
100 if (entity == null) {
101 request.addHeader(HTTP.CONTENT_LEN, "0");
102 return;
103 }
104 // Must specify a transfer encoding or a content length
105 if (entity.isChunked() || entity.getContentLength() < 0) {
106 if (ver.lessEquals(HttpVersion.HTTP_1_0)) {
107 throw new ProtocolException(
108 "Chunked transfer encoding not allowed for " + ver);
109 }
110 request.addHeader(HTTP.TRANSFER_ENCODING, HTTP.CHUNK_CODING);
111 } else {
112 request.addHeader(HTTP.CONTENT_LEN, Long.toString(entity.getContentLength()));
113 }
114 // Specify a content type if known
115 if (entity.getContentType() != null && !request.containsHeader(
116 HTTP.CONTENT_TYPE )) {
117 request.addHeader(entity.getContentType());
118 }
119 // Specify a content encoding if known
120 if (entity.getContentEncoding() != null && !request.containsHeader(
121 HTTP.CONTENT_ENCODING)) {
122 request.addHeader(entity.getContentEncoding());
123 }
124 }
125 }
126
127 }