Proxy

Kotlin |Java

public final class Proxy
extends Object

java.lang.Object
↳	android.net.Proxy

A convenience class for accessing the user and default proxy settings.

Summary

Constants
`String`	`PROXY_CHANGE_ACTION` Used to notify an app that's caching the proxy that either the default connection has changed or any connection's proxy has changed.

Public constructors
`Proxy()`

Public methods
`static String`	`getDefaultHost()` This method was deprecated in API level 15. Use standard java vm proxy values to find the host, port and exclusion list. This call ignores the exclusion list and no longer reports only mobile-data apn-based proxy values.
`static int`	`getDefaultPort()` This method was deprecated in API level 15. Use standard java vm proxy values to find the host, port and exclusion list. This call ignores the exclusion list and no longer reports only mobile-data apn-based proxy values.
`static String`	`getHost(Context ctx)` This method was deprecated in API level 15. Use standard java vm proxy values to find the host, port and exclusion list. This call ignores the exclusion list.
`static int`	`getPort(Context ctx)` This method was deprecated in API level 15. Use standard java vm proxy values to find the host, port and exclusion list. This call ignores the exclusion list.

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.

Constants

PROXY_CHANGE_ACTION

Added in API level 1

public static final String PROXY_CHANGE_ACTION

Used to notify an app that's caching the proxy that either the default connection has changed or any connection's proxy has changed. The new proxy should be queried using ConnectivityManager#getDefaultProxy().

This is a protected intent that can only be sent by the system

Constant Value: "android.intent.action.PROXY_CHANGE"

Public constructors

Proxy

public Proxy ()

Public methods

getDefaultHost

Added in API level 1
Deprecated in API level 15

public static String getDefaultHost ()

This method was deprecated in API level 15.
Use standard java vm proxy values to find the host, port and exclusion list. This call ignores the exclusion list and no longer reports only mobile-data apn-based proxy values.

Return the default proxy host specified by the carrier.

Returns
`String`	String containing the host name or null if there is no proxy for this carrier.

getDefaultPort

Added in API level 1
Deprecated in API level 15

public static int getDefaultPort ()

Return the default proxy port specified by the carrier.

Returns
`int`	The port number to be used with the proxy host or -1 if there is no proxy for this carrier.

getHost

Added in API level 1
Deprecated in API level 15

public static String getHost (Context ctx)

This method was deprecated in API level 15.
Use standard java vm proxy values to find the host, port and exclusion list. This call ignores the exclusion list.

Return the proxy host set by the user.

Parameters
`ctx`	`Context`: A Context used to get the settings for the proxy host.

Returns
`String`	String containing the host name. If the user did not set a host name it returns the default host. A null value means that no host is to be used.

getPort

Added in API level 1
Deprecated in API level 15

public static int getPort (Context ctx)

This method was deprecated in API level 15.
Use standard java vm proxy values to find the host, port and exclusion list. This call ignores the exclusion list.

Return the proxy port set by the user.

Parameters
`ctx`	`Context`: A Context used to get the settings for the proxy port.

Returns
`int`	The port number to use or -1 if no proxy is to be used.