Added in API level 21

Summary: Inherited Constants | Fields | Ctors | Methods | Inherited Methods

ProxyInfo

Kotlin |Java

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 by watching for the Proxy#PROXY_CHANGE_ACTION broadcast and calling methods such as ConnectivityManager.getDefaultProxy().

Summary

Inherited constants

From interface android.os.Parcelable

`int`	`CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int`	`PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`".

Fields
`public static final Creator<ProxyInfo>`	`CREATOR`

Public constructors
`ProxyInfo(ProxyInfo source)` A copy constructor to hold proxy properties.

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 pacUrl, int port)` Construct a `ProxyInfo` object that will download and run the PAC script at the specified URL 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.
`boolean`	`isValid()` Return true if the pattern of proxy is valid, otherwise return false.
`String`	`toString()` Returns a string representation of the object.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 21

public static final Creator<ProxyInfo> CREATOR

Public constructors

ProxyInfo

Added in API level 30

public ProxyInfo (ProxyInfo source)

A copy constructor to hold proxy properties.

Parameters
`source`	`ProxyInfo`: This value may be `null`.

Public methods

buildDirectProxy

Added in API level 21

public 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. 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

public static 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 30

public static ProxyInfo buildPacProxy (Uri pacUrl, 
                int port)

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

Parameters
`pacUrl`	`Uri`: This value cannot be `null`.
`port`	`int`

Returns
`ProxyInfo`	This value cannot be `null`.

buildPacProxy

Added in API level 21

public static 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

public 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.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
`o`	`Object`: This value may be `null`.

Returns
`boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getExclusionList

Added in API level 21

public 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

public String getHost ()

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

Returns
`String`

getPacFileUrl

Added in API level 21

public 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

public int getPort ()

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

Returns
`int`

hashCode

Added in API level 21

public 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 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 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.

Returns
`int`	a hash code value for this object.

isValid

Added in API level 30

public boolean isValid ()

Return true if the pattern of proxy is valid, otherwise return false.

Returns
`boolean`

toString

Added in API level 21

public String toString ()

Returns a string representation of the object.

Returns
`String`	a string representation of the object.