com.sun.jersey.client.apache
Class ApacheHttpClientHandler

java.lang.Object
  extended by com.sun.jersey.api.client.TerminatingClientHandler
      extended by com.sun.jersey.client.apache.ApacheHttpClientHandler
All Implemented Interfaces:
ClientHandler

public final class ApacheHttpClientHandler
extends TerminatingClientHandler

A root handler with Jakarta Commons HttpClient acting as a backend.

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 Closeable then the instance MUST be closed after processing the entity to release connection-based resources.

If a ClientResponse is obtained and an entity is not read from the response then 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 ClientConfig.PROPERTY_CHUNKED_ENCODING_SIZE property is set to a non-null value then chunked transfer encoding is enabled.

Author:
jorgeluisw@mac.com, Paul.Sandoz@Sun.Com

Nested Class Summary
 
Nested classes/interfaces inherited from class com.sun.jersey.api.client.TerminatingClientHandler
TerminatingClientHandler.RequestEntityWriter, TerminatingClientHandler.RequestEntityWriterListener
 
Field Summary
 
Fields inherited from class com.sun.jersey.api.client.TerminatingClientHandler
EMPTY_ANNOTATIONS
 
Constructor Summary
ApacheHttpClientHandler(org.apache.commons.httpclient.HttpClient client)
          Create a new root handler with an HttpClient.
 
Method Summary
 org.apache.commons.httpclient.HttpClient getHttpClient()
          Get the HttpClient.
 ClientResponse handle(ClientRequest cr)
          Handle a HTTP request as a ClientRequest and return the HTTP response as a ClientResponse.
 
Methods inherited from class com.sun.jersey.api.client.TerminatingClientHandler
getMessageBodyWorkers, getRequestEntityWriter, headerValueToString, writeRequestEntity
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ApacheHttpClientHandler

public ApacheHttpClientHandler(org.apache.commons.httpclient.HttpClient client)
Create a new root handler with an HttpClient.

Parameters:
client - the HttpClient.
Method Detail

getHttpClient

public org.apache.commons.httpclient.HttpClient getHttpClient()
Get the HttpClient.

Returns:
the HttpClient.

handle

public ClientResponse handle(ClientRequest cr)
                      throws ClientHandlerException
Description copied from interface: ClientHandler
Handle a HTTP request as a ClientRequest and return the HTTP response as a ClientResponse.

Parameters:
cr - the HTTP request.
Returns:
the HTTP response.
Throws:
ClientHandlerException - if the client handler fails to process the request or response.


Copyright © 2013 Oracle Corporation. All Rights Reserved.