RouteTracker

java.lang.Object
- org.apache.hc.client5.http.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.hc.client5.http.RouteInfo
  RouteInfo.LayerType, RouteInfo.TunnelType

Constructor Summary

Constructors
Constructor and Description
`RouteTracker(HttpHost target, InetAddress local)` Creates a new route tracker.
`RouteTracker(HttpRoute route)` Creates a new tracker for the given route.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`clone()` Creates and returns a copy of this object.
`void`	`connectProxy(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.
`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.
`HttpHost`	`getProxyHost()` Obtains the first proxy host.
`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(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
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RouteTracker
```
public RouteTracker(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
  - clone
```
public Object clone()
             throws CloneNotSupportedException
```
    Description copied from class: Object
    Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:
    x.clone() != x
    will be true, and that the expression:
    x.clone().getClass() == x.getClass()
    will be true, but these are not absolute requirements. While it is typically the case that:
    x.clone().equals(x)
    will be true, this is not an absolute requirement.
    By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().
    By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.
    The method clone for class Object performs a specific cloning operation. First, if the class of this object does not implement the interface Cloneable, then a CloneNotSupportedException is thrown. Note that all arrays are considered to implement the interface Cloneable and that the return type of the clone method of an array type T[] is T[] where T is any reference or primitive type. Otherwise, this method creates a new instance of the class of this object and initializes all its fields with exactly the contents of the corresponding fields of this object, as if by assignment; the contents of the fields are not themselves cloned. Thus, this method performs a "shallow copy" of this object, not a "deep copy" operation.
    The class Object does not itself implement the interface Cloneable, so calling the clone method on an object whose class is Object will result in throwing an exception at run time.
    Overrides:
    
    clone in class Object
    
    Returns:
    
    a clone of this instance.
    
    Throws:
    
    CloneNotSupportedException - if the object's class does not support the Cloneable interface. Subclasses that override the clone method can also throw this exception to indicate that an instance cannot be cloned.
    
    See Also:
    
    Cloneable
  - connectProxy
```
public final void connectProxy(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
  - connectTarget
```
public final void connectTarget(boolean secure)
```
    Tracks connecting to the target.
    
    Parameters:
    
    secure - true if the route is secure, false otherwise
  - 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
    
    See Also:
    
    Object.hashCode(), HashMap
  - 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 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
  - 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
  - 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
  - getProxyHost
```
public final 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
  - getTargetHost
```
public final HttpHost getTargetHost()
```
    Description copied from interface: RouteInfo
    
    Obtains the target host.
    
    Specified by:
    
    getTargetHost in interface RouteInfo
    
    Returns:
    
    the target host
  - 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
  - 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
    
    See Also:
    
    Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)
  - isConnected
```
public final boolean isConnected()
```
  - 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
  - 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
  - layerProtocol
```
public final void layerProtocol(boolean secure)
```
    Tracks layering a protocol.
    
    Parameters:
    
    secure - true if the route is secure, false otherwise
  - reset
```
public void reset()
```
    Since:
    
    4.2
  - 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
  - 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
  - tunnelProxy
```
public final void tunnelProxy(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
  - tunnelTarget
```
public final void tunnelTarget(boolean secure)
```
    Tracks tunnelling to the target.
    
    Parameters:
    
    secure - true if the route is secure, false otherwise

Class RouteTracker

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.hc.client5.http.RouteInfo

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RouteTracker

RouteTracker

Method Detail

clone

connectProxy

connectTarget

equals

getHopCount

getHopTarget

getLayerType

getLocalAddress

getProxyHost

getTargetHost

getTunnelType

hashCode

isConnected

isLayered

isSecure

isTunnelled

layerProtocol

reset

toRoute

toString

tunnelProxy

tunnelTarget