BaseConfiguration (Licensespring Core 2.20.1 API)

java.lang.Object
- com.licensespring.BaseConfiguration

```
public abstract class BaseConfiguration
extends Object
```
Base configuration class - immutable - can be built using the inner Builder class. Note that this class is shared by Floating and Client SDK implementations.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`BaseConfiguration.ConfigurationBuilder<C extends BaseConfiguration,B extends BaseConfiguration.ConfigurationBuilder<C,B>>` Builder for `BaseConfiguration`.

Constructor Summary

Constructors
Modifier Constructor and Description

protected BaseConfiguration(BaseConfiguration.ConfigurationBuilder<?,?> b)

Constructors
Modifier	Constructor and Description
`protected`	`BaseConfiguration(BaseConfiguration.ConfigurationBuilder<?,?> b)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected boolean`	`canEqual(Object other)`
`boolean`	`equals(Object o)`
`String`	`getApiKey()` Required parameter, the api key can be found by accessing your account on the LicenseSpring platform.
`String`	`getApiUrl()` Returns base URL of LicenseSpring API.
`String`	`getAppName()` Name of the application implementing the SDK.
`String`	`getAppVersion()` Version of the application implementing the SDK.
`String`	`getAuthURL()` Auth endpoint - the root for licensespring Auth API.
`String`	`getClientId()` Client identifier for OAuth authentication.
`String`	`getClientSecret()` Client secret for OAuth authentication.
`List<okhttp3.ConnectionSpec>`	`getConnectionSpecs()` Specifies configuration for the socket connection that HTTP traffic travels through.
`HostnameVerifier`	`getHostnameVerifier()` Verifier used to confirm that response certificates apply to requested hostnames for HTTPS connections.
`IdentityProvider`	`getIdentityProvider()` Set a custom IdentityProvider which generates unique keys for a particular device Default implementation is based on Motherboard / CPU / Disk
`Set<InfoToStore>`	`getInfoToStore()` Collection of what information to track.
`int`	`getLicenseSpringAPIVersion()` LicenseSpring API version.
`String`	`getProductCode()` 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.
`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
`String`	`getSdkVersion()` SDK version.
`String`	`getServiceURL()` Service endpoint - the root of the licensespring API.
`String`	`getServiceUrlCertPath()` Optional parameter, path to a public key certificate file (.pem) used for license verification.
`String`	`getSharedKey()` Required parameter, the shared key can be found by accessing your account on the LicenseSpring platform.
`com.licensespring.internal.config.SslConfig`	`getSslConfig()` Custom SSL Configuration to override the ones used by the underlying http client
`int`	`hashCode()`
`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`	`isDisableSsl()` Deprecated. Optional parameter, disables ssl checking (for the LicenseSpring servers) default is false
`boolean`	`isEnableNegativeConsumptions()` Deprecated. this configuration param is ignored. You must check "Allow negative consumptions" when creating order in LicenseSpring portal
`boolean`	`isEnableRetrying()` Boolean value that allows or disables retrying on failed API call.
`boolean`	`isOAuth()` Returns true if configuration uses OAuth, false otherwise.
`boolean`	`isStoreMachineInfo()` Optional parameter, enables tracking of machine specific information on license activation and check.
`String`	`toString()`

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

- Constructor Detail
  - BaseConfiguration
```
protected BaseConfiguration(BaseConfiguration.ConfigurationBuilder<?,?> b)
```
- Method Detail
  - getApiUrl
```
public String getApiUrl()
```
    Returns base URL of LicenseSpring API.
    
    Returns:
    
    Base API URL
  - isOAuth
```
public boolean isOAuth()
```
    Returns true if configuration uses OAuth, false otherwise.
    
    Returns:
    
    true or false
  - getSdkVersion
```
public String getSdkVersion()
```
    SDK version. Override only if building a custom SDK.
    
    Returns:
    
    SDK version
  - getLicenseSpringAPIVersion
```
public int getLicenseSpringAPIVersion()
```
    LicenseSpring API version. Do not change these.
    
    Returns:
    
    API version
  - getRequestLogging
```
public feign.Logger.Level getRequestLogging()
```
    HTTP Request/Response logging for debugging purposes. Default is NONE.
    
    Returns:
    
    Request logging level
  - getServiceURL
```
public String getServiceURL()
```
    Service endpoint - the root of the licensespring API. Note that mechanisms for server change exist, the SDK will not accept licenses generated by non-licensespring servers - as all the requests are signed and verified on the SDK side.
    
    Returns:
    
    Service URL
  - getAuthURL
```
public String getAuthURL()
```
    Auth endpoint - the root for licensespring Auth API. Used for OAuth
    
    Returns:
    
    Auth URL
  - getApiKey
```
public String getApiKey()
```
    Required parameter, the api key can be found by accessing your account on the LicenseSpring platform.
    
    Returns:
    
    API key
  - getClientId
```
public String getClientId()
```
    Client identifier for OAuth authentication.
    
    Returns:
    
    Client ID
  - getClientSecret
```
public String getClientSecret()
```
    Client secret for OAuth authentication.
    
    Returns:
    
    Client Secret
  - getProductCode
```
public String getProductCode()
```
    Required parameter, every license is attached to a particular product. The Java Client SDK supports only one product and license per runtime. The floating SDK implementation can have multiple products and licenses within the runtime. This short code can be found in the LicenseSpring platform or via the Management SDK.
    
    Returns:
    
    Product code
  - getSharedKey
```
public String getSharedKey()
```
    Required parameter, the shared key can be found by accessing your account on the LicenseSpring platform.
    
    Returns:
    
    Shared key
  - getAppName
```
public String getAppName()
```
    Name of the application implementing the SDK. Will be presented as such in the LicenseSpring platform.
    
    Returns:
    
    App name
  - getAppVersion
```
public String getAppVersion()
```
    Version of the application implementing the SDK. Will be presented as such in the LicenseSpring platform.
    
    Returns:
    
    App version
  - getIdentityProvider
```
public IdentityProvider getIdentityProvider()
```
    Set a custom IdentityProvider which generates unique keys for a particular device Default implementation is based on Motherboard / CPU / Disk
    
    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
  - isEnableNegativeConsumptions
```
@Deprecated
public boolean isEnableNegativeConsumptions()
```
    Deprecated. this configuration param is ignored. You must check "Allow negative consumptions" when creating order in LicenseSpring portal
  - 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 then if API call fails ConnectionException will be thrown.
  - 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.
  - isDisableSsl
```
@Deprecated
public boolean isDisableSsl()
```
    Deprecated. Optional parameter, disables ssl checking (for the LicenseSpring servers) default is false
  - 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
  - isStoreMachineInfo
```
public boolean isStoreMachineInfo()
```
    Optional parameter, enables tracking of machine specific information on license activation and check. The additional information is: hostname, ipAddress, macAddress, vmInfo, osInfo
    default is false
    
    Returns:
    
    true or false if storing of additional info is activated
  - getInfoToStore
```
public Set<InfoToStore> getInfoToStore()
```
    Collection of what information to track.
    If storeMachineInfo is disabled, this is ignored.
    If storeMachineInfo is enabled and this is an empty collection, all info will be stored
    See available info InfoToStore
    defaults to ALL information.
    
    Returns:
    
    collection of what information to store
  - getSslConfig
```
public com.licensespring.internal.config.SslConfig getSslConfig()
```
    Custom SSL Configuration to override the ones used by the underlying http client
    contains: * SSLSocketFactory for override ssl configuration used by the underlying client * X509TrustManager for override ssl configuration used by the underlying client * HostnameVerifier for override ssl configuration used by the underlying client
    
    Returns:
    
    SSL Custom Configuration
  - getConnectionSpecs
```
public List<okhttp3.ConnectionSpec> getConnectionSpecs()
```
    Specifies configuration for the socket connection that HTTP traffic travels through.
  - getServiceUrlCertPath
```
public String getServiceUrlCertPath()
```
    Optional parameter, path to a public key certificate file (.pem) used for license verification.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - canEqual
```
protected boolean canEqual(Object other)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class BaseConfiguration

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BaseConfiguration

Method Detail

getApiUrl

isOAuth

getSdkVersion

getLicenseSpringAPIVersion

getRequestLogging

getServiceURL

getAuthURL

getApiKey

getClientId

getClientSecret

getProductCode

getSharedKey

getAppName

getAppVersion

getIdentityProvider

isCacheHardwareID

isEnableNegativeConsumptions

isEnableRetrying

getProxyHost

getProxyPort

getProxyUser

getProxyPass

getProxyCertPath

getHostnameVerifier

isDisableSsl

getRequestTimeout

isStoreMachineInfo

getInfoToStore

getSslConfig

getConnectionSpecs

getServiceUrlCertPath

equals

canEqual

hashCode

toString