com.licensespring.management

Class ManagementConfiguration

java.lang.Object

com.licensespring.management.ManagementConfiguration

public final class ManagementConfiguration
extends Object

Management configuration class used for defining management properties. Used for initializing two management service classes: LicenseService, OrderService.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ManagementConfiguration.ManagementConfigurationBuilder The Management SDK configuration builder.

Method Summary

Modifier and Type	Method and Description
static ManagementConfiguration.ManagementConfigurationBuilder	builder() Use this builder to construct ManagementConfiguration.
boolean	equals(Object o)
String	getApiUrl() Returns base Management API URL.
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.
int	getManagementAPIVersion() Api version, do not change.
String	getManagementKey() Required parameter, management Key needed to pass requests to Management API.
String	getManagementURL() Server endpoint, do not change unless a private LicenseSpring server is deployed.
String	getProxyCertPath() Optional parameter, proxyCertPath path to proxy certificate that client trusts.
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() Adjust logging level of http requests made.
Long	getRequestTimeout() Optional parameter for setting the timeout when making api requests (in seconds) default is 10 seconds
int	hashCode()
boolean	isDisableSsl() Deprecated. Optional parameter, disables ssl checking (for the LicenseSpring servers) default is false
boolean	isEnableRetrying() Boolean value that allows or disables retrying on failed API call.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

builder

public static ManagementConfiguration.ManagementConfigurationBuilder builder()

Use this builder to construct ManagementConfiguration.

Returns:

The builder for the management SDK configuration

getApiUrl

public String getApiUrl()

Returns base Management API URL.

getManagementAPIVersion

public int getManagementAPIVersion()

Api version, do not change.

getManagementURL

public String getManagementURL()

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

getManagementKey

public String getManagementKey()

Required parameter, management Key needed to pass requests to Management API. Can be found in LicenseSpring platform.

getRequestLogging

public feign.Logger.Level getRequestLogging()

Adjust logging level of http requests made. Default is NONE.

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.

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, proxyCertPath path to proxy certificate that client trusts.

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

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

toString

public String toString()

Overrides:

toString in class Object