com.licensespring.management

Class ManagementConfiguration.ManagementConfigurationBuilder

java.lang.Object

com.licensespring.management.ManagementConfiguration.ManagementConfigurationBuilder

Enclosing class:

ManagementConfiguration

public static class ManagementConfiguration.ManagementConfigurationBuilder
extends Object

The Management SDK configuration builder.

Method Summary

Modifier and Type	Method and Description
ManagementConfiguration	build()
ManagementConfiguration.ManagementConfigurationBuilder	connectionSpecs(List<okhttp3.ConnectionSpec> connectionSpecs) Specifies configuration for the socket connection that HTTP traffic travels through.
ManagementConfiguration.ManagementConfigurationBuilder	disableSsl(boolean disableSsl) Deprecated. Optional parameter, disables ssl checking (for the LicenseSpring servers) default is false
ManagementConfiguration.ManagementConfigurationBuilder	enableRetrying(boolean enableRetrying) Boolean value that allows or disables retrying on failed API call.
ManagementConfiguration.ManagementConfigurationBuilder	hostnameVerifier(HostnameVerifier hostnameVerifier) Verifier used to confirm that response certificates apply to requested hostnames for HTTPS connections.
ManagementConfiguration.ManagementConfigurationBuilder	managementKey(String managementKey) Required parameter, management Key needed to pass requests to Management API.
ManagementConfiguration.ManagementConfigurationBuilder	managementURL(String managementURL) Server endpoint, do not change unless a private LicenseSpring server is deployed.
ManagementConfiguration.ManagementConfigurationBuilder	proxyCertPath(String proxyCertPath) Optional parameter, proxyCertPath path to proxy certificate that client trusts.
ManagementConfiguration.ManagementConfigurationBuilder	proxyHost(String proxyHost) Optional parameter, used to configure all API calls to use a proxy service.
ManagementConfiguration.ManagementConfigurationBuilder	proxyPass(String proxyPass) Optional parameter, used to configure Basic authentication for a proxy service.
ManagementConfiguration.ManagementConfigurationBuilder	proxyPort(Integer proxyPort) Optional parameter, used to configure all API calls to use a proxy service.
ManagementConfiguration.ManagementConfigurationBuilder	proxyUser(String proxyUser) Optional parameter, used to configure Basic authentication for a proxy service.
ManagementConfiguration.ManagementConfigurationBuilder	requestLogging(feign.Logger.Level requestLogging) Adjust logging level of http requests made.
ManagementConfiguration.ManagementConfigurationBuilder	requestTimeout(Long requestTimeout) Optional parameter for setting the timeout when making api requests (in seconds) default is 10 seconds
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

managementURL

public ManagementConfiguration.ManagementConfigurationBuilder managementURL(String managementURL)

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

Returns:

this.

managementKey

public ManagementConfiguration.ManagementConfigurationBuilder managementKey(String managementKey)

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

Returns:

this.

requestLogging

public ManagementConfiguration.ManagementConfigurationBuilder requestLogging(feign.Logger.Level requestLogging)

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

Returns:

this.

enableRetrying

public ManagementConfiguration.ManagementConfigurationBuilder enableRetrying(boolean enableRetrying)

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.

Returns:

this.

proxyHost

public ManagementConfiguration.ManagementConfigurationBuilder proxyHost(String proxyHost)

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:

this.

proxyPort

public ManagementConfiguration.ManagementConfigurationBuilder proxyPort(Integer proxyPort)

Optional parameter, used to configure all API calls to use a proxy service. Needed for proxy setup (host is optional)

Returns:

this.

proxyUser

public ManagementConfiguration.ManagementConfigurationBuilder proxyUser(String proxyUser)

Optional parameter, used to configure Basic authentication for a proxy service.

Returns:

this.

proxyPass

public ManagementConfiguration.ManagementConfigurationBuilder proxyPass(String proxyPass)

Optional parameter, used to configure Basic authentication for a proxy service.

Returns:

this.

proxyCertPath

public ManagementConfiguration.ManagementConfigurationBuilder proxyCertPath(String proxyCertPath)

Optional parameter, proxyCertPath path to proxy certificate that client trusts.

Returns:

this.

hostnameVerifier

public ManagementConfiguration.ManagementConfigurationBuilder 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.

Returns:

this.

disableSsl

@Deprecated
public ManagementConfiguration.ManagementConfigurationBuilder disableSsl(boolean disableSsl)

Deprecated. Optional parameter, disables ssl checking (for the LicenseSpring servers) default is false

Returns:

this.

requestTimeout

public ManagementConfiguration.ManagementConfigurationBuilder requestTimeout(Long requestTimeout)

Optional parameter for setting the timeout when making api requests (in seconds) default is 10 seconds

Returns:

this.

connectionSpecs

public ManagementConfiguration.ManagementConfigurationBuilder connectionSpecs(List<okhttp3.ConnectionSpec> connectionSpecs)

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

Returns:

this.

build

public ManagementConfiguration build()

toString

public String toString()

Overrides:

toString in class Object