org.apache.http.conn.routing
Class RouteTracker

java.lang.Object
  org.apache.http.conn.routing.RouteTracker

All Implemented Interfaces:

Cloneable, RouteInfo

public final class RouteTracker
extends Object
implements RouteInfo, Cloneable

Helps tracking the steps in establishing a route.

Since:

4.0

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.http.conn.routing.RouteInfo

RouteInfo.LayerType, RouteInfo.TunnelType

Constructor Summary

RouteTracker(org.apache.http.HttpHost target, InetAddress local)
Creates a new route tracker.

RouteTracker(HttpRoute route)
Creates a new tracker for the given route.

Method Summary

Object	clone()
void	connectProxy(org.apache.http.HttpHost proxy, boolean secure) Tracks connecting to the first proxy.
void	connectTarget(boolean secure) Tracks connecting to the target.
boolean	equals(Object o) Compares this tracked route to another.
int	getHopCount() Obtains the number of hops in this route.
org.apache.http.HttpHost	getHopTarget(int hop) Obtains the target of a hop in this route.
RouteInfo.LayerType	getLayerType() Obtains the layering type of this route.
InetAddress	getLocalAddress() Obtains the local address to connect from.
org.apache.http.HttpHost	getProxyHost() Obtains the first proxy host.
org.apache.http.HttpHost	getTargetHost() Obtains the target host.
RouteInfo.TunnelType	getTunnelType() Obtains the tunnel type of this route.
int	hashCode() Generates a hash code for this tracked route.
boolean	isConnected()
boolean	isLayered() Checks whether this route includes a layered protocol.
boolean	isSecure() Checks whether this route is secure.
boolean	isTunnelled() Checks whether this route is tunnelled through a proxy.
void	layerProtocol(boolean secure) Tracks layering a protocol.
void	reset()
HttpRoute	toRoute() Obtains the tracked route.
String	toString() Obtains a description of the tracked route.
void	tunnelProxy(org.apache.http.HttpHost proxy, boolean secure) Tracks tunnelling to a proxy in a proxy chain.
void	tunnelTarget(boolean secure) Tracks tunnelling to the target.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RouteTracker

public RouteTracker(org.apache.http.HttpHost target,
                    InetAddress local)

Creates a new route tracker. The target and origin need to be specified at creation time.

Parameters:

target - the host to which to route

local - the local address to route from, or null for the default

RouteTracker

public RouteTracker(HttpRoute route)

Creates a new tracker for the given route. Only target and origin are taken from the route, everything else remains to be tracked.

Parameters:

route - the route to track

Method Detail

reset

public void reset()

Since:

4.2

connectTarget

public final void connectTarget(boolean secure)

Tracks connecting to the target.

Parameters:

secure - true if the route is secure, false otherwise

connectProxy

public final void connectProxy(org.apache.http.HttpHost proxy,
                               boolean secure)

Tracks connecting to the first proxy.

Parameters:

proxy - the proxy connected to

secure - true if the route is secure, false otherwise

tunnelTarget

public final void tunnelTarget(boolean secure)

Tracks tunnelling to the target.

Parameters:

secure - true if the route is secure, false otherwise

tunnelProxy

public final void tunnelProxy(org.apache.http.HttpHost proxy,
                              boolean secure)

Tracks tunnelling to a proxy in a proxy chain. This will extend the tracked proxy chain, but it does not mark the route as tunnelled. Only end-to-end tunnels are considered there.

Parameters:

proxy - the proxy tunnelled to

secure - true if the route is secure, false otherwise

layerProtocol

public final void layerProtocol(boolean secure)

Tracks layering a protocol.

Parameters:

secure - true if the route is secure, false otherwise

getTargetHost

public final org.apache.http.HttpHost getTargetHost()

Description copied from interface: RouteInfo

Obtains the target host.

Specified by:

getTargetHost in interface RouteInfo

Returns:

the target host

getLocalAddress

public final InetAddress getLocalAddress()

Description copied from interface: RouteInfo

Obtains the local address to connect from.

Specified by:

getLocalAddress in interface RouteInfo

Returns:

the local address, or null

getHopCount

public final int getHopCount()

Description copied from interface: RouteInfo

Obtains the number of hops in this route. A direct route has one hop. A route through a proxy has two hops. A route through a chain of n proxies has n+1 hops.

Specified by:

getHopCount in interface RouteInfo

Returns:

the number of hops in this route

getHopTarget

public final org.apache.http.HttpHost getHopTarget(int hop)

Description copied from interface: RouteInfo

Obtains the target of a hop in this route. The target of the last hop is the target host, the target of previous hops is the respective proxy in the chain. For a route through exactly one proxy, target of hop 0 is the proxy and target of hop 1 is the target host.

Specified by:

getHopTarget in interface RouteInfo

Parameters:

hop - index of the hop for which to get the target, 0 for first

Returns:

the target of the given hop

getProxyHost

public final org.apache.http.HttpHost getProxyHost()

Description copied from interface: RouteInfo

Obtains the first proxy host.

Specified by:

getProxyHost in interface RouteInfo

Returns:

the first proxy in the proxy chain, or null if this route is direct

isConnected

public final boolean isConnected()

getTunnelType

public final RouteInfo.TunnelType getTunnelType()

Description copied from interface: RouteInfo

Obtains the tunnel type of this route. If there is a proxy chain, only end-to-end tunnels are considered.

Specified by:

getTunnelType in interface RouteInfo

Returns:

the tunnelling type

isTunnelled

public final boolean isTunnelled()

Description copied from interface: RouteInfo

Checks whether this route is tunnelled through a proxy. If there is a proxy chain, only end-to-end tunnels are considered.

Specified by:

isTunnelled in interface RouteInfo

Returns:

true if tunnelled end-to-end through at least one proxy, false otherwise

getLayerType

public final RouteInfo.LayerType getLayerType()

Description copied from interface: RouteInfo

Obtains the layering type of this route. In the presence of proxies, only layering over an end-to-end tunnel is considered.

Specified by:

getLayerType in interface RouteInfo

Returns:

the layering type

isLayered

public final boolean isLayered()

Description copied from interface: RouteInfo

Checks whether this route includes a layered protocol. In the presence of proxies, only layering over an end-to-end tunnel is considered.

Specified by:

isLayered in interface RouteInfo

Returns:

true if layered, false otherwise

isSecure

public final boolean isSecure()

Description copied from interface: RouteInfo

Checks whether this route is secure.

Specified by:

isSecure in interface RouteInfo

Returns:

true if secure, false otherwise

toRoute

public final HttpRoute toRoute()

Obtains the tracked route. If a route has been tracked, it is connected. If not connected, nothing has been tracked so far.

Returns:

the tracked route, or null if nothing has been tracked so far

equals

public final boolean equals(Object o)

Compares this tracked route to another.

Overrides:

equals in class Object

Parameters:

o - the object to compare with

Returns:

true if the argument is the same tracked route, false

hashCode

public final int hashCode()

Generates a hash code for this tracked route. Route trackers are modifiable and should therefore not be used as lookup keys. Use toRoute to obtain an unmodifiable representation of the tracked route.

Overrides:

hashCode in class Object

Returns:

the hash code

toString

public final String toString()

Obtains a description of the tracked route.

Overrides:

toString in class Object

Returns:

a human-readable representation of the tracked route

clone

public Object clone()
             throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException