* Client operations are thread safe, the HTTP connection may * be shared between different threads. *
* If a response entity is obtained that is an instance of {@link Closeable} * then the instance MUST be closed after processing the entity to release * connection-based resources. *
* If a {@link ClientResponse} is obtained and an entity is not read from the * response then {@link ClientResponse#close() } MUST be called after processing * the response to release connection-based resources. *
* The following methods are currently supported: HEAD, GET, POST, PUT, DELETE * and OPTIONS. *
* Chunked transfer encoding can be enabled or disabled but configuration of
* the chunked encoding size is not possible. If the
* {@link ClientConfig#PROPERTY_CHUNKED_ENCODING_SIZE} property is set
* to a non-null value then chunked transfer encoding is enabled.
*
* @author jorgeluisw@mac.com
* @author Paul.Sandoz@Sun.Com
* @author pavel.bucek@oracle.com
*/
public final class ApacheHttpClient4Handler extends TerminatingClientHandler {
private final HttpClient client;
private final CookieStore cookieStore;
private final boolean preemptiveBasicAuth;
private final boolean perTreadCookieStore;
/**
* Create a new root handler with an {@link HttpClient}.
*
* @param client the {@link HttpClient}.
* @param cookieStore {@link CookieStore} instance
* @param preemptiveBasicAuth turns on preemptive basic authentication
*/
public ApacheHttpClient4Handler(final HttpClient client,
final CookieStore cookieStore,
final boolean preemptiveBasicAuth,
final boolean perTreadCookieStore) {
this.client = client;
this.cookieStore = cookieStore;
this.preemptiveBasicAuth = preemptiveBasicAuth;
this.perTreadCookieStore = perTreadCookieStore;
}
/**
* Get the {@link HttpClient}.
*
* @return the {@link HttpClient}.
*/
public HttpClient getHttpClient() {
return client;
}
/**
* Get the {@link CookieStore}.
*
* @return the {@link CookieStore} instance or null when
* ApacheHttpClient4Config.PROPERTY_DISABLE_COOKIES set to true.
*/
public CookieStore getCookieStore() {
return cookieStore;
}
public ClientResponse handle(final ClientRequest cr)
throws ClientHandlerException {
final HttpUriRequest request = getUriHttpRequest(cr);
writeOutBoundHeaders(cr.getHeaders(), request);
try {
HttpResponse response;
if(preemptiveBasicAuth) {
AuthCache authCache = new BasicAuthCache();
BasicScheme basicScheme = new BasicScheme();
authCache.put(getHost(request), basicScheme);
BasicHttpContext localContext = new BasicHttpContext();
localContext.setAttribute(ClientContext.AUTH_CACHE, authCache);
// Keep the cookie store isolated to current thread - see http://hc.apache.org/httpcomponents-client-ga/tutorial/html/statemgmt.html#d5e849
if(perTreadCookieStore){
response = getHttpClient().execute(getHost(request), request, setBasicCookieStoreContext(newLocalContext));
} else {
response = getHttpClient().execute(getHost(request), request, localContext);
}
} else if(perTreadCookieStore){
BasicHttpContext newLocalContext = new BasicHttpContext();
response = getHttpClient().execute(getHost(request), request, setBasicCookieStoreContext(newLocalContext));
} else {
response = getHttpClient().execute(getHost(request), request);
}
ClientResponse r = new ClientResponse(response.getStatusLine().getStatusCode(),
getInBoundHeaders(response),
new HttpClientResponseInputStream(response),
getMessageBodyWorkers());
if (!r.hasEntity()) {
r.bufferEntity();
r.close();
}
return r;
} catch (Exception e) {
throw new ClientHandlerException(e);
}
}
private void setBasicCookieStoreContext(BasicHttpContext newLocalContext){
BasicCookieStore basicCookieStore = new BasicCookieStore();
newLocalContext.setAttribute(ClientContext.COOKIE_STORE,basicCookieStore);
newLocalContext.setAttribute(org.apache.http.client.params.ClientPNames.COOKIE_POLICY, CookiePolicy.BEST_MATCH);
}
private HttpHost getHost(final HttpUriRequest request) {
return new HttpHost(request.getURI().getHost(), request.getURI().getPort(), request.getURI().getScheme());
}
private HttpUriRequest getUriHttpRequest(final ClientRequest cr) {
final String strMethod = cr.getMethod();
final URI uri = cr.getURI();
final HttpEntity entity = getHttpEntity(cr);
final HttpUriRequest request;
if (strMethod.equals("GET")) {
request = new HttpGet(uri);
} else if (strMethod.equals("POST")) {
request = new HttpPost(uri);
} else if (strMethod.equals("PUT")) {
request = new HttpPut(uri);
} else if (strMethod.equals("DELETE")) {
request = new HttpDelete(uri);
} else if (strMethod.equals("HEAD")) {
request = new HttpHead(uri);
} else if (strMethod.equals("OPTIONS")) {
request = new HttpOptions(uri);
} else {
request = new HttpEntityEnclosingRequestBase() {
@Override
public String getMethod() {
return strMethod;
}
@Override
public URI getURI() {
return uri;
}
};
}
if(entity != null && request instanceof HttpEntityEnclosingRequestBase) {
((HttpEntityEnclosingRequestBase) request).setEntity(entity);
} else if (entity != null) {
throw new ClientHandlerException("Adding entity to http method " + cr.getMethod() + " is not supported.");
}
return request;
}
private HttpEntity getHttpEntity(final ClientRequest cr) {
final Object entity = cr.getEntity();
if(entity == null)
return null;
final RequestEntityWriter requestEntityWriter = getRequestEntityWriter(cr);
try {
HttpEntity httpEntity = new AbstractHttpEntity() {
@Override
public boolean isRepeatable() {
return false;
}
@Override
public long getContentLength() {
return requestEntityWriter.getSize();
}
@Override
public InputStream getContent() throws IOException, IllegalStateException {
return null;
}
@Override
public void writeTo(OutputStream outputStream) throws IOException {
requestEntityWriter.writeRequestEntity(outputStream);
}
@Override
public boolean isStreaming() {
return false;
}
};
if(cr.getProperties().get(ClientConfig.PROPERTY_CHUNKED_ENCODING_SIZE) != null) {
// TODO return InputStreamEntity
return httpEntity;
} else {
return new BufferedHttpEntity(httpEntity);
}
} catch (Exception ex) {
// TODO warning/error?
}
return null;
}
private void writeOutBoundHeaders(final MultivaluedMap