Android APIs
public final class

Proxy

extends Object
java.lang.Object
   ↳ android.net.Proxy

Class Overview

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

Summary

Constants
String EXTRA_PROXY_INFO This constant was deprecated in API level 23. Because PROXY_CHANGE_ACTION is sent whenever the proxy for any network on the system changes, applications should always use getDefaultProxy() or getLinkProperties(Network).getHttpProxy() to get the proxy for the Network(s) they are using.
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
final static String getDefaultHost()
This method was deprecated in API level 11. 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.
final static int getDefaultPort()
This method was deprecated in API level 11. 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.
final static String getHost(Context ctx)
This method was deprecated in API level 11. Use standard java vm proxy values to find the host, port and exclusion list. This call ignores the exclusion list.
final static int getPort(Context ctx)
This method was deprecated in API level 11. Use standard java vm proxy values to find the host, port and exclusion list. This call ignores the exclusion list.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final String EXTRA_PROXY_INFO

Added in API level 21

This constant was deprecated in API level 23.
Because PROXY_CHANGE_ACTION is sent whenever the proxy for any network on the system changes, applications should always use getDefaultProxy() or getLinkProperties(Network).getHttpProxy() to get the proxy for the Network(s) they are using.

Intent extra included with PROXY_CHANGE_ACTION intents. It describes the new proxy being used (as a ProxyInfo object).

Constant Value: "android.intent.extra.PROXY_INFO"

public static final String PROXY_CHANGE_ACTION

Added in API level 1

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 getDefaultProxy().

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

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

Public Constructors

public Proxy ()

Added in API level 1

Public Methods

public static final String getDefaultHost ()

Added in API level 1

This method was deprecated in API level 11.
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 containing the host name or null if there is no proxy for this carrier.

public static final int getDefaultPort ()

Added in API level 1

This method was deprecated in API level 11.
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 port specified by the carrier.

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

public static final String getHost (Context ctx)

Added in API level 1

This method was deprecated in API level 11.
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 A Context used to get the settings for the proxy host.
Returns
  • 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.

public static final int getPort (Context ctx)

Added in API level 1

This method was deprecated in API level 11.
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 A Context used to get the settings for the proxy port.
Returns
  • The port number to use or -1 if no proxy is to be used.