ProxyConfiguration.ProxyConfigurationBuilder (Licensespring Floating Client 2.24.0 API)

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

Enclosing class:: ProxyConfiguration

public static class ProxyConfiguration.ProxyConfigurationBuilder
extends Object

Builder for ProxyConfiguration.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ProxyConfiguration.ProxyConfigurationBuilder`	`addShutdownHook(boolean addShutdownHook)` Shutdown hooks are created for the registered user for specific product.
`ProxyConfiguration`	`build()` Builds the `ProxyConfiguration`.
`ProxyConfiguration.ProxyConfigurationBuilder`	`cacheHardwareID(boolean cacheHardwareID)`
`ProxyConfiguration.ProxyConfigurationBuilder`	`connectionSpecs(List<okhttp3.ConnectionSpec> connectionSpecs)`
`ProxyConfiguration.ProxyConfigurationBuilder`	`disableUserAuth(boolean disableUserAuth)`
`ProxyConfiguration.ProxyConfigurationBuilder`	`enablePeriodicCheck(boolean enablePeriodicCheck)` Enable periodic registration invocation.
`ProxyConfiguration.ProxyConfigurationBuilder`	`enablePeriodicRegister(boolean enablePeriodicRegister)` If true, this property enables periodic calls to register method to prolong the valid registration period.
`ProxyConfiguration.ProxyConfigurationBuilder`	`enableRetrying(boolean enableRetrying)`
`ProxyConfiguration.ProxyConfigurationBuilder`	`host(String host)`
`ProxyConfiguration.ProxyConfigurationBuilder`	`hostnameVerifier(HostnameVerifier hostnameVerifier)`
`ProxyConfiguration.ProxyConfigurationBuilder`	`identityProvider(com.licensespring.IdentityProvider identityProvider)` HardwareIdStrategy
`ProxyConfiguration.ProxyConfigurationBuilder`	`port(Integer port)`
`ProxyConfiguration.ProxyConfigurationBuilder`	`product(String product)`
`ProxyConfiguration.ProxyConfigurationBuilder`	`proxyCertPath(String proxyCertPath)`
`ProxyConfiguration.ProxyConfigurationBuilder`	`proxyHost(String proxyHost)`
`ProxyConfiguration.ProxyConfigurationBuilder`	`proxyPass(String proxyPass)`
`ProxyConfiguration.ProxyConfigurationBuilder`	`proxyPort(Integer proxyPort)`
`ProxyConfiguration.ProxyConfigurationBuilder`	`proxyRegisterSubscriber(ProxyRegisterSubscriber proxyRegisterSubscriber)` Add the CheckLicenseSubscriber implementation, which receives events on a background thread, which periodically call the registration API.
`ProxyConfiguration.ProxyConfigurationBuilder`	`proxyUser(String proxyUser)`
`ProxyConfiguration.ProxyConfigurationBuilder`	`requestLogging(feign.Logger.Level requestLogging)`
`ProxyConfiguration.ProxyConfigurationBuilder`	`requestTimeout(Long requestTimeout)`
`protected ProxyConfiguration.ProxyConfigurationBuilder`	`self()`
`String`	`toString()` Autogenerated toString containing all the fields.

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

- Method Detail
  - host
```
public ProxyConfiguration.ProxyConfigurationBuilder host(String host)
```
    Parameters:
    
    host - host address of the proxy server
    
    Returns:
    
    the proxy configuration builder
  - port
```
public ProxyConfiguration.ProxyConfigurationBuilder port(Integer port)
```
    Parameters:
    
    port - port of the proxy server
    
    Returns:
    
    the proxy configuration builder
  - product
```
public ProxyConfiguration.ProxyConfigurationBuilder product(String product)
```
    Parameters:
    
    product - Required parameter, every license is attached to a particular product. This short code can be found the LicenseSpring platform.
    
    Returns:
    
    the proxy configuration builder
  - addShutdownHook
```
public ProxyConfiguration.ProxyConfigurationBuilder addShutdownHook(boolean addShutdownHook)
```
    Shutdown hooks are created for the registered user for specific product. This behaviour is on by default. Set false to disable.
    
    Parameters:
    
    addShutdownHook - should the sdk add a shutdown hook for user unregistering.
    
    Returns:
    
    the proxy configuration builder
  - enablePeriodicCheck
```
public ProxyConfiguration.ProxyConfigurationBuilder enablePeriodicCheck(boolean enablePeriodicCheck)
```
    Enable periodic registration invocation. On by default.
    
    Parameters:
    
    enablePeriodicCheck - the enable periodic check
    
    Returns:
    
    the proxy configuration builder
  - enableRetrying
```
public ProxyConfiguration.ProxyConfigurationBuilder enableRetrying(boolean enableRetrying)
```
    Parameters:
    
    enableRetrying - Set if retrying API calls on failure is allowed.
    
    Returns:
    
    the proxy configuration builder
  - proxyRegisterSubscriber
```
public ProxyConfiguration.ProxyConfigurationBuilder proxyRegisterSubscriber(ProxyRegisterSubscriber proxyRegisterSubscriber)
```
    Add the CheckLicenseSubscriber implementation, which receives events on a background thread, which periodically call the registration API.
    
    Parameters:
    
    proxyRegisterSubscriber - the implementation handling check events.
    
    Returns:
    
    the proxy configuration builder
  - requestLogging
```
public ProxyConfiguration.ProxyConfigurationBuilder requestLogging(feign.Logger.Level requestLogging)
```
    Parameters:
    
    requestLogging - Request logging for debugging purposes. Default is NONE.
    
    Returns:
    
    the proxy configuration builder
  - cacheHardwareID
```
public ProxyConfiguration.ProxyConfigurationBuilder cacheHardwareID(boolean cacheHardwareID)
```
    Parameters:
    
    cacheHardwareID - Set true if you want to cache ID retrieving of hardware ID.
    
    Returns:
    
    the proxy configuration builder
  - identityProvider
```
public ProxyConfiguration.ProxyConfigurationBuilder identityProvider(com.licensespring.IdentityProvider identityProvider)
```
    HardwareIdStrategy
    
    Parameters:
    
    identityProvider - Set a custom IdentityProvider which generates unique keys for a particular device. For the Floating Client the default is an internal implementation is based on ONCE_PER_PROCESS id.
    
    Returns:
    
    the proxy configuration builder
  - proxyHost
```
public ProxyConfiguration.ProxyConfigurationBuilder proxyHost(String proxyHost)
```
    Parameters:
    
    proxyHost - Set the proxy host if using a proxy for api calls.
    
    Returns:
    
    Builder
  - proxyPort
```
public ProxyConfiguration.ProxyConfigurationBuilder proxyPort(Integer proxyPort)
```
    Parameters:
    
    proxyPort - Set the proxy port if using a proxy for api calls.
    
    Returns:
    
    Builder
  - proxyUser
```
public ProxyConfiguration.ProxyConfigurationBuilder proxyUser(String proxyUser)
```
    Parameters:
    
    proxyUser - Set the proxy username for Basic Auth
    
    Returns:
    
    Builder
  - proxyPass
```
public ProxyConfiguration.ProxyConfigurationBuilder proxyPass(String proxyPass)
```
    Parameters:
    
    proxyPass - Set the proxy password for Basic Auth
    
    Returns:
    
    Builder
  - proxyCertPath
```
public ProxyConfiguration.ProxyConfigurationBuilder proxyCertPath(String proxyCertPath)
```
    Parameters:
    
    proxyCertPath - used to configure client to trust proxy certificate. Path to .pem certificate file
    
    Returns:
    
    Builder
  - hostnameVerifier
```
public ProxyConfiguration.ProxyConfigurationBuilder hostnameVerifier(HostnameVerifier hostnameVerifier)
```
    Parameters:
    
    hostnameVerifier - used to confirm that response certificates apply to requested hostnames for HTTPS connections. If unset, a default hostname verifier will be used.
    
    Returns:
    
    Builder
  - requestTimeout
```
public ProxyConfiguration.ProxyConfigurationBuilder requestTimeout(Long requestTimeout)
```
    Parameters:
    
    requestTimeout - set the timeout for making api calls (in 10 seconds), default is 10 seconds
    
    Returns:
    
    Builder
  - connectionSpecs
```
public ProxyConfiguration.ProxyConfigurationBuilder connectionSpecs(List<okhttp3.ConnectionSpec> connectionSpecs)
```
    Parameters:
    
    connectionSpecs - configuration for the socket connection that HTTP traffic travels through.
    
    Returns:
    
    Builder
  - disableUserAuth
```
public ProxyConfiguration.ProxyConfigurationBuilder disableUserAuth(boolean disableUserAuth)
```
    Parameters:
    
    disableUserAuth - Disables user auth so users can register license without authentication.
    
    Returns:
    
    Builder
  - self
```
protected ProxyConfiguration.ProxyConfigurationBuilder self()
```
    Returns:
    
    reference to self
  - build
```
public ProxyConfiguration build()
```
    Builds the ProxyConfiguration.
    
    Returns:
    
    Proxy configuration
  - toString
```
public String toString()
```
    Autogenerated toString containing all the fields.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    string representation
  - enablePeriodicRegister
```
public ProxyConfiguration.ProxyConfigurationBuilder enablePeriodicRegister(boolean enablePeriodicRegister)
```
    If true, this property enables periodic calls to register method to prolong the valid registration period. Default is true.
    
    Returns:
    
    this.

Class ProxyConfiguration.ProxyConfigurationBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

host

port

product

addShutdownHook

enablePeriodicCheck

enableRetrying

proxyRegisterSubscriber

requestLogging

cacheHardwareID

identityProvider

proxyHost

proxyPort

proxyUser

proxyPass

proxyCertPath

hostnameVerifier

requestTimeout

connectionSpecs

disableUserAuth

self

build

toString

enablePeriodicRegister