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
|
/*
* ====================================================================
* 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.impl.client;
import java.io.Closeable;
import java.io.IOException;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.atomic.AtomicBoolean;
import ch.boye.httpclientandroidlib.annotation.ThreadSafe;
import ch.boye.httpclientandroidlib.client.HttpClient;
import ch.boye.httpclientandroidlib.client.ResponseHandler;
import ch.boye.httpclientandroidlib.client.methods.HttpUriRequest;
import ch.boye.httpclientandroidlib.concurrent.FutureCallback;
import ch.boye.httpclientandroidlib.protocol.HttpContext;
/**
* HttpAsyncClientWithFuture wraps calls to execute with a {@link HttpRequestFutureTask}
* and schedules them using the provided executor service. Scheduled calls may be cancelled.
*/
@ThreadSafe
public class FutureRequestExecutionService implements Closeable {
private final HttpClient httpclient;
private final ExecutorService executorService;
private final FutureRequestExecutionMetrics metrics = new FutureRequestExecutionMetrics();
private final AtomicBoolean closed = new AtomicBoolean(false);
/**
* Create a new FutureRequestExecutionService.
*
* @param httpclient
* you should tune your httpclient instance to match your needs. You should
* align the max number of connections in the pool and the number of threads
* in the executor; it doesn't make sense to have more threads than connections
* and if you have less connections than threads, the threads will just end up
* blocking on getting a connection from the pool.
* @param executorService
* any executorService will do here. E.g.
* {@link java.util.concurrent.Executors#newFixedThreadPool(int)}
*/
public FutureRequestExecutionService(
final HttpClient httpclient,
final ExecutorService executorService) {
this.httpclient = httpclient;
this.executorService = executorService;
}
/**
* Schedule a request for execution.
*
* @param <T>
*
* @param request
* request to execute
* @param responseHandler
* handler that will process the response.
* @return HttpAsyncClientFutureTask for the scheduled request.
* @throws InterruptedException
*/
public <T> HttpRequestFutureTask<T> execute(
final HttpUriRequest request,
final HttpContext context,
final ResponseHandler<T> responseHandler) {
return execute(request, context, responseHandler, null);
}
/**
* Schedule a request for execution.
*
* @param <T>
*
* @param request
* request to execute
* @param context
* optional context; use null if not needed.
* @param responseHandler
* handler that will process the response.
* @param callback
* callback handler that will be called when the request is scheduled,
* started, completed, failed, or cancelled.
* @return HttpAsyncClientFutureTask for the scheduled request.
* @throws InterruptedException
*/
public <T> HttpRequestFutureTask<T> execute(
final HttpUriRequest request,
final HttpContext context,
final ResponseHandler<T> responseHandler,
final FutureCallback<T> callback) {
if(closed.get()) {
throw new IllegalStateException("Close has been called on this httpclient instance.");
}
metrics.getScheduledConnections().incrementAndGet();
final HttpRequestTaskCallable<T> callable = new HttpRequestTaskCallable<T>(
httpclient, request, context, responseHandler, callback, metrics);
final HttpRequestFutureTask<T> httpRequestFutureTask = new HttpRequestFutureTask<T>(
request, callable);
executorService.execute(httpRequestFutureTask);
return httpRequestFutureTask;
}
/**
* @return metrics gathered for this instance.
* @see FutureRequestExecutionMetrics
*/
public FutureRequestExecutionMetrics metrics() {
return metrics;
}
public void close() throws IOException {
closed.set(true);
executorService.shutdownNow();
if (httpclient instanceof Closeable) {
((Closeable) httpclient).close();
}
}
}
|
