Top Description Methods
org.apache.hc.client5.http.routing

public Interface HttpRoutePlanner

Known Direct Implementers
org.apache.hc.client5.http.impl.routing.DefaultRoutePlanner
Annotations
@Contract
threading:STATELESS
Imports
org.apache.hc.client5.http.HttpRoute, org.apache.hc.core5.annotation.Contract, .ThreadingBehavior, org.apache.hc.core5.http.HttpException, .HttpHost, org.apache.hc.core5.http.protocol.HttpContext

Encapsulates logic to compute a HttpRoute to a target host. Implementations may for example be based on parameters, or on the standard Java system properties.

Implementations of this interface must be thread-safe. Access to shared data must be synchronized as methods of this interface may be executed from multiple threads.

Since
4.0

Method Summary

Modifier and TypeMethod and Description
public HttpRoute

Returns:

the route that the request should take
determineRoute
(HttpHost
the target host for the request.
target
,
HttpContext
the context to use for the subsequent execution. Implementations may accept null.
context
)

Determines the route for the given host.

Method Detail

determineRouteback to summary
public HttpRoute determineRoute(HttpHost target, HttpContext context) throws HttpException

Determines the route for the given host.

Parameters
target:HttpHost

the target host for the request.

context:HttpContext

the context to use for the subsequent execution. Implementations may accept null.

Returns:HttpRoute

the route that the request should take

Exceptions
HttpException:
in case of a problem