ProxyInfo
open class ProxyInfo : Parcelable
| kotlin.Any | |
| ↳ | 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 android.net.ConnectivityManager#getDefaultProxy.
Summary
| Inherited constants | |
|---|---|
| Public constructors | |
|---|---|
|
A copy constructor to hold proxy properties. |
|
| Public methods | |
|---|---|
| open static ProxyInfo! |
buildDirectProxy(host: String!, port: Int)Constructs a |
| open static ProxyInfo! |
buildDirectProxy(host: String!, port: Int, exclList: MutableList<String!>!)Constructs a |
| open static ProxyInfo! |
buildPacProxy(pacUri: Uri!)Construct a |
| open static ProxyInfo |
buildPacProxy(pacUrl: Uri, port: Int)Construct a |
| open Int |
Implement the Parcelable interface |
| open Boolean |
Indicates whether some other object is "equal to" this one. |
| open Array<String!>! |
When configured to use a Direct Proxy this returns the list of hosts for which the proxy is ignored. |
| open String! |
getHost()When configured to use a Direct Proxy this returns the host of the proxy. |
| open Uri! |
Returns the URL of the current PAC script or null if there is no PAC script. |
| open Int |
getPort()When configured to use a Direct Proxy this returns the port of the proxy |
| open Int |
hashCode()Returns a hash code value for the object. |
| open Boolean |
isValid()Return true if the pattern of proxy is valid, otherwise return false. |
| open String |
toString()Returns a string representation of the object. |
| open Unit |
writeToParcel(dest: Parcel, flags: Int)Implement the Parcelable interface. |
| Properties | |
|---|---|
| static Parcelable.Creator<ProxyInfo!> | |
Public constructors
ProxyInfo
ProxyInfo(source: ProxyInfo?)
A copy constructor to hold proxy properties.
| Parameters | |
|---|---|
source |
ProxyInfo?: This value may be null. |
Public methods
buildDirectProxy
open static fun buildDirectProxy(
host: String!,
port: Int
): ProxyInfo!
Constructs a ProxyInfo object that points at a Direct proxy on the specified host and port.
buildDirectProxy
open static fun buildDirectProxy(
host: String!,
port: Int,
exclList: MutableList<String!>!
): ProxyInfo!
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 | |
|---|---|
exclList |
MutableList<String!>!: Hosts to exclude using the proxy on connections for. These hosts can use wildcards such as *.example.com. |
buildPacProxy
open static fun buildPacProxy(pacUri: Uri!): ProxyInfo!
Construct a ProxyInfo that will download and run the PAC script at the specified URL.
buildPacProxy
open static fun buildPacProxy(
pacUrl: Uri,
port: Int
): ProxyInfo
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. |
| Return | |
|---|---|
ProxyInfo |
This value cannot be null. |
describeContents
open fun describeContents(): Int
Implement the Parcelable interface
| Return | |
|---|---|
Int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or
|
equals
open fun equals(other: Any?): Boolean
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 returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
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 | |
|---|---|
obj |
the reference object with which to compare. |
o |
This value may be null. |
| Return | |
|---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
getExclusionList
open fun getExclusionList(): Array<String!>!
When configured to use a Direct Proxy this returns the list of hosts for which the proxy is ignored.
getHost
open fun getHost(): String!
When configured to use a Direct Proxy this returns the host of the proxy.
getPacFileUrl
open fun getPacFileUrl(): Uri!
Returns the URL of the current PAC script or null if there is no PAC script.
getPort
open fun getPort(): Int
When configured to use a Direct Proxy this returns the port of the proxy
hashCode
open fun hashCode(): Int
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.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
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons 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
equalsmethod, then calling thehashCodemethod 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
equalsmethod, then calling thehashCodemethod 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.
| Return | |
|---|---|
Int |
a hash code value for this object. |
isValid
open fun isValid(): Boolean
Return true if the pattern of proxy is valid, otherwise return false.
toString
open fun toString(): String
Returns a string representation of the object.
| Return | |
|---|---|
String |
a string representation of the object. |
writeToParcel
open fun writeToParcel(
dest: Parcel,
flags: Int
): Unit
Implement the Parcelable interface.
| Parameters | |
|---|---|
dest |
Parcel: The Parcel in which the object should be written. This value cannot be null. |
flags |
Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following:
|