org.robolectric.shadows.httpclient

Class DefaultRequestDirector

java.lang.Object

org.robolectric.shadows.httpclient.DefaultRequestDirector

All Implemented Interfaces:

org.apache.http.client.RequestDirector

@NotThreadSafe
public class DefaultRequestDirector
extends Object
implements org.apache.http.client.RequestDirector

Default implementation of RequestDirector.

The following parameters can be used to customize the behavior of this class:

• CoreProtocolPNames.PROTOCOL_VERSION
• CoreProtocolPNames.STRICT_TRANSFER_ENCODING
• CoreProtocolPNames.HTTP_ELEMENT_CHARSET
• CoreProtocolPNames.USE_EXPECT_CONTINUE
• CoreProtocolPNames.WAIT_FOR_CONTINUE
• CoreProtocolPNames.USER_AGENT
• CoreConnectionPNames.SOCKET_BUFFER_SIZE
• CoreConnectionPNames.MAX_LINE_LENGTH
• CoreConnectionPNames.MAX_HEADER_COUNT
• CoreConnectionPNames.SO_TIMEOUT
• CoreConnectionPNames.SO_LINGER
• CoreConnectionPNames.TCP_NODELAY
• CoreConnectionPNames.CONNECTION_TIMEOUT
• CoreConnectionPNames.STALE_CONNECTION_CHECK
• ConnRoutePNames.FORCED_ROUTE
• ConnRoutePNames.LOCAL_ADDRESS
• ConnRoutePNames.DEFAULT_PROXY
• ConnManagerPNames.TIMEOUT
• ConnManagerPNames.MAX_CONNECTIONS_PER_ROUTE
• ConnManagerPNames.MAX_TOTAL_CONNECTIONS
• org.apache.http.cookie.params.CookieSpecPNames#DATE_PATTERNS
• org.apache.http.cookie.params.CookieSpecPNames#SINGLE_COOKIE_HEADER
• org.apache.http.auth.params.AuthPNames#CREDENTIAL_CHARSET
• ClientPNames.COOKIE_POLICY
• ClientPNames.HANDLE_AUTHENTICATION
• ClientPNames.HANDLE_REDIRECTS
• ClientPNames.MAX_REDIRECTS
• ClientPNames.ALLOW_CIRCULAR_REDIRECTS
• ClientPNames.VIRTUAL_HOST
• ClientPNames.DEFAULT_HOST
• ClientPNames.DEFAULT_HEADERS

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
protected ClientConnectionManager	connManager The connection manager.
protected org.apache.http.protocol.HttpProcessor	httpProcessor The HTTP protocol processor.
protected ConnectionKeepAliveStrategy	keepAliveStrategy The keep-alive duration strategy.
protected ManagedClientConnection	managedConn The currently allocated connection.
protected HttpParams	params The HTTP parameters.
protected org.apache.http.client.AuthenticationHandler	proxyAuthHandler The proxy authentication handler.
protected org.apache.http.auth.AuthState	proxyAuthState
protected org.apache.http.client.RedirectHandler	redirectHandler The redirect handler.
protected org.apache.http.protocol.HttpRequestExecutor	requestExec The request executor.
protected org.apache.http.client.HttpRequestRetryHandler	retryHandler The request retry handler.
protected org.apache.http.ConnectionReuseStrategy	reuseStrategy The connection re-use strategy.
protected org.apache.http.conn.routing.HttpRoutePlanner	routePlanner The route planner.
protected org.apache.http.client.AuthenticationHandler	targetAuthHandler The target authentication handler.
protected org.apache.http.auth.AuthState	targetAuthState
protected org.apache.http.client.UserTokenHandler	userTokenHandler The user token handler.

Constructor Summary

Constructors

Constructor and Description
DefaultRequestDirector(org.apache.http.protocol.HttpRequestExecutor requestExec, ClientConnectionManager conman, org.apache.http.ConnectionReuseStrategy reustrat, ConnectionKeepAliveStrategy kastrat, org.apache.http.conn.routing.HttpRoutePlanner rouplan, org.apache.http.protocol.HttpProcessor httpProcessor, org.apache.http.client.HttpRequestRetryHandler retryHandler, org.apache.http.client.RedirectHandler redirectHandler, org.apache.http.client.AuthenticationHandler targetAuthHandler, org.apache.http.client.AuthenticationHandler proxyAuthHandler, org.apache.http.client.UserTokenHandler userTokenHandler, HttpParams params)
DefaultRequestDirector(org.apache.commons.logging.Log log, org.apache.http.protocol.HttpRequestExecutor requestExec, ClientConnectionManager conman, org.apache.http.ConnectionReuseStrategy reustrat, ConnectionKeepAliveStrategy kastrat, org.apache.http.conn.routing.HttpRoutePlanner rouplan, org.apache.http.protocol.HttpProcessor httpProcessor, org.apache.http.client.HttpRequestRetryHandler retryHandler, org.apache.http.client.RedirectHandler redirectHandler, org.apache.http.client.AuthenticationHandler targetAuthHandler, org.apache.http.client.AuthenticationHandler proxyAuthHandler, org.apache.http.client.UserTokenHandler userTokenHandler, HttpParams params)

Method Summary

Modifier and Type	Method and Description
protected org.apache.http.HttpRequest	createConnectRequest(org.apache.http.conn.routing.HttpRoute route, org.apache.http.protocol.HttpContext context) Creates the CONNECT request for tunnelling.
protected boolean	createTunnelToProxy(org.apache.http.conn.routing.HttpRoute route, int hop, org.apache.http.protocol.HttpContext context) Creates a tunnel to an intermediate proxy.
protected boolean	createTunnelToTarget(org.apache.http.conn.routing.HttpRoute route, org.apache.http.protocol.HttpContext context) Creates a tunnel to the target server.
protected org.apache.http.conn.routing.HttpRoute	determineRoute(org.apache.http.HttpHost target, org.apache.http.HttpRequest request, org.apache.http.protocol.HttpContext context) Determines the route for a request.
protected void	establishRoute(org.apache.http.conn.routing.HttpRoute route, org.apache.http.protocol.HttpContext context) Establishes the target route.
org.apache.http.HttpResponse	execute(org.apache.http.HttpHost target, org.apache.http.HttpRequest request, org.apache.http.protocol.HttpContext context)
protected org.apache.http.impl.client.RoutedRequest	handleResponse(org.apache.http.impl.client.RoutedRequest roureq, org.apache.http.HttpResponse response, org.apache.http.protocol.HttpContext context) Analyzes a response to check need for a followup.
protected void	releaseConnection() Returns the connection back to the connection manager and prepares for retrieving a new connection during the next request.
protected void	rewriteRequestURI(org.apache.http.impl.client.RequestWrapper request, org.apache.http.conn.routing.HttpRoute route)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

connManager

protected final ClientConnectionManager connManager

The connection manager.

routePlanner

protected final org.apache.http.conn.routing.HttpRoutePlanner routePlanner

The route planner.

reuseStrategy

protected final org.apache.http.ConnectionReuseStrategy reuseStrategy

The connection re-use strategy.

keepAliveStrategy

protected final ConnectionKeepAliveStrategy keepAliveStrategy

The keep-alive duration strategy.

requestExec

protected final org.apache.http.protocol.HttpRequestExecutor requestExec

The request executor.

httpProcessor

protected final org.apache.http.protocol.HttpProcessor httpProcessor

The HTTP protocol processor.

retryHandler

protected final org.apache.http.client.HttpRequestRetryHandler retryHandler

The request retry handler.

redirectHandler

protected final org.apache.http.client.RedirectHandler redirectHandler

The redirect handler.

targetAuthHandler

protected final org.apache.http.client.AuthenticationHandler targetAuthHandler

The target authentication handler.

proxyAuthHandler

protected final org.apache.http.client.AuthenticationHandler proxyAuthHandler

The proxy authentication handler.

userTokenHandler

protected final org.apache.http.client.UserTokenHandler userTokenHandler

The user token handler.

params

protected final HttpParams params

The HTTP parameters.

managedConn

protected ManagedClientConnection managedConn

The currently allocated connection.

targetAuthState

protected final org.apache.http.auth.AuthState targetAuthState

proxyAuthState

protected final org.apache.http.auth.AuthState proxyAuthState

Constructor Detail

DefaultRequestDirector

public DefaultRequestDirector(org.apache.commons.logging.Log log,
                              org.apache.http.protocol.HttpRequestExecutor requestExec,
                              ClientConnectionManager conman,
                              org.apache.http.ConnectionReuseStrategy reustrat,
                              ConnectionKeepAliveStrategy kastrat,
                              org.apache.http.conn.routing.HttpRoutePlanner rouplan,
                              org.apache.http.protocol.HttpProcessor httpProcessor,
                              org.apache.http.client.HttpRequestRetryHandler retryHandler,
                              org.apache.http.client.RedirectHandler redirectHandler,
                              org.apache.http.client.AuthenticationHandler targetAuthHandler,
                              org.apache.http.client.AuthenticationHandler proxyAuthHandler,
                              org.apache.http.client.UserTokenHandler userTokenHandler,
                              HttpParams params)

DefaultRequestDirector

public DefaultRequestDirector(org.apache.http.protocol.HttpRequestExecutor requestExec,
                              ClientConnectionManager conman,
                              org.apache.http.ConnectionReuseStrategy reustrat,
                              ConnectionKeepAliveStrategy kastrat,
                              org.apache.http.conn.routing.HttpRoutePlanner rouplan,
                              org.apache.http.protocol.HttpProcessor httpProcessor,
                              org.apache.http.client.HttpRequestRetryHandler retryHandler,
                              org.apache.http.client.RedirectHandler redirectHandler,
                              org.apache.http.client.AuthenticationHandler targetAuthHandler,
                              org.apache.http.client.AuthenticationHandler proxyAuthHandler,
                              org.apache.http.client.UserTokenHandler userTokenHandler,
                              HttpParams params)

Method Detail

rewriteRequestURI

protected void rewriteRequestURI(org.apache.http.impl.client.RequestWrapper request,
                                 org.apache.http.conn.routing.HttpRoute route)
                          throws org.apache.http.ProtocolException

Throws:

org.apache.http.ProtocolException

execute

public org.apache.http.HttpResponse execute(org.apache.http.HttpHost target,
                                            org.apache.http.HttpRequest request,
                                            org.apache.http.protocol.HttpContext context)
                                     throws org.apache.http.HttpException,
                                            IOException

Specified by:

execute in interface org.apache.http.client.RequestDirector

Throws:

org.apache.http.HttpException

IOException

releaseConnection

protected void releaseConnection()

Returns the connection back to the connection manager and prepares for retrieving a new connection during the next request.

determineRoute

protected org.apache.http.conn.routing.HttpRoute determineRoute(org.apache.http.HttpHost target,
                                                                org.apache.http.HttpRequest request,
                                                                org.apache.http.protocol.HttpContext context)
                                                         throws org.apache.http.HttpException

Determines the route for a request. Called by execute(org.apache.http.HttpHost, org.apache.http.HttpRequest, org.apache.http.protocol.HttpContext) to determine the route for either the original or a followup request.

Parameters:

target - the target host for the request. Implementations may accept null if they can still determine a route, for example to a default target or by inspecting the request.

request - the request to execute

context - the context to use for the execution, never null

Returns:

the route the request should take

Throws:

org.apache.http.HttpException - in case of a problem

establishRoute

protected void establishRoute(org.apache.http.conn.routing.HttpRoute route,
                              org.apache.http.protocol.HttpContext context)
                       throws org.apache.http.HttpException,
                              IOException

Establishes the target route.

Parameters:

route - the route to establish

context - the context for the request execution

Throws:

org.apache.http.HttpException - in case of a problem

IOException - in case of an IO problem

createTunnelToTarget

protected boolean createTunnelToTarget(org.apache.http.conn.routing.HttpRoute route,
                                       org.apache.http.protocol.HttpContext context)
                                throws org.apache.http.HttpException,
                                       IOException

Creates a tunnel to the target server. The connection must be established to the (last) proxy. A CONNECT request for tunnelling through the proxy will be created and sent, the response received and checked. This method does not update the connection with information about the tunnel, that is left to the caller.

Parameters:

route - the route to establish

context - the context for request execution

Returns:

true if the tunnelled route is secure, false otherwise. The implementation here always returns false, but derived classes may override.

Throws:

org.apache.http.HttpException - in case of a problem

IOException - in case of an IO problem

createTunnelToProxy

protected boolean createTunnelToProxy(org.apache.http.conn.routing.HttpRoute route,
                                      int hop,
                                      org.apache.http.protocol.HttpContext context)
                               throws org.apache.http.HttpException,
                                      IOException

Creates a tunnel to an intermediate proxy. This method is not implemented in this class. It just throws an exception here.

Parameters:

route - the route to establish

hop - the hop in the route to establish now. route.getHopTarget(hop) will return the proxy to tunnel to.

context - the context for request execution

Returns:

true if the partially tunnelled connection is secure, false otherwise.

Throws:

org.apache.http.HttpException - in case of a problem

IOException - in case of an IO problem

createConnectRequest

protected org.apache.http.HttpRequest createConnectRequest(org.apache.http.conn.routing.HttpRoute route,
                                                           org.apache.http.protocol.HttpContext context)

Creates the CONNECT request for tunnelling. Called by createTunnelToTarget.

Parameters:

route - the route to establish

context - the context for request execution

Returns:

the CONNECT request for tunnelling

handleResponse

protected org.apache.http.impl.client.RoutedRequest handleResponse(org.apache.http.impl.client.RoutedRequest roureq,
                                                                   org.apache.http.HttpResponse response,
                                                                   org.apache.http.protocol.HttpContext context)
                                                            throws org.apache.http.HttpException,
                                                                   IOException

Analyzes a response to check need for a followup.

Parameters:

roureq - the request and route.

response - the response to analayze

context - the context used for the current request execution

Returns:

the followup request and route if there is a followup, or null if the response should be returned as is

Throws:

org.apache.http.HttpException - in case of a problem

IOException - in case of an IO problem