com.licensespring

Class BaseConfiguration.ConfigurationBuilder<C extends BaseConfiguration,B extends BaseConfiguration.ConfigurationBuilder<C,B>>

java.lang.Object

com.licensespring.BaseConfiguration.ConfigurationBuilder<C,B>

Type Parameters:

C - subclass of BaseConfiguration

B - subclass of BaseConfiguration.ConfigurationBuilder

Enclosing class:

BaseConfiguration

public abstract static class BaseConfiguration.ConfigurationBuilder<C extends BaseConfiguration,B extends BaseConfiguration.ConfigurationBuilder<C,B>>
extends Object

Builder for BaseConfiguration.

Constructor Summary

Constructors

Constructor and Description
ConfigurationBuilder()

Method Summary

Modifier and Type	Method and Description
B	apiKey(String apiKey)
B	appName(String appName) Name of the application implementing the SDK.
B	appVersion(String appVersion) Version of the application implementing the SDK.
B	authURL(String authURL) Auth endpoint - the root for licensespring Auth API.
abstract C	build()
B	cacheHardwareID(boolean cacheHardwareID)
B	clientId(String clientId)
B	clientSecret(String clientSecret)
B	connectionSpecs(List<okhttp3.ConnectionSpec> connectionSpecs) Specifies configuration for the socket connection that HTTP traffic travels through.
B	disableSsl(boolean disableSsl)
B	enableNegativeConsumptions(boolean enableNegativeConsumptions)
B	enableRetrying(boolean enableRetrying)
Boolean	getCacheHardwareID() Is hardware caching enabled or not.
Boolean	getEnableRetrying()
IdentityProvider	getIdentityProvider()
B	hostnameVerifier(HostnameVerifier hostnameVerifier) Verifier used to confirm that response certificates apply to requested hostnames for HTTPS connections.
B	identityProvider(IdentityProvider identityProvider) HardwareIdStrategy
B	infoToStore(InfoToStore infoToStore)
B	productCode(String productCode)
B	proxyCertPath(String proxyCertPath)
B	proxyHost(String proxyHost)
B	proxyPass(String proxyPass)
B	proxyPort(Integer proxyPort)
B	proxyUser(String proxyUser)
B	requestLogging(feign.Logger.Level requestLogging)
B	requestTimeout(Long requestTimeout)
protected abstract B	self()
B	serviceURL(String serviceURL) Service endpoint - the root of the licensespring API.
B	serviceUrlCertPath(String serviceUrlCertPath)
B	sharedKey(String sharedKey) Required parameter, the api key can be found by accessing your account on the LicenseSpring platform.
B	sslConfig(SSLSocketFactory socketFactory, X509TrustManager trustManager)
B	sslConfig(SSLSocketFactory socketFactory, X509TrustManager trustManager, HostnameVerifier hostnameVerifier)
B	storeMachineInfo(boolean storeMachineInfo)
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

Constructor Detail

ConfigurationBuilder

public ConfigurationBuilder()

Method Detail

requestLogging

public B requestLogging(feign.Logger.Level requestLogging)

Parameters:

requestLogging - Request logging for debugging purposes. Default is NONE.

Returns:

Builder

serviceURL

public B serviceURL(String serviceURL)

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.

Parameters:

serviceURL - Server endpoint, do not change unless a private LicenseSpring server is deployed

Returns:

Builder

authURL

public B authURL(String authURL)

Auth endpoint - the root for licensespring Auth API. Used for OAuth

Parameters:

authURL - Auth endpoint

Returns:

Builder

apiKey

public B apiKey(String apiKey)

Parameters:

apiKey - Required parameter, you can find your API Key on the LicenseSpring platform.

Returns:

Builder

clientId

public B clientId(String clientId)

Parameters:

clientId - Client identifier for OAuth authentication.

Returns:

Builder

clientSecret

public B clientSecret(String clientSecret)

Parameters:

clientSecret - Client secret for OAuth authentication.

Returns:

Builder

productCode

public B productCode(String productCode)

Parameters:

productCode - Required parameter, every license is attached to a particular product. This short code can be found the LicenseSpring platform.

Returns:

Builder

sharedKey

public B sharedKey(String sharedKey)

Required parameter, the api key can be found by accessing your account on the LicenseSpring platform.

Parameters:

sharedKey - Required parameter, this shared key can be found on the LicenseSpring platform.

Returns:

Builder

appName

public B appName(String appName)

Name of the application implementing the SDK. Will be presented as such in the LicenseSpring platform.

Parameters:

appName - Name of the application (as to be seen in LS platform).

Returns:

Builder

appVersion

public B appVersion(String appVersion)

Version of the application implementing the SDK. Will be presented as such in the LicenseSpring platform.

Parameters:

appVersion - Manually set version of the application.

Returns:

Builder

identityProvider

public B identityProvider(IdentityProvider identityProvider)

HardwareIdStrategy

Parameters:

identityProvider - Set a custom IdentityProvider which generates unique keys for a particular device. For the License-Client the default is an internal implementation is based on Motherboard / CPU / Disk. On the licenseSpring

Returns:

Builder

cacheHardwareID

public B cacheHardwareID(boolean cacheHardwareID)

Parameters:

cacheHardwareID - Set true if you want to cache ID retrieving of hardware ID.

Returns:

Builder

enableNegativeConsumptions

public B enableNegativeConsumptions(boolean enableNegativeConsumptions)

Parameters:

enableNegativeConsumptions - Set if consumptions can be negative.

Returns:

Builder

enableRetrying

public B enableRetrying(boolean enableRetrying)

Parameters:

enableRetrying - Set if retrying API calls on failure is allowed.

Returns:

Builder

proxyHost

public B proxyHost(String proxyHost)

Parameters:

proxyHost - Set the proxy host if using a proxy for api calls.

Returns:

Builder

proxyPort

public B proxyPort(Integer proxyPort)

Parameters:

proxyPort - Set the proxy port if using a proxy for api calls.

Returns:

Builder

proxyUser

public B proxyUser(String proxyUser)

Parameters:

proxyUser - Set the proxy username for Basic Auth

Returns:

Builder

proxyPass

public B proxyPass(String proxyPass)

Parameters:

proxyPass - Set the proxy password for Basic Auth

Returns:

Builder

proxyCertPath

public B proxyCertPath(String proxyCertPath)

Parameters:

proxyCertPath - Path to proxy certificate (.pem) file that client trusts.

Returns:

Builder

hostnameVerifier

public B hostnameVerifier(HostnameVerifier hostnameVerifier)

Verifier used to confirm that response certificates apply to requested hostnames for HTTPS connections. If unset, a default hostname verifier will be used.

Parameters:

hostnameVerifier - hostname verifier

Returns:

Builder

disableSsl

public B disableSsl(boolean disableSsl)

Parameters:

disableSsl - set the checking of SSL connection with LS servers

Returns:

Builder

requestTimeout

public B requestTimeout(Long requestTimeout)

Parameters:

requestTimeout - set the timeout for making api calls (in 10 seconds), default is 10 seconds

Returns:

Builder

connectionSpecs

public B connectionSpecs(List<okhttp3.ConnectionSpec> connectionSpecs)

Specifies configuration for the socket connection that HTTP traffic travels through.

Parameters:

connectionSpecs - connection specs configuration

Returns:

Builder

storeMachineInfo

public B storeMachineInfo(boolean storeMachineInfo)

Parameters:

storeMachineInfo - set the sending of additional machine information to the LS servers, default is false

Returns:

Builder

infoToStore

public B infoToStore(InfoToStore infoToStore)

Parameters:

infoToStore - adds the information to be tracked on LS servers. No effect if storeMachineInfo is disabled

Returns:

Builder

sslConfig

public B sslConfig(SSLSocketFactory socketFactory,
                   X509TrustManager trustManager,
                   HostnameVerifier hostnameVerifier)

Parameters:

socketFactory - SSLSocketFactory for override ssl configuration used by the underlying client

trustManager - X509TrustManager for override ssl configuration used by the underlying client

hostnameVerifier - HostnameVerifier for override ssl configuration used by the underlying client

Returns:

Builder

sslConfig

public B sslConfig(SSLSocketFactory socketFactory,
                   X509TrustManager trustManager)

Parameters:

socketFactory - SSLSocketFactory for override ssl configuration used by the underlying client

trustManager - X509TrustManager for override ssl configuration used by the underlying client

Returns:

Builder

serviceUrlCertPath

public B serviceUrlCertPath(String serviceUrlCertPath)

Parameters:

serviceUrlCertPath - Path to a public key certificate file (.pem) used for license verification.

Returns:

Builder

getEnableRetrying

public Boolean getEnableRetrying()

getIdentityProvider

public IdentityProvider getIdentityProvider()

Returns:

Identity provider

getCacheHardwareID

public Boolean getCacheHardwareID()

Is hardware caching enabled or not.

Returns:

True or false

self

protected abstract B self()

Returns:

new instance of Builder.

build

public abstract C build()

Returns:

new instance of Configuration.

toString

public String toString()

Autogenerated toString containing all the fields.

Overrides:

toString in class Object

Returns:

string representation