Skip to content

Most visited

Recently visited

navigation

ProxyInfo

public class ProxyInfo
extends Object implements Parcelable

java.lang.Object
   ↳ android.net.ProxyInfo


Describes a proxy configuration. Proxy configurations are already integrated within the java.net and Apache HTTP stack. So URLConnection and Apache's HttpClient will use them automatically. Other HTTP stacks will need to obtain the proxy info from PROXY_CHANGE_ACTION broadcast as the extra EXTRA_PROXY_INFO.

Summary

Inherited constants

From interface android.os.Parcelable

Fields

public static final Creator<ProxyInfo> CREATOR

Public methods

static ProxyInfo buildDirectProxy(String host, int port, List<String> exclList)

Constructs a ProxyInfo object that points at a Direct proxy on the specified host and port.

static ProxyInfo buildDirectProxy(String host, int port)

Constructs a ProxyInfo object that points at a Direct proxy on the specified host and port.

static ProxyInfo buildPacProxy(Uri pacUri)

Construct a ProxyInfo that will download and run the PAC script at the specified URL.

boolean equals(Object o)

Indicates whether some other object is "equal to" this one.

String[] getExclusionList()

When configured to use a Direct Proxy this returns the list of hosts for which the proxy is ignored.

String getHost()

When configured to use a Direct Proxy this returns the host of the proxy.

Uri getPacFileUrl()

Returns the URL of the current PAC script or null if there is no PAC script.

int getPort()

When configured to use a Direct Proxy this returns the port of the proxy

int hashCode()

Returns a hash code value for the object.

String toString()

Returns a string representation of the object.

Inherited methods

From class java.lang.Object
From interface android.os.Parcelable

Fields

CREATOR

added in API level 21
Creator<ProxyInfo> CREATOR

Public methods

buildDirectProxy

added in API level 21
ProxyInfo buildDirectProxy (String host, 
                int port, 
                List<String> exclList)

Constructs a ProxyInfo object that points at a Direct proxy on the specified host and port. The proxy will not be used to access any host in exclusion list, exclList.

Parameters
host String
port int
exclList List: Hosts to exclude using the proxy on connections for. These hosts can use wildcards such as *.example.com.
Returns
ProxyInfo

buildDirectProxy

added in API level 21
ProxyInfo buildDirectProxy (String host, 
                int port)

Constructs a ProxyInfo object that points at a Direct proxy on the specified host and port.

Parameters
host String
port int
Returns
ProxyInfo

buildPacProxy

added in API level 21
ProxyInfo buildPacProxy (Uri pacUri)

Construct a ProxyInfo that will download and run the PAC script at the specified URL.

Parameters
pacUri Uri
Returns
ProxyInfo

equals

added in API level 21
boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Parameters
o Object: the reference object with which to compare.
Returns
boolean true if this object is the same as the obj argument; false otherwise.

getExclusionList

added in API level 21
String[] getExclusionList ()

When configured to use a Direct Proxy this returns the list of hosts for which the proxy is ignored.

Returns
String[]

getHost

added in API level 21
String getHost ()

When configured to use a Direct Proxy this returns the host of the proxy.

Returns
String

getPacFileUrl

added in API level 21
Uri getPacFileUrl ()

Returns the URL of the current PAC script or null if there is no PAC script.

Returns
Uri

getPort

added in API level 21
int getPort ()

When configured to use a Direct Proxy this returns the port of the proxy

Returns
int

hashCode

added in API level 21
int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

Returns
int a hash code value for this object.

toString

added in API level 21
String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Returns
String a string representation of the object.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.