• BlackBerry Dynamics
  • Runtime library for Android applications
  • 12.0.1.79
ConnRouteParams Class Reference

An adaptor for accessing route related parameters in com.good.gd.apache.http.params.HttpParams. More...

Inheritance diagram for ConnRouteParams:
ConnRoutePNames

Description

See com.good.gd.apache.http.conn.params.ConnRoutePNames for parameter name definitions.

Author
Oleg Kalnichevski
Roland Weber
Version
Revision
658785
Since
4.0

Notice

The following notice applies to the original API on which this API is based, and to its documentation. The documentation of this API has been revised from the original.

/*
 * Copyright (C) 2006 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

Static Public Member Functions

static HttpHost getDefaultProxy (HttpParams params)
 Obtains the #DEFAULT_PROXY DEFAULT_PROXY parameter value. More...
 
static void setDefaultProxy (HttpParams params, HttpHost proxy)
 Sets the #DEFAULT_PROXY DEFAULT_PROXY parameter value. More...
 
static HttpRoute getForcedRoute (HttpParams params)
 Obtains the #FORCED_ROUTE FORCED_ROUTE parameter value. More...
 
static void setForcedRoute (HttpParams params, HttpRoute route)
 Sets the #FORCED_ROUTE FORCED_ROUTE parameter value. More...
 
static InetAddress getLocalAddress (HttpParams params)
 Obtains the #LOCAL_ADDRESS LOCAL_ADDRESS parameter value. More...
 
static void setLocalAddress (HttpParams params, InetAddress local)
 Sets the #LOCAL_ADDRESS LOCAL_ADDRESS parameter value. More...
 

Static Public Attributes

static final HttpHost NO_HOST
 A special value indicating "no host". More...
 
static final HttpRoute NO_ROUTE = new HttpRoute(NO_HOST)
 A special value indicating "no route". More...
 
- Static Public Attributes inherited from ConnRoutePNames
static final String DEFAULT_PROXY = "http.route.default-proxy"
 Parameter for the default proxy. More...
 
static final String LOCAL_ADDRESS = "http.route.local-address"
 Parameter for the local address. More...
 
static final String FORCED_ROUTE = "http.route.forced-route"
 Parameter for an forced route. More...
 

Member Function Documentation

◆ getDefaultProxy()

static HttpHost getDefaultProxy ( HttpParams  params)
static

NO_HOST will be mapped to null, to allow unsetting in a hierarchy.

Parameters
paramsthe parameters in which to look up
Returns
the default proxy set in the argument parameters, or null if not set

◆ setDefaultProxy()

static void setDefaultProxy ( HttpParams  params,
HttpHost  proxy 
)
static
Parameters
paramsthe parameters in which to set the value
proxythe value to set, may be null. Note that NO_HOST will be mapped to null by getDefaultProxy, to allow for explicit unsetting in hierarchies.

◆ getForcedRoute()

static HttpRoute getForcedRoute ( HttpParams  params)
static

NO_ROUTE will be mapped to null, to allow unsetting in a hierarchy.

Parameters
paramsthe parameters in which to look up
Returns
the forced route set in the argument parameters, or null if not set

◆ setForcedRoute()

static void setForcedRoute ( HttpParams  params,
HttpRoute  route 
)
static
Parameters
paramsthe parameters in which to set the value
routethe value to set, may be null. Note that NO_ROUTE will be mapped to null by getForcedRoute, to allow for explicit unsetting in hierarchies.

◆ getLocalAddress()

static InetAddress getLocalAddress ( HttpParams  params)
static

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
paramsthe parameters in which to look up
Returns
the local address set in the argument parameters, or null if not set

◆ setLocalAddress()

static void setLocalAddress ( HttpParams  params,
InetAddress  local 
)
static
Parameters
paramsthe parameters in which to set the value
localthe value to set, may be null

Member Data Documentation

◆ NO_HOST

final HttpHost NO_HOST
static
Initial value:
=
new HttpHost("127.0.0.255", 0, "no-host")

This relies on a nonsense scheme name to avoid conflicts with actual hosts. Note that this is a valid host.

◆ NO_ROUTE

final HttpRoute NO_ROUTE = new HttpRoute(NO_HOST)
static

This is a route with NO_HOST as the target.