Top Description Fields Constructors Methods
org.apache.http.conn.params

public Class ConnRouteParams

extends Object
implements ConnRoutePNames
Class Inheritance
All Implemented Interfaces
org.apache.http.conn.params.ConnRoutePNames
Annotations
@Deprecated
@Contract
threading:IMMUTABLE
Imports
java.net.InetAddress, org.apache.http.HttpHost, org.apache.http.annotation.Contract, .ThreadingBehavior, org.apache.http.conn.routing.HttpRoute, org.apache.http.params.HttpParams, org.apache.http.util.Args

Deprecated

(4.3) use org.apache.http.client.config.RequestConfig.

An adaptor for manipulating HTTP routing parameters in HttpParams.
Since
4.0

Field Summary

Modifier and TypeField and Description
public static final HttpHost
NO_HOST

A special value indicating "no host".

public static final HttpRoute
NO_ROUTE

A special value indicating "no route".

Constructor Summary

AccessConstructor and Description
private
ConnRouteParams()

Disabled default constructor.

Method Summary

Modifier and TypeMethod and Description
public static HttpHost

Returns:

the default proxy set in the argument parameters, or null if not set
getDefaultProxy
(final HttpParams
the parameters in which to look up
params
)

Deprecated as a consequence of HttpParams being deprecated.
Obtains the DEFAULT_PROXY parameter value.
public static HttpRoute

Returns:

the forced route set in the argument parameters, or null if not set
getForcedRoute
(final HttpParams
the parameters in which to look up
params
)

Deprecated as a consequence of HttpParams being deprecated.
Obtains the FORCED_ROUTE parameter value.
public static InetAddress

Returns:

the local address set in the argument parameters, or null if not set
getLocalAddress
(final HttpParams
the parameters in which to look up
params
)

Deprecated as a consequence of HttpParams being deprecated.
Obtains the LOCAL_ADDRESS parameter value.
public static void
setDefaultProxy(final HttpParams
the parameters in which to set the value
params
,
final HttpHost
the value to set, may be null. Note that NO_HOST will be mapped to null by getDefaultProxy, to allow for explicit unsetting in hierarchies.
proxy
)

Deprecated as a consequence of HttpParams being deprecated.
Sets the DEFAULT_PROXY parameter value.
public static void
setForcedRoute(final HttpParams
the parameters in which to set the value
params
,
final HttpRoute
the value to set, may be null. Note that NO_ROUTE will be mapped to null by getForcedRoute, to allow for explicit unsetting in hierarchies.
route
)

Deprecated as a consequence of HttpParams being deprecated.
Sets the FORCED_ROUTE parameter value.
public static void
setLocalAddress(final HttpParams
the parameters in which to set the value
params
,
final InetAddress
the value to set, may be null
local
)

Deprecated as a consequence of HttpParams being deprecated.
Sets the LOCAL_ADDRESS parameter value.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

NO_HOSTback to 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.

NO_ROUTEback to summary
public static final HttpRoute NO_ROUTE

A special value indicating "no route". This is a route with NO_HOST as the target.

Constructor Detail

ConnRouteParamsback to summary
private ConnRouteParams()

Disabled default constructor.

Method Detail

getDefaultProxyback to summary
public static HttpHost getDefaultProxy(final HttpParams params)

Deprecated

as a consequence of HttpParams being deprecated. See corresponding docs for further information.

Obtains the DEFAULT_PROXY parameter value. NO_HOST will be mapped to null, to allow unsetting in a hierarchy.

Parameters
params:HttpParams

the parameters in which to look up

Returns:HttpHost

the default proxy set in the argument parameters, or null if not set

getForcedRouteback to summary
public static HttpRoute getForcedRoute(final HttpParams params)

Deprecated

as a consequence of HttpParams being deprecated. See corresponding docs for further information.

Obtains the FORCED_ROUTE parameter value. NO_ROUTE will be mapped to null, to allow unsetting in a hierarchy.

Parameters
params:HttpParams

the parameters in which to look up

Returns:HttpRoute

the forced route set in the argument parameters, or null if not set

getLocalAddressback to summary
public static InetAddress getLocalAddress(final HttpParams params)

Deprecated

as a consequence of HttpParams being deprecated. See corresponding docs for further information.

Obtains the 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.

Parameters
params:HttpParams

the parameters in which to look up

Returns:InetAddress

the local address set in the argument parameters, or null if not set

setDefaultProxyback to summary
public static void setDefaultProxy(final HttpParams params, final HttpHost proxy)

Deprecated

as a consequence of HttpParams being deprecated. See corresponding docs for further information.

Sets the DEFAULT_PROXY parameter value.

Parameters
params:HttpParams

the parameters in which to set the value

proxy:HttpHost

the value to set, may be null. Note that NO_HOST will be mapped to null by getDefaultProxy, to allow for explicit unsetting in hierarchies.

setForcedRouteback to summary
public static void setForcedRoute(final HttpParams params, final HttpRoute route)

Deprecated

as a consequence of HttpParams being deprecated. See corresponding docs for further information.

Sets the FORCED_ROUTE parameter value.

Parameters
params:HttpParams

the parameters in which to set the value

route:HttpRoute

the value to set, may be null. Note that NO_ROUTE will be mapped to null by getForcedRoute, to allow for explicit unsetting in hierarchies.

setLocalAddressback to summary
public static void setLocalAddress(final HttpParams params, final InetAddress local)

Deprecated

as a consequence of HttpParams being deprecated. See corresponding docs for further information.

Sets the LOCAL_ADDRESS parameter value.

Parameters
params:HttpParams

the parameters in which to set the value

local:InetAddress

the value to set, may be null