ProxyConfiguration (Licensespring Floating Client 2.16.4 API)

java.lang.Object
- com.licensespring.floating.ProxyConfiguration

```
public final class ProxyConfiguration
extends Object
```
Offline Proxy Floating configuration object. This class contains all proxy configuration properties that are needed for initializing the ProxyFloatingService.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ProxyConfiguration.ProxyConfigurationBuilder
Builder for ProxyConfiguration.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ProxyConfiguration.ProxyConfigurationBuilder` Builder for ProxyConfiguration.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ProxyConfiguration.ProxyConfigurationBuilder`	`builder()` Use this builder to construct the ProxyConfiguration.
`boolean`	`equals(Object o)`
`String`	`getApiUrl()` Retrieves the URL of the proxy server.
`List<okhttp3.ConnectionSpec>`	`getConnectionSpecs()` Specifies configuration for the socket connection that HTTP traffic travels through.
`String`	`getHost()` Required parameter.
`HostnameVerifier`	`getHostnameVerifier()` Verifier used to confirm that response certificates apply to requested hostnames for HTTPS connections.
`com.licensespring.IdentityProvider`	`getIdentityProvider()` Set a custom IdentityProvider which generates unique keys for a particular device Default implementation is based on ONCE_PER_PROCESS id.
`int`	`getLicenseSpringAPIVersion()` LicenseSpring API version.
`Integer`	`getPort()` Required parameter.
`String`	`getProduct()` Required parameter, every license is attached to a particular product.
`String`	`getProxyCertPath()` Optional parameter, used to configure client to trust proxy certificate.
`String`	`getProxyHost()` Optional parameter, used to configure all API calls to use a proxy service.
`String`	`getProxyPass()` Optional parameter, used to configure Basic authentication for a proxy service.
`Integer`	`getProxyPort()` Optional parameter, used to configure all API calls to use a proxy service.
`ProxyRegisterSubscriber`	`getProxyRegisterSubscriber()` ProxyRegisterSubscriber is an interface that provides two methods (onSuccess and onError), it is used to monitor the response from the periodic registers.
`String`	`getProxyUser()` Optional parameter, used to configure Basic authentication for a proxy service.
`feign.Logger.Level`	`getRequestLogging()` HTTP Request/Response logging for debugging purposes.
`Long`	`getRequestTimeout()` Optional parameter for setting the timeout when making api requests (in seconds) default is 10 seconds
`int`	`hashCode()`
`boolean`	`isAddShutdownHook()` If true, this property adds a shutdown hook that will release currently active licenses before shutting down the runtime process.
`boolean`	`isCacheHardwareID()` Set true to allow caching of hardware IDs, otherwise the SDK directly invokes the `IdentityProvider.getKey()` every time the SDK needs the hardware id.
`boolean`	`isEnablePeriodicRegister()` If true, this property enables periodic calls to register method to prolong the valid registration period.
`boolean`	`isEnableRetrying()` Boolean value that allows or disables retrying on failed API call.
`String`	`toString()` Autogenerated toString containing all the fields.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - builder
```
public static ProxyConfiguration.ProxyConfigurationBuilder builder()
```
    Use this builder to construct the ProxyConfiguration.
    
    Returns:
    
    The builder for the offline floating proxy configuration
  - getApiUrl
```
public String getApiUrl()
```
    Retrieves the URL of the proxy server.
    
    Returns:
    
    Server URL
  - toString
```
public String toString()
```
    Autogenerated toString containing all the fields.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    string representation
  - getHost
```
public String getHost()
```
    Required parameter. Host of the proxy offline server.
    
    Returns:
    
    Host of the proxy offline server
  - getPort
```
public Integer getPort()
```
    Required parameter. The port of the proxy offline server.
    
    Returns:
    
    Port of the proxy offline server
  - getProduct
```
public String getProduct()
```
    Required parameter, every license is attached to a particular product. This short code can be found in the LicenseSpring platform or via the Management SDK.
    
    Returns:
    
    Product code
  - getLicenseSpringAPIVersion
```
public int getLicenseSpringAPIVersion()
```
    LicenseSpring API version. Do not change these.
    
    Returns:
    
    API version
  - isAddShutdownHook
```
public boolean isAddShutdownHook()
```
    If true, this property adds a shutdown hook that will release currently active licenses before shutting down the runtime process. Default is true.
    
    Returns:
    
    True or false
  - isEnablePeriodicRegister
```
public boolean isEnablePeriodicRegister()
```
    If true, this property enables periodic calls to register method to prolong the valid registration period. Default is true.
    
    Returns:
    
    True or false
  - getProxyRegisterSubscriber
```
public ProxyRegisterSubscriber getProxyRegisterSubscriber()
```
    ProxyRegisterSubscriber is an interface that provides two methods (onSuccess and onError), it is used to monitor the response from the periodic registers. You can implement it, and add the implementation as a property. Default implementation ignores register user events.
  - getRequestLogging
```
public feign.Logger.Level getRequestLogging()
```
    HTTP Request/Response logging for debugging purposes. Default is NONE.
    
    Returns:
    
    Request logging level
  - isEnableRetrying
```
public boolean isEnableRetrying()
```
    Boolean value that allows or disables retrying on failed API call. If this feature is enabled then API call will be repeated up to 4 times with each following call 1.5 times longer than the previous one. Starting value of retrying is 5 seconds, then the following one is 7.5 seconds, then 11.25 seconds and so on. If this feature is disabled and if API call fails ConnectionException will be thrown.
  - getIdentityProvider
```
public com.licensespring.IdentityProvider getIdentityProvider()
```
    Set a custom IdentityProvider which generates unique keys for a particular device Default implementation is based on ONCE_PER_PROCESS id.
    
    Returns:
    
    Identity provider
  - isCacheHardwareID
```
public boolean isCacheHardwareID()
```
    Set true to allow caching of hardware IDs, otherwise the SDK directly invokes the IdentityProvider.getKey() every time the SDK needs the hardware id.
    
    Returns:
    
    True or false
  - getProxyHost
```
public String getProxyHost()
```
    Optional parameter, used to configure all API calls to use a proxy service. If only port is specified, localhost will be used (127.0.0.1)
    
    Returns:
    
    Proxy port
  - getProxyPort
```
public Integer getProxyPort()
```
    Optional parameter, used to configure all API calls to use a proxy service. Needed for proxy setup (host is optional)
    
    Returns:
    
    Proxy port
  - getProxyUser
```
public String getProxyUser()
```
    Optional parameter, used to configure Basic authentication for a proxy service.
    
    Returns:
    
    Proxy Authentication Username
  - getProxyPass
```
public String getProxyPass()
```
    Optional parameter, used to configure Basic authentication for a proxy service.
    
    Returns:
    
    Proxy Authentication Password
  - getProxyCertPath
```
public String getProxyCertPath()
```
    Optional parameter, used to configure client to trust proxy certificate. Path to .pem certificate file
  - getHostnameVerifier
```
public HostnameVerifier getHostnameVerifier()
```
    Verifier used to confirm that response certificates apply to requested hostnames for HTTPS connections. If unset, a default hostname verifier will be used.
  - getRequestTimeout
```
public Long getRequestTimeout()
```
    Optional parameter for setting the timeout when making api requests (in seconds) default is 10 seconds
    
    Returns:
    
    request timeout for api calls
  - getConnectionSpecs
```
public List<okhttp3.ConnectionSpec> getConnectionSpecs()
```
    Specifies configuration for the socket connection that HTTP traffic travels through.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class ProxyConfiguration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

builder

getApiUrl

toString

getHost

getPort

getProduct

getLicenseSpringAPIVersion

isAddShutdownHook

isEnablePeriodicRegister

getProxyRegisterSubscriber

getRequestLogging

isEnableRetrying

getIdentityProvider

isCacheHardwareID

getProxyHost

getProxyPort

getProxyUser

getProxyPass

getProxyCertPath

getHostnameVerifier

getRequestTimeout

getConnectionSpecs

equals

hashCode