Since: API level 17
public class

ProxyProperties

extends Object
implements Parcelable
java.lang.Object
   ↳ com.samsung.android.knox.net.ProxyProperties

Class Overview

This class is used to encapsulate a proxy information to be used in the Global Proxy policy.

Since
API level 17
MDM 5.5

Summary

[Expand]
Inherited Constants
From interface android.os.Parcelable
Public Constructors
ProxyProperties()
Creates a ProxyProperties instance.
Public Methods
List<AuthConfig> getAuthConfigList()
Used to retrieve the authentication configuration (username and password) that is used to authenticate in the related proxy.
List<String> getExclusionList()
Get the exclusion list of the proxy.
String getHostname()
Get the hostname or ip address of the proxy.
String getPacFileUrl()
Used to retrieve the URL used in a PAC based proxy configuration.
int getPortNumber()
Get the port number of the proxy.
void setAuthConfigList(List<AuthConfig> authConfigList)
Set the authentication configuration (username and password) that shall be used to authenticate in the related proxy.
void setExclusionList(List<String> exclusionList)
Set the exclusion list of the proxy.
void setHostname(String hostname)
Set the hostname or ip address of the proxy.
void setPacFileUrl(String pacFileUrl)
Set the URL to be used in a PAC based proxy configuration.
void setPortNumber(int portNumber)
Set the port number of the proxy.
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.os.Parcelable

Public Constructors

public ProxyProperties ()

Since: API level 17

Creates a ProxyProperties instance.

Since
API level 17
MDM 5.5

Public Methods

public List<AuthConfig> getAuthConfigList ()

Since: API level 20

Used to retrieve the authentication configuration (username and password) that is used to authenticate in the related proxy.

Returns
  • List of authentication configuration by proxy.
Since
API level 20
MDM 5.7

public List<String> getExclusionList ()

Since: API level 17

Get the exclusion list of the proxy.

Returns
  • The exclusion list of the proxy.
Since
API level 17
MDM 5.5

public String getHostname ()

Since: API level 17

Get the hostname or ip address of the proxy.

Returns
  • The hostname of the proxy.
Since
API level 17
MDM 5.5

public String getPacFileUrl ()

Since: API level 20

Used to retrieve the URL used in a PAC based proxy configuration.

Returns
  • The server URL containing the PAC file.
Since
API level 20
MDM 5.7

public int getPortNumber ()

Since: API level 17

Get the port number of the proxy.

Returns
  • The port number of the proxy.
Since
API level 17
MDM 5.5

public void setAuthConfigList (List<AuthConfig> authConfigList)

Since: API level 20

Set the authentication configuration (username and password) that shall be used to authenticate in the related proxy.

This setter is not mandatory when setting up a proxy and it will only be used if the configured proxy supports authentication.

Parameters
authConfigList List of authentication configuration by proxy.
Since
API level 20
MDM 5.7

public void setExclusionList (List<String> exclusionList)

Since: API level 17

Set the exclusion list of the proxy.

This setter is used only when configuring a static proxy and cannot be used in conjunction with setPacFileUrl(String), otherwise this configuration will simply be ignored when calling setGlobalProxy(ProxyProperties).

Parameters
exclusionList The exclusion list to be set.
Since
API level 17
MDM 5.5

public void setHostname (String hostname)

Since: API level 17

Set the hostname or ip address of the proxy.

This setter is used only when configuring a static proxy and cannot be used in conjunction with setPacFileUrl(String), otherwise calling setGlobalProxy(ProxyProperties) will fail.

Parameters
hostname The hostname to be set. Can be an ip address (IPv4) or a hostname address.
Since
API level 17
MDM 5.5

public void setPacFileUrl (String pacFileUrl)

Since: API level 20

Set the URL to be used in a PAC based proxy configuration.

This setter is used only when configuring an automatic proxy (PAC) and cannot be used in conjunction with setHostname(String) and setPortNumber(int), otherwise calling setGlobalProxy(ProxyProperties) will fail.

Parameters
pacFileUrl The server URL containing the PAC file.
Since
API level 20
MDM 5.7

public void setPortNumber (int portNumber)

Since: API level 17

Set the port number of the proxy.

This setter is used only when configuring a static proxy and cannot be used in conjunction with setPacFileUrl(String), otherwise calling setGlobalProxy(ProxyProperties) will fail.

Parameters
portNumber The port number to be set.
Since
API level 17
MDM 5.5