Jump to Content

Class ProxySettings

ProxySettings (API Reference)

java.lang.Object
- com.here.sdk.core.engine.ProxySettings

```
public final class ProxySettings
extends java.lang.Object
```
Proxy configuration for the HERE SDK network that is applied per request. Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`ProxySettings.Credentials`	Authentication data
`static class`	`ProxySettings.ProxyType`	Supported types of proxy connection.

Field Summary

Fields
Modifier and Type	Field	Description
`ProxySettings.Credentials`	`credentials`	Optional field to define credentials to authenticate a user to the proxy server.
`java.net.InetAddress`	`ipAddress`	Represents the IP Address of the proxy server.
`java.lang.String`	`networkInterface`	Network interface.
`int`	`port`	Represents the port number of the proxy server.
`ProxySettings.ProxyType`	`type`	Represents the type of the proxy server.

Constructor Summary

Constructors
Constructor Description

ProxySettings(ProxySettings.ProxyType type, java.net.InetAddress ipAddress, int port)
Creates a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

boolean equals(java.lang.Object obj)

int hashCode()
- Methods inherited from class java.lang.Object
  clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - type
```
@NonNull
public ProxySettings.ProxyType type
```
    Represents the type of the proxy server.
  - ipAddress
```
@NonNull
public java.net.InetAddress ipAddress
```
    Represents the IP Address of the proxy server.
  - networkInterface
```
@Nullable
public java.lang.String networkInterface
```
    Network interface. It's taken into account when IPv6 is used. Default value is "wlan0". If not set then no interface is used.
  - port
```
public int port
```
    Represents the port number of the proxy server.
  - credentials
```
@Nullable
public ProxySettings.Credentials credentials
```
    Optional field to define credentials to authenticate a user to the proxy server.
- Constructor Detail
  - ProxySettings
```
public ProxySettings(@NonNull
                     ProxySettings.ProxyType type,
                     @NonNull
                     java.net.InetAddress ipAddress,
                     int port)
```
    Creates a new instance.
    
    Parameters:
    
    type -
    Represents the type of the proxy server.
    
    ipAddress -
    Represents the IP Address of the proxy server.
    
    port -
    Represents the port number of the proxy server.
- Method Detail
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object