org.apache.http.impl.client.FutureRequestExecutionService Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of httpclient Show documentation
Show all versions of httpclient Show documentation
Apache HttpComponents Client
/*
* ====================================================================
* 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
* .
*
*/
package org.apache.http.impl.client;
import java.io.Closeable;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.Callable;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicBoolean;
import org.apache.http.annotation.ThreadSafe;
import org.apache.http.client.HttpClient;
import org.apache.http.client.ResponseHandler;
import org.apache.http.client.methods.HttpUriRequest;
import org.apache.http.client.protocol.HttpClientContext;
import org.apache.http.concurrent.FutureCallback;
import org.apache.http.protocol.HttpContext;
/**
* HttpAsyncClientWithFuture wraps calls to execute with a {@link HttpRequestFutureTask}
* and schedules them using the provided executor service. Scheduled calls may be cancelled.
* Similar to the non-blockcing HttpAsyncClient, a callback handler api is provided.
*/
@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 Executors#newFixedThreadPool(int)}
*/
public FutureRequestExecutionService(
final HttpClient httpclient,
final ExecutorService executorService) {
this.httpclient = httpclient;
this.executorService = executorService;
}
/**
* Schedule a request for execution.
*
* @param
*
* @param request
* request to execute
* @param responseHandler
* handler that will process the response.
* @return HttpAsyncClientFutureTask for the scheduled request.
* @throws InterruptedException
*/
public HttpRequestFutureTask execute(
final HttpUriRequest request,
final HttpContext context,
final ResponseHandler responseHandler) {
return execute(request, context, responseHandler, null);
}
/**
* Schedule a request for execution.
*
* @param
*
* @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 HttpRequestFutureTask execute(
final HttpUriRequest request,
final HttpContext context,
final ResponseHandler responseHandler,
final FutureCallback callback) {
if(closed.get()) {
throw new IllegalStateException("Close has been called on this httpclient instance.");
}
metrics.getScheduledConnections().incrementAndGet();
final HttpRequestTaskCallable callable = new HttpRequestTaskCallable(
httpclient, request, context, responseHandler, callback, metrics);
final HttpRequestFutureTask httpRequestFutureTask = new HttpRequestFutureTask(
request, callable);
executorService.execute(httpRequestFutureTask);
return httpRequestFutureTask;
}
/**
* Schedule multiple requests for execution.
*
* @param
*
* @param responseHandler
* handler that will process the responses.
* @param requests
* one or more requests.
* @return a list of HttpAsyncClientFutureTask for the scheduled requests.
* @throws InterruptedException
*/
public List> executeMultiple(
final ResponseHandler responseHandler,
final HttpUriRequest... requests) throws InterruptedException {
return executeMultiple(HttpClientContext.create(), responseHandler, null, -1, null, requests);
}
/**
* Schedule multiple requests for execution with a timeout.
*
* @param
*
* @param context
* optional context; use null if not needed.
* @param responseHandler
* handler that will process the responses.
* @param callback
* callback handler that will be called when requests are scheduled,
* started, completed, failed, or cancelled.
* @param timeout
* @param timeUnit
* @param requests
* one or more requests.
* @return a list of HttpAsyncClientFutureTask for the scheduled requests.
* @throws InterruptedException
*/
public List> executeMultiple(
final HttpContext context,
final ResponseHandler responseHandler,
final FutureCallback callback,
final long timeout, final TimeUnit timeUnit,
final HttpUriRequest... requests) throws InterruptedException {
metrics.getScheduledConnections().incrementAndGet();
final List> callables = new ArrayList>();
for (final HttpUriRequest request : requests) {
final HttpRequestTaskCallable callable = new HttpRequestTaskCallable(
httpclient, request, context, responseHandler, callback, metrics);
callables.add(callable);
}
if (timeout > 0) {
return executorService.invokeAll(callables, timeout, timeUnit);
} else {
return executorService.invokeAll(callables);
}
}
/**
* @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();
}
}
}