org.apache.http.impl.client.DecompressingHttpClient 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
HttpComponents Client (base module)
/*
* ====================================================================
* 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
* Decorator adding support for compressed responses. This class sets
* the Accept-Encoding header on requests to indicate
* support for the gzip and deflate
* compression schemes; it then checks the Content-Encoding
* header on the response to uncompress any compressed response bodies.
* The {@link java.io.InputStream} of the entity will contain the uncompressed
* content.
*
* N.B. Any upstream clients of this class need to be aware that
* this effectively obscures visibility into the length of a server
* response body, since the Content-Length header will
* correspond to the compressed entity length received from the server,
* but the content length experienced by reading the response body may
* be different (hopefully higher!).
*
* That said, this decorator is compatible with the
* CachingHttpClient in that the two decorators can be added
* in either order and still have cacheable responses be cached.
*
* @since 4.2
*/
public class DecompressingHttpClient implements HttpClient {
private HttpClient backend;
private HttpRequestInterceptor acceptEncodingInterceptor;
private HttpResponseInterceptor contentEncodingInterceptor;
/**
* Constructs a decorator to ask for and handle compressed
* entities on the fly.
* @param backend the {@link HttpClient} to use for actually
* issuing requests
*/
public DecompressingHttpClient(HttpClient backend) {
this(backend, new RequestAcceptEncoding(), new ResponseContentEncoding());
}
DecompressingHttpClient(HttpClient backend,
HttpRequestInterceptor requestInterceptor,
HttpResponseInterceptor responseInterceptor) {
this.backend = backend;
this.acceptEncodingInterceptor = requestInterceptor;
this.contentEncodingInterceptor = responseInterceptor;
}
public HttpParams getParams() {
return backend.getParams();
}
public ClientConnectionManager getConnectionManager() {
return backend.getConnectionManager();
}
public HttpResponse execute(HttpUriRequest request) throws IOException,
ClientProtocolException {
return execute(getHttpHost(request), request, (HttpContext)null);
}
HttpHost getHttpHost(HttpUriRequest request) {
URI uri = request.getURI();
return URIUtils.extractHost(uri);
}
public HttpResponse execute(HttpUriRequest request, HttpContext context)
throws IOException, ClientProtocolException {
return execute(getHttpHost(request), request, context);
}
public HttpResponse execute(HttpHost target, HttpRequest request)
throws IOException, ClientProtocolException {
return execute(target, request, (HttpContext)null);
}
public HttpResponse execute(HttpHost target, HttpRequest request,
HttpContext context) throws IOException, ClientProtocolException {
try {
if (context == null) context = new BasicHttpContext();
HttpRequest wrapped;
if (request instanceof HttpEntityEnclosingRequest) {
wrapped = new EntityEnclosingRequestWrapper((HttpEntityEnclosingRequest) request);
} else {
wrapped = new RequestWrapper(request);
}
acceptEncodingInterceptor.process(wrapped, context);
HttpResponse response = backend.execute(target, wrapped, context);
try {
contentEncodingInterceptor.process(response, context);
if (Boolean.TRUE.equals(context.getAttribute(ResponseContentEncoding.UNCOMPRESSED))) {
response.removeHeaders("Content-Length");
response.removeHeaders("Content-Encoding");
response.removeHeaders("Content-MD5");
}
return response;
} catch (HttpException ex) {
EntityUtils.consume(response.getEntity());
throw ex;
} catch (IOException ex) {
EntityUtils.consume(response.getEntity());
throw ex;
} catch (RuntimeException ex) {
EntityUtils.consume(response.getEntity());
throw ex;
}
} catch (HttpException e) {
throw new ClientProtocolException(e);
}
}
public T execute(HttpUriRequest request,
ResponseHandler responseHandler) throws IOException,
ClientProtocolException {
return execute(getHttpHost(request), request, responseHandler);
}
public T execute(HttpUriRequest request,
ResponseHandler responseHandler, HttpContext context)
throws IOException, ClientProtocolException {
return execute(getHttpHost(request), request, responseHandler, context);
}
public T execute(HttpHost target, HttpRequest request,
ResponseHandler responseHandler) throws IOException,
ClientProtocolException {
return execute(target, request, responseHandler, null);
}
public T execute(HttpHost target, HttpRequest request,
ResponseHandler responseHandler, HttpContext context)
throws IOException, ClientProtocolException {
HttpResponse response = execute(target, request, context);
try {
return responseHandler.handleResponse(response);
} finally {
HttpEntity entity = response.getEntity();
if (entity != null) EntityUtils.consume(entity);
}
}
}