FileDocCategorySizeDatePackage
ConnRouteParams.javaAPI DocAndroid 1.5 API7198Wed May 06 22:41:10 BST 2009org.apache.http.conn.params

ConnRouteParams

public class ConnRouteParams extends Object implements ConnRoutePNames
An adaptor for accessing route related parameters in {@link HttpParams}. See {@link ConnRoutePNames} for parameter name definitions.
author
Oleg Kalnichevski
author
Roland Weber
version
$Revision: 658785 $
since
4.0

Fields Summary
public static final HttpHost
NO_HOST
A special value indicating "no host". This relies on a nonsense scheme name to avoid conflicts with actual hosts. Note that this is a valid host.
public static final HttpRoute
NO_ROUTE
A special value indicating "no route". This is a route with {@link #NO_HOST} as the target.
Constructors Summary
private ConnRouteParams()
Disabled default constructor.



        
      
        // no body
    
Methods Summary
public static org.apache.http.HttpHostgetDefaultProxy(org.apache.http.params.HttpParams params)
Obtains the {@link ConnRoutePNames#DEFAULT_PROXY DEFAULT_PROXY} parameter value. {@link #NO_HOST} will be mapped to null, to allow unsetting in a hierarchy.

param
params the parameters in which to look up
return
the default proxy set in the argument parameters, or null if not set

        if (params == null) {
            throw new IllegalArgumentException("Parameters must not be null.");
        }
        HttpHost proxy = (HttpHost)
            params.getParameter(DEFAULT_PROXY);
        if ((proxy != null) && NO_HOST.equals(proxy)) {
            // value is explicitly unset
            proxy = null;
        }
        return proxy;
    
public static org.apache.http.conn.routing.HttpRoutegetForcedRoute(org.apache.http.params.HttpParams params)
Obtains the {@link ConnRoutePNames#FORCED_ROUTE FORCED_ROUTE} parameter value. {@link #NO_ROUTE} will be mapped to null, to allow unsetting in a hierarchy.

param
params the parameters in which to look up
return
the forced route set in the argument parameters, or null if not set

        if (params == null) {
            throw new IllegalArgumentException("Parameters must not be null.");
        }
        HttpRoute route = (HttpRoute)
            params.getParameter(FORCED_ROUTE);
        if ((route != null) && NO_ROUTE.equals(route)) {
            // value is explicitly unset
            route = null;
        }
        return route;
    
public static java.net.InetAddressgetLocalAddress(org.apache.http.params.HttpParams params)
Obtains the {@link ConnRoutePNames#LOCAL_ADDRESS LOCAL_ADDRESS} parameter value. There is no special value that would automatically be mapped to null. You can use the wildcard address (0.0.0.0 for IPv4, :: for IPv6) to override a specific local address in a hierarchy.

param
params the parameters in which to look up
return
the local address set in the argument parameters, or null if not set

        if (params == null) {
            throw new IllegalArgumentException("Parameters must not be null.");
        }
        InetAddress local = (InetAddress)
            params.getParameter(LOCAL_ADDRESS);
        // no explicit unsetting
        return local;
    
public static voidsetDefaultProxy(org.apache.http.params.HttpParams params, org.apache.http.HttpHost proxy)
Sets the {@link ConnRoutePNames#DEFAULT_PROXY DEFAULT_PROXY} parameter value.

param
params the parameters in which to set the value
param
proxy the value to set, may be null. Note that {@link #NO_HOST} will be mapped to null by {@link #getDefaultProxy}, to allow for explicit unsetting in hierarchies.

        if (params == null) {
            throw new IllegalArgumentException("Parameters must not be null.");
        }
        params.setParameter(DEFAULT_PROXY, proxy);
    
public static voidsetForcedRoute(org.apache.http.params.HttpParams params, org.apache.http.conn.routing.HttpRoute route)
Sets the {@link ConnRoutePNames#FORCED_ROUTE FORCED_ROUTE} parameter value.

param
params the parameters in which to set the value
param
route the value to set, may be null. Note that {@link #NO_ROUTE} will be mapped to null by {@link #getForcedRoute}, to allow for explicit unsetting in hierarchies.

        if (params == null) {
            throw new IllegalArgumentException("Parameters must not be null.");
        }
        params.setParameter(FORCED_ROUTE, route);
    
public static voidsetLocalAddress(org.apache.http.params.HttpParams params, java.net.InetAddress local)
Sets the {@link ConnRoutePNames#LOCAL_ADDRESS LOCAL_ADDRESS} parameter value.

param
params the parameters in which to set the value
param
local the value to set, may be null

        if (params == null) {
            throw new IllegalArgumentException("Parameters must not be null.");
        }
        params.setParameter(LOCAL_ADDRESS, local);