mobile/android/thirdparty/ch/boye/httpclientandroidlib/client/HttpClient.java@fc2d59ddac77
mobile/android/thirdparty/ch/boye/httpclientandroidlib/client/HttpClient.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.
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 */
28 package ch.boye.httpclientandroidlib.client;
30 import java.io.IOException;
32 import ch.boye.httpclientandroidlib.HttpHost;
33 import ch.boye.httpclientandroidlib.HttpRequest;
34 import ch.boye.httpclientandroidlib.HttpResponse;
35 import ch.boye.httpclientandroidlib.client.methods.HttpUriRequest;
36 import ch.boye.httpclientandroidlib.conn.ClientConnectionManager;
37 import ch.boye.httpclientandroidlib.params.HttpParams;
38 import ch.boye.httpclientandroidlib.protocol.HttpContext;
40 /**
41 * This interface represents only the most basic contract for HTTP request
42 * execution. It imposes no restrictions or particular details on the request
43 * execution process and leaves the specifics of state management,
44 * authentication and redirect handling up to individual implementations.
45 * This should make it easier to decorate the interface with additional
46 * functionality such as response content caching.
47 * <p/>
48 * The usual execution flow can be demonstrated by the code snippet below:
49 * <PRE>
50 * HttpClient httpclient = new DefaultHttpClient();
51 *
52 * // Prepare a request object
53 * HttpGet httpget = new HttpGet("http://www.apache.org/");
54 *
55 * // Execute the request
56 * HttpResponse response = httpclient.execute(httpget);
57 *
58 * // Examine the response status
59 * System.out.println(response.getStatusLine());
60 *
61 * // Get hold of the response entity
62 * HttpEntity entity = response.getEntity();
63 *
64 * // If the response does not enclose an entity, there is no need
65 * // to worry about connection release
66 * if (entity != null) {
67 * InputStream instream = entity.getContent();
68 * try {
69 *
70 * BufferedReader reader = new BufferedReader(
71 * new InputStreamReader(instream));
72 * // do something useful with the response
73 * System.out.println(reader.readLine());
74 *
75 * } catch (IOException ex) {
76 *
77 * // In case of an IOException the connection will be released
78 * // back to the connection manager automatically
79 * throw ex;
80 *
81 * } catch (RuntimeException ex) {
82 *
83 * // In case of an unexpected exception you may want to abort
84 * // the HTTP request in order to shut down the underlying
85 * // connection and release it back to the connection manager.
86 * httpget.abort();
87 * throw ex;
88 *
89 * } finally {
90 *
91 * // Closing the input stream will trigger connection release
92 * instream.close();
93 *
94 * }
95 *
96 * // When HttpClient instance is no longer needed,
97 * // shut down the connection manager to ensure
98 * // immediate deallocation of all system resources
99 * httpclient.getConnectionManager().shutdown();
100 * }
101 * </PRE>
102 *
103 * @since 4.0
104 */
105 public interface HttpClient {
108 /**
109 * Obtains the parameters for this client.
110 * These parameters will become defaults for all requests being
111 * executed with this client, and for the parameters of
112 * dependent objects in this client.
113 *
114 * @return the default parameters
115 */
116 HttpParams getParams();
118 /**
119 * Obtains the connection manager used by this client.
120 *
121 * @return the connection manager
122 */
123 ClientConnectionManager getConnectionManager();
125 /**
126 * Executes a request using the default context.
127 *
128 * @param request the request to execute
129 *
130 * @return the response to the request. This is always a final response,
131 * never an intermediate response with an 1xx status code.
132 * Whether redirects or authentication challenges will be returned
133 * or handled automatically depends on the implementation and
134 * configuration of this client.
135 * @throws IOException in case of a problem or the connection was aborted
136 * @throws ClientProtocolException in case of an http protocol error
137 */
138 HttpResponse execute(HttpUriRequest request)
139 throws IOException, ClientProtocolException;
141 /**
142 * Executes a request using the given context.
143 * The route to the target will be determined by the HTTP client.
144 *
145 * @param request the request to execute
146 * @param context the context to use for the execution, or
147 * <code>null</code> to use the default context
148 *
149 * @return the response to the request. This is always a final response,
150 * never an intermediate response with an 1xx status code.
151 * Whether redirects or authentication challenges will be returned
152 * or handled automatically depends on the implementation and
153 * configuration of this client.
154 * @throws IOException in case of a problem or the connection was aborted
155 * @throws ClientProtocolException in case of an http protocol error
156 */
157 HttpResponse execute(HttpUriRequest request, HttpContext context)
158 throws IOException, ClientProtocolException;
160 /**
161 * Executes a request to the target using the default context.
162 *
163 * @param target the target host for the request.
164 * Implementations may accept <code>null</code>
165 * if they can still determine a route, for example
166 * to a default target or by inspecting the request.
167 * @param request the request to execute
168 *
169 * @return the response to the request. This is always a final response,
170 * never an intermediate response with an 1xx status code.
171 * Whether redirects or authentication challenges will be returned
172 * or handled automatically depends on the implementation and
173 * configuration of this client.
174 * @throws IOException in case of a problem or the connection was aborted
175 * @throws ClientProtocolException in case of an http protocol error
176 */
177 HttpResponse execute(HttpHost target, HttpRequest request)
178 throws IOException, ClientProtocolException;
180 /**
181 * Executes a request to the target using the given context.
182 *
183 * @param target the target host for the request.
184 * Implementations may accept <code>null</code>
185 * if they can still determine a route, for example
186 * to a default target or by inspecting the request.
187 * @param request the request to execute
188 * @param context the context to use for the execution, or
189 * <code>null</code> to use the default context
190 *
191 * @return the response to the request. This is always a final response,
192 * never an intermediate response with an 1xx status code.
193 * Whether redirects or authentication challenges will be returned
194 * or handled automatically depends on the implementation and
195 * configuration of this client.
196 * @throws IOException in case of a problem or the connection was aborted
197 * @throws ClientProtocolException in case of an http protocol error
198 */
199 HttpResponse execute(HttpHost target, HttpRequest request,
200 HttpContext context)
201 throws IOException, ClientProtocolException;
203 /**
204 * Executes a request using the default context and processes the
205 * response using the given response handler.
206 *
207 * @param request the request to execute
208 * @param responseHandler the response handler
209 *
210 * @return the response object as generated by the response handler.
211 * @throws IOException in case of a problem or the connection was aborted
212 * @throws ClientProtocolException in case of an http protocol error
213 */
214 <T> T execute(
215 HttpUriRequest request,
216 ResponseHandler<? extends T> responseHandler)
217 throws IOException, ClientProtocolException;
219 /**
220 * Executes a request using the given context and processes the
221 * response using the given response handler.
222 *
223 * @param request the request to execute
224 * @param responseHandler the response handler
225 *
226 * @return the response object as generated by the response handler.
227 * @throws IOException in case of a problem or the connection was aborted
228 * @throws ClientProtocolException in case of an http protocol error
229 */
230 <T> T execute(
231 HttpUriRequest request,
232 ResponseHandler<? extends T> responseHandler,
233 HttpContext context)
234 throws IOException, ClientProtocolException;
236 /**
237 * Executes a request to the target using the default context and
238 * processes the response using the given response handler.
239 *
240 * @param target the target host for the request.
241 * Implementations may accept <code>null</code>
242 * if they can still determine a route, for example
243 * to a default target or by inspecting the request.
244 * @param request the request to execute
245 * @param responseHandler the response handler
246 *
247 * @return the response object as generated by the response handler.
248 * @throws IOException in case of a problem or the connection was aborted
249 * @throws ClientProtocolException in case of an http protocol error
250 */
251 <T> T execute(
252 HttpHost target,
253 HttpRequest request,
254 ResponseHandler<? extends T> responseHandler)
255 throws IOException, ClientProtocolException;
257 /**
258 * Executes a request to the target using the given context and
259 * processes the response using the given response handler.
260 *
261 * @param target the target host for the request.
262 * Implementations may accept <code>null</code>
263 * if they can still determine a route, for example
264 * to a default target or by inspecting the request.
265 * @param request the request to execute
266 * @param responseHandler the response handler
267 * @param context the context to use for the execution, or
268 * <code>null</code> to use the default context
269 *
270 * @return the response object as generated by the response handler.
271 * @throws IOException in case of a problem or the connection was aborted
272 * @throws ClientProtocolException in case of an http protocol error
273 */
274 <T> T execute(
275 HttpHost target,
276 HttpRequest request,
277 ResponseHandler<? extends T> responseHandler,
278 HttpContext context)
279 throws IOException, ClientProtocolException;
281 }
