1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
/*
* ====================================================================
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
*/
package ch.boye.httpclientandroidlib.entity;
import java.io.IOException;
import java.io.OutputStream;
import ch.boye.httpclientandroidlib.Header;
import ch.boye.httpclientandroidlib.HttpEntity;
import ch.boye.httpclientandroidlib.message.BasicHeader;
import ch.boye.httpclientandroidlib.protocol.HTTP;
/**
* Abstract base class for entities.
* Provides the commonly used attributes for streamed and self-contained
* implementations of {@link HttpEntity HttpEntity}.
*
* @since 4.0
*/
public abstract class AbstractHttpEntity implements HttpEntity {
protected Header contentType;
protected Header contentEncoding;
protected boolean chunked;
/**
* Protected default constructor.
* The contentType, contentEncoding and chunked attributes of the created object are set to
* <code>null</code>, <code>null</code> and <code>false</code>, respectively.
*/
protected AbstractHttpEntity() {
super();
}
/**
* Obtains the Content-Type header.
* The default implementation returns the value of the
* {@link #contentType contentType} attribute.
*
* @return the Content-Type header, or <code>null</code>
*/
public Header getContentType() {
return this.contentType;
}
/**
* Obtains the Content-Encoding header.
* The default implementation returns the value of the
* {@link #contentEncoding contentEncoding} attribute.
*
* @return the Content-Encoding header, or <code>null</code>
*/
public Header getContentEncoding() {
return this.contentEncoding;
}
/**
* Obtains the 'chunked' flag.
* The default implementation returns the value of the
* {@link #chunked chunked} attribute.
*
* @return the 'chunked' flag
*/
public boolean isChunked() {
return this.chunked;
}
/**
* Specifies the Content-Type header.
* The default implementation sets the value of the
* {@link #contentType contentType} attribute.
*
* @param contentType the new Content-Encoding header, or
* <code>null</code> to unset
*/
public void setContentType(final Header contentType) {
this.contentType = contentType;
}
/**
* Specifies the Content-Type header, as a string.
* The default implementation calls
* {@link #setContentType(Header) setContentType(Header)}.
*
* @param ctString the new Content-Type header, or
* <code>null</code> to unset
*/
public void setContentType(final String ctString) {
Header h = null;
if (ctString != null) {
h = new BasicHeader(HTTP.CONTENT_TYPE, ctString);
}
setContentType(h);
}
/**
* Specifies the Content-Encoding header.
* The default implementation sets the value of the
* {@link #contentEncoding contentEncoding} attribute.
*
* @param contentEncoding the new Content-Encoding header, or
* <code>null</code> to unset
*/
public void setContentEncoding(final Header contentEncoding) {
this.contentEncoding = contentEncoding;
}
/**
* Specifies the Content-Encoding header, as a string.
* The default implementation calls
* {@link #setContentEncoding(Header) setContentEncoding(Header)}.
*
* @param ceString the new Content-Encoding header, or
* <code>null</code> to unset
*/
public void setContentEncoding(final String ceString) {
Header h = null;
if (ceString != null) {
h = new BasicHeader(HTTP.CONTENT_ENCODING, ceString);
}
setContentEncoding(h);
}
/**
* Specifies the 'chunked' flag.
* <p>
* Note that the chunked setting is a hint only.
* If using HTTP/1.0, chunking is never performed.
* Otherwise, even if chunked is false, HttpClient must
* use chunk coding if the entity content length is
* unknown (-1).
* <p>
* The default implementation sets the value of the
* {@link #chunked chunked} attribute.
*
* @param b the new 'chunked' flag
*/
public void setChunked(boolean b) {
this.chunked = b;
}
/**
* The default implementation does not consume anything.
*
* @deprecated Either use {@link #getContent()} and call {@link java.io.InputStream#close()} on that;
* otherwise call {@link #writeTo(OutputStream)} which is required to free the resources.
*/
public void consumeContent() throws IOException {
}
}
|
